From 9d25cee13ade97beb3ad23561ea2321e609ca7ce Mon Sep 17 00:00:00 2001 From: matthew wall Date: Fri, 22 Dec 2023 09:16:09 -0500 Subject: [PATCH] more consistency/smoothing in the quickstart instructions --- docs_src/quickstarts/debian.md | 27 +++++++++++++-------------- docs_src/quickstarts/git.md | 26 ++++++++++++-------------- docs_src/quickstarts/pip.md | 18 ++++++++---------- docs_src/quickstarts/redhat.md | 25 ++++++++++++------------- docs_src/quickstarts/suse.md | 25 ++++++++++++------------- 5 files changed, 57 insertions(+), 64 deletions(-) diff --git a/docs_src/quickstarts/debian.md b/docs_src/quickstarts/debian.md index 96591f91..e47f5c39 100644 --- a/docs_src/quickstarts/debian.md +++ b/docs_src/quickstarts/debian.md @@ -89,26 +89,25 @@ To enable uploads, or to enable other reports, modify the configuration file sudo nano /etc/weewx/weewx.conf ``` -See the [*User's Guide*](../usersguide/introduction.md) and the reference -[*The configuration file -weewx.conf*](../reference/weewx-options/introduction.md) for -instructions. - -For more advanced customization, see the [*Customization -Guide*](../custom/introduction.md), as well as the [reference for skin -options](../reference/skin-options/introduction.md). +The reference +[*Application options*](../reference/weewx-options/introduction.md) +contains an extensive list of the configuration options, with explanations for +what they do. For more advanced customization, see the [*Customization +Guide*](../custom/introduction.md), as well as the reference [*Skin +options*](../reference/skin-options/introduction.md). -To install new skins, drivers, or other extensions, use the utility [`weectl -extension`](../utilities/weectl-extension.md). +To install new skins, drivers, or other extensions, use the [extension +utility](../utilities/weectl-extension.md). -WeeWX must be restarted for any changes to take effect. +WeeWX must be restarted for the changes to take effect. ```{.shell .copy} sudo systemctl restart weewx ``` -Consider putting yourself into the `weewx` group. When you are in the `weewx` -group, you can do many things without having to `sudo`, including modifying -the WeeWX configuration and installing extensions. +If you plan to do a lot of customization, consider putting yourself into the +`weewx` group. When you are in the `weewx` group, you can do many things +without having to `sudo`, including modifying the WeeWX configuration and +installing extensions. ```{.shell .copy} sudo usermod -aG weewx $USER ``` diff --git a/docs_src/quickstarts/git.md b/docs_src/quickstarts/git.md index ff65620a..7fa45636 100644 --- a/docs_src/quickstarts/git.md +++ b/docs_src/quickstarts/git.md @@ -104,10 +104,10 @@ source ~/weewx-venv/bin/activate python3 ~/weewx/src/weewxd.py ``` -To run `weewxd` as a daemon, install a systemd or init file that is -appropriate for your operating system. Be sure to use the full path in the -virtual environment to the Python interpreter and `weewxd.py`. Examples are -included in the directory `~/weewx-data/util`. +To run `weewxd` as a daemon, install a systemd service unit or SysV init script +that is appropriate for your operating system. Be sure to use the full path to +the Python interpreter and `weewxd.py` - the paths in the virtual environment. +Examples are included in the directory `~/weewx-data/util`. ## Verify @@ -138,17 +138,15 @@ To enable uploads, or to enable other reports, modify the configuration file nano ~/weewx-data/weewx.conf ``` -See the [*User's Guide*](../usersguide/introduction.md) and the reference -[*The configuration file -weewx.conf*](../reference/weewx-options/introduction.md) for -instructions. - -For more advanced customization, see the [*Customization -Guide*](../custom/introduction.md), as well as the [reference for skin -options](../reference/skin-options/introduction.md). +The reference +[*Application options*](../reference/weewx-options/introduction.md) +contains an extensive list of the configuration options, with explanations for +what they do. For more advanced customization, see the [*Customization +Guide*](../custom/introduction.md), as well as the reference [*Skin +options*](../reference/skin-options/introduction.md). -To install new skins, drivers, or other extensions, use the utility [`weectl -extension`](../utilities/weectl-extension.md). +To install new skins, drivers, or other extensions, use the [extension +utility](../utilities/weectl-extension.md). The executable `weewxd` must be restarted for the changes to take effect. diff --git a/docs_src/quickstarts/pip.md b/docs_src/quickstarts/pip.md index 2273939a..a8c5c301 100644 --- a/docs_src/quickstarts/pip.md +++ b/docs_src/quickstarts/pip.md @@ -303,17 +303,15 @@ To enable uploads, or to enable other reports, modify the configuration file nano ~/weewx-data/weewx.conf ``` -See the [*User's Guide*](../usersguide/introduction.md) and the reference -[*The configuration file -weewx.conf*](../reference/weewx-options/introduction.md) for -instructions. - -For more advanced customization, see the [*Customization -Guide*](../custom/introduction.md), as well as the [reference for skin -options](../reference/skin-options/introduction.md). +The reference +[*Application options*](../reference/weewx-options/introduction.md) +contains an extensive list of the configuration options, with explanations for +what they do. For more advanced customization, see the [*Customization +Guide*](../custom/introduction.md), as well as the reference [*Skin +options*](../reference/skin-options/introduction.md). -To install new skins, drivers, or other extensions, use the utility [`weectl -extension`](../utilities/weectl-extension.md). +To install new skins, drivers, or other extensions, use the [extension +utility](../utilities/weectl-extension.md). WeeWX must be restarted for the changes to take effect. diff --git a/docs_src/quickstarts/redhat.md b/docs_src/quickstarts/redhat.md index bf00b397..57bfd623 100644 --- a/docs_src/quickstarts/redhat.md +++ b/docs_src/quickstarts/redhat.md @@ -91,26 +91,25 @@ To enable uploads, or to enable other reports, modify the configuration file sudo nano /etc/weewx/weewx.conf ``` -See the [*User's Guide*](../usersguide/introduction.md) and the reference -[*The configuration file -weewx.conf*](../reference/weewx-options/introduction.md) for -instructions. - -For more advanced customization, see the [*Customization -Guide*](../custom/introduction.md), as well as the [reference for skin -options](../reference/skin-options/introduction.md). +The reference +[*Application options*](../reference/weewx-options/introduction.md) +contains an extensive list of the configuration options, with explanations for +what they do. For more advanced customization, see the [*Customization +Guide*](../custom/introduction.md), as well as the reference [*Skin +options*](../reference/skin-options/introduction.md). -To install new skins, drivers, or other extensions, use the utility [`weectl -extension`](../utilities/weectl-extension.md). +To install new skins, drivers, or other extensions, use the [extension +utility](../utilities/weectl-extension.md). WeeWX must be restarted for the changes to take effect. ```{.shell .copy} sudo systemctl restart weewx ``` -Consider putting yourself into the `weewx` group. When you are in the `weewx` -group, you can do many things without having to `sudo`, including modifying -the WeeWX configuration and installing extensions. +If you plan to do a lot of customization, consider putting yourself into the +`weewx` group. When you are in the `weewx` group, you can do many things +without having to `sudo`, including modifying the WeeWX configuration and +installing extensions. ```{.shell .copy} sudo usermod -aG weewx $USER ``` diff --git a/docs_src/quickstarts/suse.md b/docs_src/quickstarts/suse.md index a522ae98..57f26203 100644 --- a/docs_src/quickstarts/suse.md +++ b/docs_src/quickstarts/suse.md @@ -83,26 +83,25 @@ To enable uploads, or to enable other reports, modify the configuration file sudo nano /etc/weewx/weewx.conf ``` -See the [*User's Guide*](../usersguide/introduction.md) and the reference -[*The configuration file -weewx.conf*](../reference/weewx-options/introduction.md) for -instructions. - -For more advanced customization, see the [*Customization -Guide*](../custom/introduction.md), as well as the [reference for skin -options](../reference/skin-options/introduction.md). +The reference +[*Application options*](../reference/weewx-options/introduction.md) +contains an extensive list of the configuration options, with explanations for +what they do. For more advanced customization, see the [*Customization +Guide*](../custom/introduction.md), as well as the reference [*Skin +options*](../reference/skin-options/introduction.md). -To install new skins, drivers, or other extensions, use the utility [`weectl -extension`](../utilities/weectl-extension.md). +To install new skins, drivers, or other extensions, use the [extension +utility](../utilities/weectl-extension.md). WeeWX must be restarted for the changes to take effect. ```{.shell .copy} sudo systemctl restart weewx ``` -Consider putting yourself into the `weewx` group. When you are in the `weewx` -group, you can do many things without having to `sudo`, including modifying -the WeeWX configuration and installing extensions. +If you plan to do a lot of customization, consider putting yourself into the +`weewx` group. When you are in the `weewx` group, you can do many things +without having to `sudo`, including modifying the WeeWX configuration and +installing extensions. ```{.shell .copy} sudo usermod -aG weewx $USER ```