From 6ff4e324d01b4845ca270b4a6540f787064ba141 Mon Sep 17 00:00:00 2001 From: Josh Date: Wed, 10 Sep 2025 11:34:36 -0400 Subject: [PATCH 1/4] feat: Implement EoL warning banner for unsupported releases Added a warning banner for outdated documentation. Signed-off-by: Josh --- conf.py | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/conf.py b/conf.py index 2abb1d60439..c93558397ae 100644 --- a/conf.py +++ b/conf.py @@ -71,6 +71,19 @@ def generateVersionsDocs(current_docs): edit_on_github_project = 'nextcloud/documentation' edit_on_github_branch = 'master' +# Automatically add EoL warning banner to docs for unsupported releases +if (version.isdigit() and version < version_start): + rst_prolog = """.. danger:: + **OUTDATED DOCUMENTATION** + + *You are viewing documentation for a retired version of Nextcloud software. + Do not follow these instructions for current releases.* + + **To ensure you have the most reliable and up-to-date guidance, + please visit the** `official Nextcloud Documentation library + `_. + """ + # user starts in light mode default_dark_mode = False From fa1baf682e4716c852eee5167f1238d0bee4091c Mon Sep 17 00:00:00 2001 From: Josh Date: Wed, 17 Sep 2025 11:12:19 -0400 Subject: [PATCH 2/4] chore: Apply suggestions from code review Co-authored-by: Daniel Signed-off-by: Josh --- conf.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/conf.py b/conf.py index c93558397ae..428ec41f5ee 100644 --- a/conf.py +++ b/conf.py @@ -76,11 +76,11 @@ def generateVersionsDocs(current_docs): rst_prolog = """.. danger:: **OUTDATED DOCUMENTATION** - *You are viewing documentation for a retired version of Nextcloud software. + *You are viewing documentation for a retired version of Nextcloud. Do not follow these instructions for current releases.* **To ensure you have the most reliable and up-to-date guidance, - please visit the** `official Nextcloud Documentation library + please visit the** `Nextcloud Documentation homepage `_. """ From 221320cd27dcc0f05bf866f9ba0ac04eae7d4ba4 Mon Sep 17 00:00:00 2001 From: Josh Date: Wed, 17 Sep 2025 11:16:23 -0400 Subject: [PATCH 3/4] chore: drop tab from warning Updated warning message for outdated documentation. Signed-off-by: Josh --- conf.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/conf.py b/conf.py index 428ec41f5ee..ea60ea94cac 100644 --- a/conf.py +++ b/conf.py @@ -76,8 +76,8 @@ def generateVersionsDocs(current_docs): rst_prolog = """.. danger:: **OUTDATED DOCUMENTATION** - *You are viewing documentation for a retired version of Nextcloud. - Do not follow these instructions for current releases.* + *You are viewing documentation for a retired version of Nextcloud. + Do not follow these instructions for current releases.* **To ensure you have the most reliable and up-to-date guidance, please visit the** `Nextcloud Documentation homepage From 209506e93407169510946a50b4d7ab1c6c010604 Mon Sep 17 00:00:00 2001 From: Josh Date: Wed, 17 Sep 2025 13:20:59 -0400 Subject: [PATCH 4/4] chore: Upgrade upload-artifact action to v4.6.2 Signed-off-by: Josh --- .github/workflows/sphinxbuild.yml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/workflows/sphinxbuild.yml b/.github/workflows/sphinxbuild.yml index 99e584b5fbb..164273b5e2f 100644 --- a/.github/workflows/sphinxbuild.yml +++ b/.github/workflows/sphinxbuild.yml @@ -23,7 +23,7 @@ jobs: shell: bash run: tar czf /tmp/documentation.tar.gz -C user_manual/_build/html . - name: Upload static documentation - uses: actions/upload-artifact@v3.1.3 + uses: actions/upload-artifact@v4.6.2 with: name: User manual.zip path: "/tmp/documentation.tar.gz" @@ -55,7 +55,7 @@ jobs: shell: bash run: tar czf /tmp/documentation.tar.gz -C developer_manual/_build/html/com . - name: Upload static documentation - uses: actions/upload-artifact@v3.1.3 + uses: actions/upload-artifact@v4.6.2 with: name: Developer manual.zip path: "/tmp/documentation.tar.gz" @@ -75,7 +75,7 @@ jobs: shell: bash run: tar czf /tmp/documentation.tar.gz -C admin_manual/_build/html/com . - name: Upload static documentation - uses: actions/upload-artifact@v3.1.3 + uses: actions/upload-artifact@v4.6.2 with: name: Administration manual.zip path: "/tmp/documentation.tar.gz"