Merge branch 'fix-publishing' into 'master'

Migrate to latest publishing method, and update dependencies to latest minimum version

See merge request saltstack/open/docs/salt-user-guide!88

Author: Derek

.brokignore

@@ -12,3 +12,4 @@ https://saltstack.gitlab.io/open/docs/salt-user-guide
 https://twitter.com/intent/follow?screen_name=Salt_Project_OS
 https://www.example.com
 https://www.example.org
+https://your-GitLab-username.gitlab.io

.gitlab-ci.yml

@@ -2,12 +2,32 @@
 stages:
   - pre-commit
   - build-docs
-  - publish-docs
+  - publish
   - trigger-upload
 
+include:
+  - project: saltstack/pop/cicd/ci-templates
+    file: /docswork/url-tester-brok.yml
+  - project: saltstack/pop/cicd/ci-templates
+    file: /docswork/publish-docs-gitlab.yml
+  - project: saltstack/pop/cicd/ci-templates
+    file: /docswork/salt-publish-docs-release.yml
+
+variables:
+  CICD_UPSTREAM_PATH: "saltstack/open/docs/salt-user-guide"
+
+url-tester-brok:
+  stage: pre-commit
+
 pre-commit:
   stage: pre-commit
   image: python:3.8-bullseye
+  variables:
+    PRE_COMMIT_HOME: "${CI_PROJECT_DIR}/pre-commit-cache"
+  cache:
+    key: pre-commit-cache
+    paths:
+      - pre-commit-cache/
   script:
     - pip install -U pip setuptools wheel
     - pip install -r requirements-dev.txt
@@ -30,25 +50,13 @@ build-docs-html:
     expire_in: 30 days
 
 pages:
-  stage: publish-docs
-  image: debian:bullseye-slim
-  script:
-    - mv html public
-    - 'echo "Gitlab Pages available at: ${CI_PAGES_URL}"'
-  artifacts:
-    paths:
-      - public
-    expire_in: 30 days
+  stage: publish
+  variables:
+    CICD_DOCS_VERSION_LATEST: latest
 
-trigger-upload:
+publish-docs:
   stage: trigger-upload
-  rules:
-    - if: '$CI_COMMIT_REF_PROTECTED == "true" && $CI_PROJECT_PATH == $CICD_UPSTREAM_PATH'
   variables:
-    ARTIFACT_PIPELINE_ID: $CI_PIPELINE_ID
-    GITLAB_PROJECT_PATH: "saltstack%2Fopen%2Fdocs%2Fsalt-user-guide"
-    DOCS_PATH: "docs.saltproject.io/salt/user-guide/en/latest"
-    RCLONE_OPTIONS: "sync -c -v"
-  trigger:
-    project: saltstack/open/docs/docs-upload
-    strategy: depend
+    CICD_S3_DEST_PATH: "docs.saltproject.io/salt/user-guide/"
+  rules:
+    - if: '$CI_COMMIT_BRANCH == "master" && $CI_PROJECT_PATH == $CICD_UPSTREAM_PATH'

README.rst

@@ -44,14 +44,14 @@ Check out the following links related to the Salt User Guide:
   Salt Project.
 * `Salt Project Home Page <https://saltproject.io/>`__: The web portal for
   Salt community events and resources.
-* `Contributing Guide <https://docs.saltproject.io/salt/user-guide/en/latest/topics/contributing.html>`__:
+* `Contributing Guide <https://saltstack.gitlab.io/open/docs/docs-hub/topics/contributing.html>`__:
   For information about contributing to the Salt User Guide and other Salt
   documentation projects, including how to set up your environment and other
   policies around submitting merge requests or issues.
-* `Salt Style Guide <https://docs.saltproject.io/salt/user-guide/en/latest/topics/style-guide.html>`__:
+* `Salt Style Guide <https://saltstack.gitlab.io/open/docs/docs-hub/topics/style-guide.html>`__:
   For general guidance about using Salt Project terms and other style or
   formatting conventions.
-* `Writing Salt documentation (rST guide) <https://docs.saltproject.io/salt/user-guide/en/latest/topics/writing-salt-docs.html>`__:
+* `Writing Salt documentation (rST guide) <https://saltstack.gitlab.io/open/docs/docs-hub/topics/rst-guide.html>`__:
   For conventions and guidelines about formatting reStructured Text (rST) in
   Salt documentation.
 

docs/requirements.txt

@@ -1,8 +1,8 @@
-Sphinx-Substitution-Extensions>=2022.02.16
-furo>=2022.06.21
-sphinx-copybutton>=0.5.0
-sphinx-design
+Sphinx-Substitution-Extensions>=2022.2.16
+furo>=2022.12.7
+sphinx-copybutton>=0.5.1
+sphinx-design>=0.3.0
 sphinx-inline-tabs>=2022.1.2b11
 sphinx-prompt
-sphinx-tabs>=3.3.1
-sphinx>=4.4.0
+sphinx-tabs>=3.4.1
+sphinx>=5.3.0

requirements-dev.txt

@@ -1,4 +1,2 @@
-docutils
-nox>=2020.12.31
-pre-commit>=2.17.0
-sphinx-tabs
+nox>=2022.11.21
+pre-commit>=2.20.0