DOCTEAM-1338:Setting up a systemd service-article #315

Amrita42 · 2024-03-22T06:24:47Z

Description

The scope of this PR is to cover the scope of "Setting up a systemd service" as defined in https://jira.suse.com/browse/DOCTEAM-1338

Reviewers
Please dont review now , will tag in slack when ready.

Reused (Review not required as this topics have been reviewed and are being re-used multiple times)

What is systemd?
Structure of a unit file
Unit file types
Unit dependencies and order

Review required

Creating a Linux service with systemd
Editing a systemd unit file
Debugging a systemd service

Amrita42 · 2024-07-29T07:36:46Z

setting-up-systemd_en.pdf

taroth21

@Amrita42 : Many thanks, well done! Sorry for the large number of comments and suggestions but the majority of them is about updating the metadata and adjusting some structures to the latest template updates (I provide those as suggestions).

taroth21 · 2024-11-18T10:47:00Z

DC-systemd-setting-up-service

+PROFCONDITION="suse-product"
+PROFOS="generic"
+#PROFCONDITION="suse-product;beta"
+#PROFCONDITION="community-project"
+
+STYLEROOT="/usr/share/xml/docbook/stylesheet/suse2022-ns"
+FALLBACK_STYLEROOT="/usr/share/xml/docbook/stylesheet/suse-ns"


Suggested change

PROFCONDITION="suse-product"

PROFOS="generic"

#PROFCONDITION="suse-product;beta"

#PROFCONDITION="community-project"

STYLEROOT="/usr/share/xml/docbook/stylesheet/suse2022-ns"

FALLBACK_STYLEROOT="/usr/share/xml/docbook/stylesheet/suse-ns"

## Profiling

PROFOS="PRODUCT"

#PROFCONDITION="PRODUCTNUMBER"

#STRUCTID="STRUCTURE-ID"

#PROFARCH="x86_64;zseries;power;aarch64"

DOCBOOK5_RNG_URI="urn:x-suse:rng:v2:geekodoc-flat"

STYLEROOT="/usr/share/xml/docbook/stylesheet/suse2022-ns"

FALLBACK_STYLEROOT="/usr/share/xml/docbook/stylesheet/suse-ns"

Updating to latest template

taroth21 · 2024-11-18T10:49:38Z

articles/systemd-setting-up-service.asm.xml

+    <merge>
+      <title>Setting up a &systemd; service</title>
+      <revhistory xml:id="rh-setting-up-systemd">
+        <revision><date>2024-03-20</date>


Suggested change

<revision><date>2024-03-20</date>

<revision><date>2024-11-27</date>

taroth21 · 2024-11-18T10:50:01Z

articles/systemd-setting-up-service.asm.xml

+        <revision><date>2024-03-20</date>
+          <revdescription>
+            <para>
+              Initial version.


Suggested change

Initial version.

Initial version

Without full stop as per example in the style guide, see https://documentation.suse.com/style/current/html/docu_styleguide/sec-smartdocs.html#sec-revhistory

taroth21 · 2024-11-18T10:58:37Z

articles/systemd-setting-up-service.asm.xml

+        <phrase>&power;</phrase>
+      </meta>
+      <meta name="productname" its:translate="no">
+        <!-- enter product name and version --><productname version="15-SP5">&sles;</productname>


Suggested change

<productname version="15-SP5">&sles;</productname>

<productname version="15 SP6">&sles;</productname>

taroth21 · 2024-11-18T10:59:04Z

articles/systemd-setting-up-service.asm.xml

+      <dm:docmanager xmlns:dm="urn:x-suse:ns:docmanager">
+        <dm:bugtracker>
+          <dm:url>https://bugzilla.suse.com/enter_bug.cgi</dm:url>
+          <dm:component>Smart Docs</dm:component>
+          <dm:product>Documentation</dm:product>
+          <dm:assignee>[email protected]</dm:assignee>
+        </dm:bugtracker>
+        <dm:translation>yes</dm:translation>
+      </dm:docmanager>


Suggested change

<dm:docmanager xmlns:dm="urn:x-suse:ns:docmanager">

<dm:bugtracker>

<dm:url>https://bugzilla.suse.com/enter_bug.cgi</dm:url>

<dm:component>Smart Docs</dm:component>

<dm:product>Documentation</dm:product>

<dm:assignee>[email protected]</dm:assignee>

</dm:bugtracker>

<dm:translation>yes</dm:translation>

</dm:docmanager>

<dm:docmanager xmlns:dm="urn:x-suse:ns:docmanager">

<dm:bugtracker>

<dm:url>https://bugzilla.suse.com/enter_bug.cgi</dm:url>

<dm:product>SUSE Linux Enterprise Server 16.0</dm:product>

<dm:component>Documentation</dm:component>

<dm:assignee>[email protected]</dm:assignee>

</dm:bugtracker>

<dm:translation>yes</dm:translation>

</dm:docmanager>

Using the latest template for Bugzilla pointers (see https://github.com/openSUSE/doc-kit/blob/main/smart-doc/articles/assembly.asm.xml#L111 for reference)

taroth21 · 2024-11-18T11:05:28Z

references/systemd-editing-unit-file.xml

+      </listitem>
+    </varlistentry>
+  </variablelist>
+  <para>The <command>sysctemctl edit </command> command by default opens a unit file snippet, for example:</para>


Suggested change

<para>The <command>sysctemctl edit </command> command by default opens a unit file snippet, for example:</para>

<para>The <command>systemctl edit </command> command by default opens a unit file snippet, for example:</para>

taroth21 · 2024-11-18T11:20:10Z

references/systemd-editing-unit-file.xml

+ xmlns:xi="http://www.w3.org/2001/XInclude"
+ xmlns:xlink="http://www.w3.org/1999/xlink"
+ xmlns:trans="http://docbook.org/ns/transclusion">
+  <info>


Content-wise, most of this file is indeed a reference (even if it includes some instructions, which means that the reference purpose is mixed up a bit). However, the title suggests otherwise - as a reader, under the headline 'Editing foo bar' I would have expected tasks and step-by-step procedures.

I leave it up to you how to handle that. From my perspective, you could:

Rewrite the topic to a task (and keep the title). In that case you could probably split the topic up into the following procedures

Adding directives and overriding files

Customizing existing unit files completely

Removing custom changes to unit file

Keep the topic as a reference but adjust the title so if reflects what to expect (maybe rephrase to something like 'The sysctemctl edit command')

taroth21 · 2024-11-18T11:21:15Z

references/systemd-editing-unit-file.xml

+      <term><filename>/usr/lib/systemd/system/</filename></term>
+      <listitem>
+        <para>
+          When the package is installed, &systemd; unit files reside here.


the package? which one? the systemd package?

taroth21 · 2024-11-18T11:24:00Z

references/systemd-editing-unit-file.xml

+    </abstract>
+  </info>
+  <para>There are three main directories where unit files are stored on the system: </para>
+  <variablelist>


Maybe already mention here which directory takes precedence in case two 'versions' of one file exist.

taroth21 · 2024-11-18T14:26:19Z

references/systemd-debug-failed-service.xml

+<screen>&prompt.root;<command>systemctl</command> start apache2
+Job for apache2.service failed because the control process exited with error code.
+See "systemctl status apache2.service" and "journalctl -xe" for details.</screen>
+        <itemizedlist>


Maybe it's a personal preference of mine, but I would use a variabelist here (instead of an itemizedlist with listitems). That way, you could highlight the 'goal' for each debug action in the variablelist title (you could mostly use as titles what you now have as first para of each listitem). That makes it easier for the readers to skim through the titles to find the debug action they are interested in.

assembly and dc file

da9ff99

Amrita42 changed the title ~~DOCTEAM-1338: assembly and dc file~~ [WIP]DOCTEAM-1338: assembly and dc file Mar 22, 2024

filling up the strcuture

a0e7a66

Amrita42 changed the title ~~[WIP]DOCTEAM-1338: assembly and dc file~~ [WIP]DOCTEAM-1338:Setting up a systemd service Mar 28, 2024

Amrita42 added WIP Work in progress. Do not merge! smartdocs labels Mar 28, 2024

Amrita42 changed the title ~~[WIP]DOCTEAM-1338:Setting up a systemd service~~ [WIP]DOCTEAM-1338:Setting up a systemd service-article Mar 28, 2024

Amrita42 self-assigned this Apr 4, 2024

Amrita42 added 10 commits April 4, 2024 17:28

task to ref topic

64da02c

undo prev

b0da241

debugging

a066985

adds steps

ff3fa35

adds modules to asm file and a new task topic

657ea12

validation issues

1af79fd

adds task topic

df49fac

adds a ref file

c39b1b3

renames the file and adds content

cf4af60

adds the concept dependecies

571a0c2

Amrita42 requested review from taroth21 and fsundermeyer July 26, 2024 07:20

converts debugg task to ref

6ed408c

changes

d1c8d87

Amrita42 changed the title ~~[WIP]DOCTEAM-1338:Setting up a systemd service-article~~ DOCTEAM-1338:Setting up a systemd service-article Oct 30, 2024

taroth21 requested changes Nov 18, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

DOCTEAM-1338:Setting up a systemd service-article #315

DOCTEAM-1338:Setting up a systemd service-article #315

Amrita42 commented Mar 22, 2024 •

edited

Loading

Amrita42 commented Jul 29, 2024

taroth21 left a comment •

edited

Loading

taroth21 Nov 18, 2024

taroth21 Nov 18, 2024

taroth21 Nov 18, 2024

taroth21 Nov 18, 2024

taroth21 Nov 18, 2024

taroth21 Nov 18, 2024

taroth21 Nov 18, 2024

taroth21 Nov 18, 2024

taroth21 Nov 18, 2024

taroth21 Nov 18, 2024 •

edited

Loading

taroth21 Nov 18, 2024

taroth21 Nov 18, 2024

taroth21 Nov 18, 2024

	<revision><date>2024-03-20</date>
	<revision><date>2024-11-27</date>

	<!-- enter product name and version --><productname version="15-SP5">&sles;</productname>
	<!-- enter product name and version --><productname version="15 SP6">&sles;</productname>

	<para>The <command>sysctemctl edit </command> command by default opens a unit file snippet, for example:</para>
	<para>The <command>systemctl edit </command> command by default opens a unit file snippet, for example:</para>

DOCTEAM-1338:Setting up a systemd service-article #315

Are you sure you want to change the base?

DOCTEAM-1338:Setting up a systemd service-article #315

Conversation

Amrita42 commented Mar 22, 2024 • edited Loading

Description

Amrita42 commented Jul 29, 2024

taroth21 left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

taroth21 Nov 18, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Amrita42 commented Mar 22, 2024 •

edited

Loading

taroth21 left a comment •

edited

Loading

taroth21 Nov 18, 2024 •

edited

Loading