Apply suggestions from code review

Batch commit for changes Co-authored-by: Kristin Schlosser <57938820+k-schlosser@users.noreply.github.com>
greenbone · syspect-sec · Jul 12, 2023 · Jul 12, 2023 · Jul 12, 2023 · Jul 12, 2023
commit f5216d8d906a3d3174524670518f96f9d6982f88
@@ -52,39 +52,45 @@ Python 3.9 and later is supported. Also note that syncing feeds requires the `rs
 
 #### Installation Using pipx
 You can install the latest stable release of **greenbone-feed-sync** from the Python Package Index (pypi) using [pipx](https://pypa.github.io/pipx/).
+
 ```{code-block}
 :caption: Installing the package via pipx
 python3 -m pipx install greenbone-feed-sync
 ```
 
-#### Install using pip
-NOTE: The pip install command no longer works out-of-the-box in newer distributions like Ubuntu 23.04 because of [PEP 668](https://peps.python.org/pep-0668). Please use the [installation via pipx](https://github.com/greenbone/greenbone-feed-sync/tree/main#install-using-pipx) instead.
+#### Installation Using pip
+:::{note}
+The pip install command no longer works out-of-the-box in newer distributions like Ubuntu 23.04 because of [PEP 668](https://peps.python.org/pep-0668). Please use the [installation via pipx](https://github.com/greenbone/greenbone-feed-sync/tree/main#install-using-pipx) instead.
 
 You can install the latest stable release of **greenbone-feed-sync** from the Python Package Index (pypi) using [pip](https://pip.pypa.io/).
+
 ```{code-block}
 :caption: Installing the package via python-pip
 python3 -m pip install greenbone-feed-sync
 ```
 
 ## Updating the Greenbone Feeds
-### Updating Feeds For Greenbone Docker Containers
+### Updating Feeds for Greenbone Docker Containers
 ```{warning} Please note that different methods are required for completing a feed sync when using the official **Greenbone Docker containers**, which can be [found here](https://greenbone.github.io/docs/latest/22.4/container/workflows.html#performing-a-feed-synchronization).
 ```
 
-### Determining The Script Version In Use
-If you are unsure of which version of the feed sync script is active, you should check before you execute the `greenbone-feed-sync` command.One way to check is by using the `--version` argument. The legacy bash scripts will output the GVMD version, while the new Python scripts will output the version of the `greenbone-feed-sync` package itself. Otherwise, the script header can help distinguish which file is in use with certainty.
+### Determining the Script Version in Use
+If you are unsure of which version of the feed sync script is active, you should check this before executing the `greenbone-feed-sync` command. One way to check is by using the `--version` argument. The legacy bash scripts will output the GVMD version, while the new Python scripts will output the version of the `greenbone-feed-sync` package itself. Otherwise, the script header can help distinguish which file is in use with certainty.
 
 To check the file header, use the `which` command to determine the path of the command that is executed.
 
 For example:
+
 ```{code-block}
-:caption: Check the path of the active feed sync script
+:caption: Checking the path of the active feed sync script
 which greenbone-feed-sync
 /usr/local/bin/greenbone-feed-sync
 ```
-Once you determine the path of the executed command you can identify whether it is the new Python-based feed sync command or the legacy bash version. To do that, use the `head` command to print the first line of the script. This will indicate the interpreter used at run-time.
+
+Once you determined the path of the executed command, you can identify whether it is the new Python-based feed sync command or the legacy bash version. To do that, use the `head` command to print the first line of the script. This will indicate the interpreter used at run-time.
 
 For example:
+
 ```{code-block}
 :caption: If the new Python-based feed update script is active you will see
 head -1 /usr/local/bin/greenbone-feed-sync
@@ -97,17 +103,19 @@ head -1 /usr/local/sbin/greenbone-feed-sync
 ```
 
 ### Updating Feeds With New Python Script
-By default, when no arguments are passed, the new Python `greenbone-feed-sync` will updated all feed types. For standard installations that follow the [official Greenbone source code install instructions](https://greenbone.github.io/docs/latest/22.4/source-build/index.html), or the [Kali Linux native package installation](https://greenbone.github.io/docs/latest/22.4/kali/index.html), the new Python script should be run with `root`/`sudo` permissions, as it will change its execution context appropriately to the `gvm` or `_gvm` user.
+By default, when no arguments are passed, the new Python `greenbone-feed-sync` will update all feed types. For standard installations that follow the [official Greenbone source-code install instructions](https://greenbone.github.io/docs/latest/22.4/source-build/index.html), or the [Kali Linux native package installation](https://greenbone.github.io/docs/latest/22.4/kali/index.html), the new Python script should be run with `root`/`sudo` permissions, as it will change its execution context appropriately to the `gvm` or `_gvm` user.
 
 However, for non-standard installations that use a different username and group to execute the Greenbone components, the configured username and group context must be changed via the `greenbone-feed-sync.toml` configuration file. A basic example of how to configure a non-standard user via the `.toml` file can be [found here](https://github.com/greenbone/greenbone-feed-sync/blob/main/README.md#usage-on-kali-linux).
 
 ```{code-block}
-:caption: Update all feeds with single command
+:caption: Updating all feeds with single command
 sudo greenbone-feed-sync
 ```
+
 To update only one feed at a time, the new Python-based command can be used similar to the previous `/usr/sbin/greenbone-feed-sync` bash script command by specifying a feed type.
+
 ```{code-block}
-:caption: Include the feed type as an argument to update only a specific feed type
+:caption: Including the feed type as an argument to update only a specific feed type
 sudo greenbone-feed-sync --type <feed-type>
 ```
 
@@ -119,9 +127,9 @@ The available feed types are:
 * `gvmd-data`: Synchronizes GVM data feed which includes port lists, scan configs and report formats
 * `scap`: Synchronizes SCAP data feed
 * `cert`: Synchronizes CERT data feed
-* `notus`: Fetch any newly available NOTUS vulnerability tests
-* `nasl`: Fetch any newly available NASL vulnerability tests
-* `report-format` or `report-formats`: Fetches any newly available scan report formats
+* `notus`: Fetches any newly available Notus vulnerability tests
+* `nasl`: Fetches any newly available NASL vulnerability tests
+* `report-format` or `report-formats`: Fetches any newly available report formats
 * `scan-config` or `scan-configs`: Fetches any newly available scan configurations
 * `port-list` or `port-lists`: Fetches any newly available port lists
 
@@ -137,7 +145,7 @@ A complete list of settings are [available here](https://github.com/greenbone/gr
 The most basic arguments are:
 
 *  `--help`: Displays list of all available command line arguments
-*  `--verbose`: Sets verbose output. `-vvv` provides maximum verbosity.
+*  `--verbose`: Sets verbose output (`-vvv` provides maximum verbosity)
 *  `--version`: Displays the version of the script
 *  `--identify`: Displays information about the script, including script ID, name, version, feed name, whether it is restricted or not
 *  `--describe`: Displays a description of the script and the feed it synchronizes
@@ -146,22 +154,22 @@ The most basic arguments are:
 *  `--feedcurrent`: Checks if the feed is already up to date
 
 ### Updating Feeds With Legacy Bash Scripts (Not Recommended)
-If you absolutely cannot update to the new Python-based feed sync scripts because you are using a version of Greenbone prior to 22.4, or another reason, it's important to note that the legacy bash scripts can be run as the `sudo`/`root` user or the `gvm` user standard installations (`_gvm` on legacy versions of Kali). However, for non-standard installations that use a different username for the Greenbone components, the feed sync script should be run from the appropriate user context. Also, to update the feed sync using the legacy `greenbone-feed-sync` command, the `--type` parameter is **required**.
+If you absolutely cannot update to the new Python-based feed sync scripts because you are using a version of Greenbone prior to 22.4, or another reason, it is important to note that the legacy bash scripts can be run as the `sudo`/`root` user or the `gvm` user standard installations (`_gvm` on legacy versions of Kali). However, for non-standard installations that use a different username for the Greenbone components, the feed sync script should be run from the appropriate user context. Also, to update the feed sync using the legacy `greenbone-feed-sync` command, the `--type` parameter is **required**.
 
 For example:
 
 ```{code-block}
-:caption: Update feeds with legacy bash script
+:caption: Updating feeds with legacy bash script
 sudo -u gvm greenbone-feed-sync --type <feed-type>
 ```
 
-Using one of the following values to replace **\<feed-type>**:
+Use one of the following values to replace **\<feed-type>**:
 
 * `CERT`: Synchronizes CERT data feed
 * `SCAP`: Synchronizes SCAP data feed
 * `GVMD_DATA`: Synchronizes gvmd data feed
 
-### Updating Feeds For Kali Linux Native Installation
+### Updating Feeds for Kali Linux Native Installation
 Some older versions of Kali Linux include the `gvm-feed-update` command for feed synchronization. However, the wrapper script has been depreciated in newer versions of Kali and Greenbone's official `greenbone-feed-sync` command must be used instead.
 
 To update all feeds for versions of Kali Linux that include the `gvm-feed-update` script issue the following command can be used:
@@ -173,25 +181,28 @@ To update all feeds for versions of Kali Linux that include the `gvm-feed-update
 
 Please note that the `gvm-feed-update` command mentioned above is not maintained by Greenbone. It is maintained by the Kali/Debian package managers. Under the hood, the `gvm-feed-update` is a bash script that essentially executes the standard `greenbone-feed-sync --type <feed-type>` scripts provided by Greenbone. We recommend avoiding the use of `gvm-feed-update` for your feed sync operations.
 
-### Configuring The Feed Sync User For Non-Standard Installations
+### Configuring the Feed Sync User for Non-Standard Installations
 The Python-based feed sync scripts will automatically change context to the `gvm` user in order to process the feeds. Since the Kali native installation uses the `_gvm` user, it comes preconfigured with a `.toml` file which specifies the appropriate user context. The `greenbone-feed-sync` script will look for this configuration file at the locations `~/.config/greenbone-feed-sync.toml` and `/etc/gvm/greenbone-feed-sync.toml`. If you have configured a Greenbone source code installation with a non-standard username and group such as `_gvm` you must add the user and group context to the `/etc/gvm/greenbone-feed-sync.toml` file, configure the appropriate environment variable, or supply the user context via the `--user` and `--group` command line arguments.
 
 ### Verifying Successful Feed Sync Update
-After the sync operation completes, you can verify the successful update of the feed data by visiting the `/feedstatus` page which can be found under the **Administration** item in the top menu bar of Greenbone's web-interface. If a feed has successfully updated you will see **Current** beside the particular feed and the **Version** column will indicate the date/time of the feed's release.
+After the sync operation completes, you can verify the successful update of the feed data by visiting the *Feed Status* page which can be found under *Administration* in the menu bar of GSA. If a feed was successfully updated you will see **Current** beside the particular feed and the **Version** column will indicate the date/time of the feed's release.
 
 ## Automating Feed Sync Updates
 The Greenbone feeds are not automatically synced for the Greenbone Community source-code installations, Greenbone Community Docker containers, or Greenbone native Kali Linux installation. The suggested method for automating the Greenbone feed sync is to create a `crontab` file to schedule the feed sync command execution. For standard source-code installations, the `crontab` should be run under the `sudo` or `root` user context.
 
 ```{warning} Please note that different methods are required for completing a feed sync when using the official **Greenbone Docker containers**, which can be [found here](https://greenbone.github.io/docs/latest/22.4/container/workflows.html#performing-a-feed-synchronization). These commands can also be scheduled via **crontab**.
 ```
 
-## Troubleshooting A Connection To The Greenbone Feeds
-To trouble shoot a connection to the Greenbone feeds, you can issue the following command from a terminal.
+## Troubleshooting a Connection to the Greenbone Feeds
+To troubleshoot a connection to the Greenbone feeds, you can issue the following command from a terminal.
+
 ```{code-block}
-:caption: Verify an rsync connection to the Greenbone feeds
+:caption: Verifying an rsync connection to the Greenbone feeds
 rsync rsync://feed.community.greenbone.net/community
 ```
+
 You should see output such as the following:
+
 ```{code-block}
 :caption: Expected output when verifying an rsync connection to the Greenbone feeds
 Greenbone community feed server - http://feed.community.greenbone.net/
@@ -213,6 +224,7 @@ cert-data  Greenbone community CERT data feed, see https://community.greenbone.n
 community-legacy  Greenbone community legacy feed, see https://community.greenbone.net/
 community  Greenbone community feed, see https://community.greenbone.net/
 ```
+
 If you are unable to connect to the Greenbone feeds using the `rsync` command, we suggest you troubleshoot your network connection to identify any firewalls, content proxies, or network configurations that could be blocking the connection. Here are some suggested methods:
 
 ### Using nping