Add documentation redirects (#3878)

ansible · Apr 20, 2023 · 02c7f68 · 02c7f68
1 parent e593c5f
commit 02c7f68
Show file tree

Hide file tree

Showing 5 changed files with 49 additions and 2 deletions.
diff --git a/.github/workflows/redirects.yml b/.github/workflows/redirects.yml
@@ -0,0 +1,33 @@
+---
+# Sync RTD redirects
+name: redirects
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - docs/redirects.yml
+      - .github/workflows/redirects.yml
+
+  # Manually triggered using GitHub's UI
+  workflow_dispatch:
+
+jobs:
+  docs:
+    environment: release
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v4
+
+      - name: Upgrade Python toolchain
+        run: python3 -m pip install --upgrade pip setuptools wheel
+
+      - name: Install readthedocs-cli
+        run: python3 -m pip install readthedocs-cli
+
+      - name: Sync redirects
+        run: rtd projects ansible-lint redirects sync -f docs/redirects.yml --wet-run
+        env:
+          RTD_TOKEN: ${{ secrets.RTD_TOKEN }}
diff --git a/docs/configuration.md b/docs/configuration.md
@@ -173,7 +173,7 @@ Molecule handles provisioning and converging the role.
 Molecule treats scenarios as a first-class citizens, with a top-level
 configuration syntax.
 
-A scenario allows Molecule test a role in a particular way, this is a \
+A scenario allows Molecule to test a role in a particular way, this is a
 fundamental change from Molecule v1.
 
 A scenario is a self-contained directory containing everything necessary

diff --git a/docs/google04e29a42ae6e6cbc.html b/docs/google04e29a42ae6e6cbc.html
@@ -0,0 +1 @@
+google-site-verification: google04e29a42ae6e6cbc.html
diff --git a/docs/redirects.yml b/docs/redirects.yml
@@ -0,0 +1,13 @@
+# Authoritative list of redirects we have configured in RTD,
+# https://pypi.org/project/readthedocs-cli/
+---
+- type: page
+  from_url: /en/latest/
+  to_url: /
+- type: page
+  from_url: /en/latest/getting-started/
+  to_url: /getting-started/
+# Keep this last or it will match all the other rules
+- type: sphinx_htmldir
+  from_url: ""
+  to_url: ""
diff --git a/pyproject.toml b/pyproject.toml
@@ -263,7 +263,7 @@ line-length = 88
 parametrize-values-type = "tuple"
 
 [tool.ruff.isort]
-known-first-party = ["ansiblelint"]
+known-first-party = ["molecule"]
 
 [tool.setuptools_scm]
 local_scheme = "no-local-version"
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		google-site-verification: google04e29a42ae6e6cbc.html