saltstack · ScriptAutomate · Oct 31, 2024 · Oct 30, 2024
diff --git a/.gitignore b/.gitignore
@@ -74,8 +74,8 @@ instance/
 # Sphinx documentation
 docs/_build/
 ## Generated stuff from Sphinx templates
-docs/sitevars.rst
-docs/topics/announcements.rst
+# docs/sitevars.rst
+# docs/topics/announcements.rst
 
 # PyBuilder
 .pybuilder/

diff --git a/README.rst b/README.rst
@@ -38,7 +38,6 @@ The Salt Install Guide supplements and extends the core documentation for the
 help Salt users install ``salt`` in their environment, ultimately superseding
 documentation where applicable:
 
-* Install directions on `repo.saltproject.io <https://repo.saltproject.io/>`__
 * Install directions on `docs.saltproject.io <https://docs.saltproject.io/en/master/topics/installation/index.html>`__
 
 Contributions from anyone inside the Salt project community are always welcome.

diff --git a/docs/_static/img/repo-landing-small.png b/docs/_static/img/repo-landing-small.png
diff --git a/docs/_templates/sitevars.rst b/docs/_templates/sitevars.rst
diff --git a/docs/conf.py b/docs/conf.py
@@ -19,7 +19,6 @@
 import requests
 from docutils import nodes
 from docutils.nodes import Element
-from salt_furo_versioner import make_html_context
 from sphinx.writers.html import HTMLTranslator
 
 
@@ -94,7 +93,7 @@ def setup(app):
 )
 
 # Pull release from "release" in sitevars.rst
-release = [s for s in site_vars if "|release|" in s][0].split(":: ")[1]
+release = [s for s in site_vars if "|minor-lts-version|" in s][0].split(":: ")[1]
 version = release
 
 # Grab major version for URL version selector generation
@@ -104,6 +103,7 @@ def setup(app):
 # Furo theme version selector setup
 ##
 # Pull from JSON in GitLab Snippet
+"""
 supported_versions_json = requests.get(
     "https://gitlab.com/saltstack/open/docs/salt-install-guide/-/snippets/2580440/raw/main/supported-versions.json"
 )
@@ -124,6 +124,7 @@ def setup(app):
     latest_version=latest_version,
     versions=versions,
 )
+"""
 
 # -- General configuration ---------------------------------------------------
 
@@ -181,7 +182,7 @@ def setup(app):
         "color-brand-primary": "#66CCF4",
         "color-brand-content": "#66CCF4",
     },
-    "announcement": "You are currently viewing the <strong>3007 STS</strong> version of the Salt install guide. Use the LTS version of Salt in production environments.<br /> To change to the 3006 LTS version, use the version selector at the bottom of the left menu bar.",
+    "announcement": "IMPORTANT ANNOUNCEMENT: repo.saltproject.io has migrated to packages.broadcom.com!<br />A review and update of installation automation is advised.",
 }
 
 # Add any paths that contain custom static files (such as style sheets) here,

diff --git a/docs/index.rst b/docs/index.rst
@@ -4,7 +4,7 @@
 Install Salt
 ============
 
-.. include:: topics/_includes/install-overview.rst
+.. include:: topics/_includes/repo-landing.rst
 
 
 .. toctree::
@@ -62,7 +62,7 @@ Install Salt
    :hidden:
    :caption: Contribute
 
-   Open a Salt issue to report install bugs <https://github.com/saltstack/salt/issues/new/choose>
-   Open a docs issue <https://gitlab.com/saltstack/open/docs/salt-install-guide/-/issues>
+   Open a Salt issue to report bugs <https://github.com/saltstack/salt/issues/new/choose>
+   Open an Install Guide docs issue <https://github.com/saltstack/salt-install-guide/issues/new>
    Salt docs contributing guide <https://saltstack.gitlab.io/open/docs/docs-hub/topics/contributing.html>
-   GitLab repository <https://gitlab.com/saltstack/open/docs/salt-install-guide>
+   Salt Install Guide source <https://github.com/saltstack//salt-install-guide>
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1,12 +1,9 @@
-# If using version selector, use
-# Temporary Furo theme target for versioning
-# furo==2022.6.21
-Sphinx-Substitution-Extensions==2022.02.16
+furo>=2024.8.6
 requests>=2.31.0
-salt-furo-versioner @ git+https://github.com/ScriptAutomate/salt-furo-versioner@excelsior
-sphinx-copybutton==0.5.2
-sphinx-design==0.5.0
-sphinx-inline-tabs==2023.4.21
-sphinx-prompt==1.5.0
-sphinx-tabs==3.4.7
-sphinx==5.3.0
+sphinx-copybutton>=0.5.2
+sphinx-design>=0.5.0
+sphinx-inline-tabs>=2023.4.21
+sphinx-prompt>=1.5.0
+sphinx-substitution-extensions>=2022.02.16
+sphinx-tabs>=3.4.7
+sphinx>=5.3.0
diff --git a/docs/sitevars.rst b/docs/sitevars.rst
@@ -0,0 +1,42 @@
+.. |major-lts-version| replace:: 3006
+.. |major-sts-version| replace:: 3007
+.. |minor-lts-version| replace:: 3006.9
+.. |minor-sts-version| replace:: 3007.1
+.. |minor-lts-version-badge| replace:: :bdg-link-primary:`3006.9 <https://docs.saltproject.io/en/3006/topics/releases/3006.9.html>`
+.. |minor-sts-version-badge| replace:: :bdg-link-success:`3007.1 <https://docs.saltproject.io/en/latest/topics/releases/3007.1.html>`
+
+.. |relenv-lts-python-version| replace:: **Python v3.10.x**
+.. |relenv-sts-python-version| replace:: **Python v3.10.x**
+
+.. |quickstart-script-path| replace:: https://raw.githubusercontent.com/saltstack/salt-bootstrap/develop/salt-quick-start.sh
+.. |quickstart-script-path-windows| replace:: https://raw.githubusercontent.com/saltstack/salt-bootstrap/develop/salt-quick-start.ps1
+.. |windows-vs-buildtools-script| replace:: https://raw.githubusercontent.com/saltstack/salt/master/pkg/windows/install_vs_buildtools.ps1
+
+.. |release-candidate-version| replace:: RC_RELEASE
+.. |bootstrap-release-candidate| replace:: python3 git vRC_RELEASE
+.. |pip-install-release-candidate| replace:: pip install salt==RC_RELEASE
+
+.. |macos-amd64-lts-download| replace:: https://packages.broadcom.com/artifactory/saltproject-generic/macos/3006.9/salt-3006.9-py3-x86_64.pkg
+.. |macos-arm64-lts-download| replace:: https://packages.broadcom.com/artifactory/saltproject-generic/macos/3006.9/salt-3006.9-py3-arm64.pkg
+
+.. |macos-amd64-sts-download| replace:: https://packages.broadcom.com/artifactory/saltproject-generic/macos/3007.1/salt-3007.1-py3-x86_64.pkg
+.. |macos-arm64-sts-download| replace:: https://packages.broadcom.com/artifactory/saltproject-generic/macos/3007.1/salt-3007.1-py3-arm64.pkg
+
+.. |windows-install-exe-example| replace:: Salt-Minion-3006.9-Py3-AMD64-Setup.exe
+.. |windows-install-msi-example| replace:: Salt-Minion-3006.9-Py3-AMD64.msi
+
+.. |windows-amd64-exe-lts-download| replace:: https://packages.broadcom.com/artifactory/saltproject-generic/windows/3006.9/Salt-Minion-3006.9-Py3-AMD64-Setup.exe
+.. |windows-amd64-msi-lts-download| replace:: https://packages.broadcom.com/artifactory/saltproject-generic/windows/3006.9/Salt-Minion-3006.9-Py3-AMD64.msi
+.. |windows-x86-exe-lts-download| replace:: https://packages.broadcom.com/artifactory/saltproject-generic/windows/3006.9/Salt-Minion-3006.9-Py3-x86-Setup.exe
+.. |windows-x86-msi-lts-download| replace:: https://packages.broadcom.com/artifactory/saltproject-generic/windows/3006.9/Salt-Minion-3006.9-Py3-x86.msi
+
+.. |windows-amd64-exe-sts-download| replace:: https://packages.broadcom.com/artifactory/saltproject-generic/windows/3007.1/Salt-Minion-3007.1-Py3-AMD64-Setup.exe
+.. |windows-amd64-msi-sts-download| replace:: https://packages.broadcom.com/artifactory/saltproject-generic/windows/3007.1/Salt-Minion-3007.1-Py3-AMD64.msi
+.. |windows-x86-exe-sts-download| replace:: https://packages.broadcom.com/artifactory/saltproject-generic/windows/3007.1/Salt-Minion-3007.1-Py3-x86-Setup.exe
+.. |windows-x86-msi-sts-download| replace:: https://packages.broadcom.com/artifactory/saltproject-generic/windows/3007.1/Salt-Minion-3007.1-Py3-x86.msi
+
+.. |windows-release-candidate-amd64-exe-file-name| replace:: TBD
+.. |windows-release-candidate-amd64-exe-url| replace:: TBD
+.. |windows-release-candidate-amd64-msi-url| replace:: TBD
+.. |windows-release-candidate-x86-exe-url| replace:: TBD
+.. |windows-release-candidate-x86-msi-url| replace:: TBD
diff --git a/docs/topics/_includes/fips-photon-os.rst b/docs/topics/_includes/fips-photon-os.rst
diff --git a/docs/topics/_includes/gpg-keys.rst b/docs/topics/_includes/gpg-keys.rst
@@ -1,5 +1,5 @@
 .. admonition:: GPG key change
 
-   The GPG key for the |release| release is now named:
-   SALT-PROJECT-GPG-PUBKEY-2023. You must import the new GPG key before
-   upgrading or your upgrade will fail.
+   The GPG key for Salt 3005, and earlier, used an older GPG key.
+   You must import the new GPG key before upgrading or your upgrade will fail.
+   See :ref:`install-by-operating-system-index` for the specific commands.
diff --git a/docs/topics/_includes/install-method.rst b/docs/topics/_includes/install-method.rst
@@ -1,5 +1,9 @@
-The Salt Project provides a public repository for packages at the
-`Salt Project Package Repo <https://repo.saltproject.io/>`__.
+The Salt Project provides public repositories for packages on the
+public Broadcom Artifactory endpoint:
+
+* `Salt Project RPM Repo <https://packages.broadcom.com/ui/repos/tree/General/saltproject-rpm>`__
+* `Salt Project DEB Repo <https://packages.broadcom.com/ui/repos/tree/General/saltproject-deb>`__
+* `Salt Project Generic Repo (Windows, MacOS, etc.) <https://packages.broadcom.com/ui/repos/tree/General/saltproject-generic>`__
 
 The preferred method for installing Salt is using distribution packages. This
 method ensures that:

diff --git a/docs/topics/_includes/macos-downloads.rst b/docs/topics/_includes/macos-downloads.rst
@@ -1,19 +1,39 @@
+3006 LTS Downloads
+------------------
+
+.. list-table::
+  :widths: 10 10 40
+  :header-rows: 1
+  :class: windows-mac-download
+
+  * - Arch
+    - Salt Release Type
+    - Download install file
+
+  * - x86_64
+    - lts
+    - |macos-amd64-lts-download|
+
+  * - arm64
+    - lts
+    - |macos-arm64-lts-download|
+
+3007 STS Downloads
+------------------
+
 .. list-table::
-  :widths: 10 10 40 40
+  :widths: 10 10 40
   :header-rows: 1
   :class: windows-mac-download
 
   * - Arch
-    - File type
+    - Salt Release Type
     - Download install file
-    - GPG
 
   * - x86_64
-    - pkg
-    - |macos-amd64-download|
-    - |macos-amd64-gpg|
+    - sts
+    - |macos-amd64-sts-download|
 
   * - arm64
-    - pkg
-    - |macos-arm64-download|
-    - |macos-amd64-gpg|
+    - sts
+    - |macos-arm64-sts-download|
diff --git a/docs/topics/_includes/repo-landing.rst b/docs/topics/_includes/repo-landing.rst
@@ -0,0 +1,102 @@
+.. div:: landing-title
+
+    .. grid::
+        :reverse:
+        :gutter: 2 3 3 3
+        :margin: 4 4 1 2
+
+        .. grid-item::
+            :columns: 12 3 3 3
+            :class: sd-m-auto sd-animate-grow50-rot20
+
+            .. image:: /_static/img/repo-landing-small.png
+              :width: 125
+              :alt: Salt Project install guide logo
+
+        .. grid-item::
+            :columns: 12 9 9 9
+            :class: sd-text-white sd-fs-2 sd-text-center
+
+            The Salt install guide
+
+            .. button-link:: https://docs.saltproject.io/en/master/topics/tutorials/walkthrough.html
+               :color: light
+               :align: center
+               :outline:
+
+                New to Salt? Try this tutorial
+
+=======
+Welcome
+=======
+
+Welcome to the Salt install guide! This guide provides instructions for
+installing Salt on :ref:`salt-supported-operating-systems`. It also explains
+how to configure Salt, start Salt services, and verify your installation.
+
+Note that the Salt Project has phased out classic package builds for supported
+operating systems for 3006 and later. Update your Salt infrastructure to the new
+onedir packages as soon as possible. See :ref:`upgrade-to-onedir` for
+instructions.
+
+Install Salt
+============
+
+.. grid:: 3
+
+    .. grid-item::
+
+        .. button-link:: topics/overview.html
+           :color: primary
+           :expand:
+
+           Install overview :octicon:`arrow-up-right`
+
+    .. grid-item::
+
+        .. button-link:: topics/bootstrap.html
+           :color: primary
+           :expand:
+
+           Bootstrap install :octicon:`arrow-up-right`
+
+    .. grid-item::
+
+        .. button-link:: topics/salt-supported-operating-systems.html
+           :color: primary
+           :expand:
+
+           Supported systems :octicon:`arrow-up-right`
+
+Quick install by operating system
+=================================
+
+Operating systems are listed in alphabetical order:
+
+.. grid:: 2
+    :gutter: 3
+
+    .. grid-item-card:: Linux (DEB)
+       :class-card: sd-border-1
+       :link: topics/install-by-operating-system/linux-deb.html
+
+       :bdg-primary:`Debian-like Systems`
+
+    .. grid-item-card:: Linux (RPM)
+       :class-card: sd-border-1
+       :link: topics/install-by-operating-system/linux-rpm.html
+
+       :bdg-primary:`RHEL-like systems`
+
+    .. grid-item-card:: macOS
+       :class-card: sd-border-1
+       :link: topics/install-by-operating-system/macos.html
+
+       :bdg-primary:`pkg`
+
+    .. grid-item-card:: Windows
+       :class-card: sd-border-1
+       :link: topics/install-by-operating-system/windows.html
+
+       :bdg-primary:`exe`
+       :bdg-secondary:`msi`
diff --git a/docs/topics/_includes/supported-salt-releases-sidebar.rst b/docs/topics/_includes/supported-salt-releases-sidebar.rst
@@ -1,6 +1,6 @@
 .. sidebar:: **Supported Salt releases**
 
-    |supported-release-1-badge| |supported-release-2-badge|
+    |minor-lts-version-badge| |minor-sts-version-badge|
 
     **See also**
 

diff --git a/docs/topics/_includes/warning-about-old-packages.rst b/docs/topics/_includes/warning-about-old-packages.rst
diff --git a/docs/topics/_includes/what-is-a-native-minion.rst b/docs/topics/_includes/what-is-a-native-minion.rst
diff --git a/docs/topics/_includes/what-is-onedir.rst b/docs/topics/_includes/what-is-onedir.rst
@@ -4,7 +4,7 @@
    include the version of Python needed to run Salt and Salt's required
    dependencies.
 
-   Beginning with the release of Salt 3006 (Sulfur), the Salt Project has phased
+   Beginning with the release of Salt 3006 LTS (Sulfur), the Salt Project has phased
    out classic package builds for supported operating systems. Update your Salt
    infrastructure to the onedir packages as soon as possible. See
    :ref:`upgrade-to-onedir` for more information.