From 04b612975287fc969ab8396e2f0dcb1ff145e4dd Mon Sep 17 00:00:00 2001 From: Ole Herman Schumacher Elgesem Date: Mon, 15 Jan 2024 18:51:49 +0100 Subject: [PATCH] Fixed remaining markdowner.py warnings Signed-off-by: Ole Herman Schumacher Elgesem --- reference/promise-types/services.markdown | 39 ++++++------------- .../faq/what-did-cfengine-change.markdown | 23 +++++------ web-ui/federated-reporting.markdown | 2 +- 3 files changed, 25 insertions(+), 39 deletions(-) diff --git a/reference/promise-types/services.markdown b/reference/promise-types/services.markdown index 3c251af9b..44510e7a1 100644 --- a/reference/promise-types/services.markdown +++ b/reference/promise-types/services.markdown @@ -57,10 +57,9 @@ body service_method winmethod **Notes:** -Services promises for Windows are only available in CFEngine Enterprise. Note -that the name of a service in Windows may be different from its ```Display -name```. CFEngine Enterprise policies use the name, not the display name, -due to the need for uniqueness. +Services promises for Windows are only available in CFEngine Enterprise. +Note that the name of a service in Windows may be different from its **Display name**. +CFEngine Enterprise policies use the name, not the display name, due to the need for uniqueness. ![WinService](promise-types-services-winservice-properties_name.png) @@ -155,29 +154,15 @@ standard library. **Allowed input range:** (arbitrary string)|(menu_option) depending on `service_type` -* When `service_type` is `windows` allowed values are limited to `start`, - `stop`, `enable`, or `disable`. - - * **start|enable** :: Will start the service if it is not running. ```Startup - Type``` will be set to ```Manual``` if it is not ```Automatic``` or - ```Automatic (Delayed Start)```. For a service to be configured to start - automatically on boot a `service_method` must be declared and - `service_autostart_policy` must be set to ```boot_time```. - - * **stop** :: Will stop the service if it is running. ```Startup Type``` will - not be modified unless a `service_method` is declared and - `service_autostart_policy` is set. - - * **disable** :: Will stop the service if it is running, and ```Startup Type``` - will be set to ```Disabled```. - - -* When `service_type` is ```generic``` any string is allowed and - `service_bundle` is responsible for interpreting and implementing the desired - state based on the `service_policy` value. - - Historically `service_type` ```generic``` has supported ```start```, - ```stop```, ```enable```, ```disable```, ```restart``` and ```reload```. +* When `service_type` is `windows` allowed values are limited to `start`, `stop`, `enable`, or `disable`. + * **start|enable** :: Will start the service if it is not running. + **Startup Type** will be set to **Manual** if it is not **Automatic** or **Automatic (Delayed Start)**. + For a service to be configured to start automatically on boot a `service_method` must be declared and `service_autostart_policy` must be set to `boot_time`. + * **stop** :: Will stop the service if it is running. **Startup Type** will not be modified unless a `service_method` is declared and `service_autostart_policy` is set. + * **disable** :: Will stop the service if it is running, and **Startup Type** + will be set to **Disabled**. +* When `service_type` is `generic` any string is allowed and `service_bundle` is responsible for interpreting and implementing the desired state based on the `service_policy` value. + Historically `service_type` `generic` has supported `start`, `stop`, `enable`, `disable`, `restart` and `reload`. **Example:** diff --git a/resources/faq/what-did-cfengine-change.markdown b/resources/faq/what-did-cfengine-change.markdown index 3c486b31b..0dd0d81e4 100644 --- a/resources/faq/what-did-cfengine-change.markdown +++ b/resources/faq/what-did-cfengine-change.markdown @@ -31,19 +31,20 @@ bundle edit_line lines_present(lines) # @brief Ensure `lines` are present in the file. Lines that do not exist are appended to the file # @param List or string that should be present in the file # -# **Example:** +# Example: # -# ```cf3 -# bundle agent example -# { -# vars: -# "nameservers" slist => { "8.8.8.8", "8.8.4.4" }; +# bundle agent example +# { +# vars: +# "nameservers" +# slist => { "8.8.8.8", "8.8.4.4" }; # -# files: -# "/etc/resolv.conf" edit_line => lines_present( @(nameservers) ); -# "/etc/ssh/sshd_config" edit_line => lines_present( "PermitRootLogin no" ); -# } -# ``` +# files: +# "/etc/resolv.conf" +# edit_line => lines_present( @(nameservers) ); +# "/etc/ssh/sshd_config" +# edit_line => lines_present( "PermitRootLogin no" ); +# } { insert_lines: diff --git a/web-ui/federated-reporting.markdown b/web-ui/federated-reporting.markdown index 8ba54d6fc..fb1c7dc2a 100644 --- a/web-ui/federated-reporting.markdown +++ b/web-ui/federated-reporting.markdown @@ -703,7 +703,7 @@ we use the number "1". Determine the cfdb-specific `hub_id`. ```command - /var/cfengine/bin/psql cfdb -c "select * from __hubs" + /var/cfengine/bin/psql cfdb -c "select * from __hubs" ``` Typical output would be like the following.