Fix: Address various shellcheck linting errors in scripts

[releng/global-jjb.git] / docs / best-practices.rst

diff --git a/docs/best-practices.rst b/docs/best-practices.rst
index 85ee7f7..199422a 100644 (file)
--- a/docs/best-practices.rst
+++ b/docs/best-practices.rst
@@ -158,7 +158,6 @@ ship-logs example:
           - shell: !include-raw:
               - ../shell/logs-get-credentials.sh
           - shell: !include-raw:
-              - ../shell/lftools-install.sh
               - ../shell/logs-deploy.sh
           - shell: !include-raw:
               - ../shell/logs-clear-credentials.sh
@@ -172,7 +171,7 @@ complete running via the logs-clear-credentials.sh script. This script contains
 3 basic steps:
 
 1. Provide credentials via config-file-provider
-2. Run the build scripts in this case lftools-install.sh and logs-deploy.sh
+2. Run logs-deploy.sh
 3. Remove credentials provided by config-file-provider
 
 .. _preserve-variable-refs:
@@ -182,7 +181,7 @@ Preserving Objects in Variable References
 
 JJB has an option to preserve a data structure object when you want to pass
 it to a template.
-https://docs.openstack.org/infra/jenkins-job-builder/definition.html#variable-references
+https://jenkins-job-builder.readthedocs.io/en/latest/definition.html#variable-references
 
 One thing that is not explicitly covered is the format of the variable name
 that you pass the object to. When you use the `{obj:key}` notation to preserve
@@ -196,7 +195,7 @@ Example:
 
    .. literalinclude:: _static/github-pr-trigger.example
 
-In the above example note the use of underscores in ``github_pr_whitelist``,
+In the above example note the use of underscores in ``github_pr_allowlist``,
 ``github_pr_admin_list``, and ``github_included_regions``.
 
 Using single quotes around variables