Skip to content
This repository was archived by the owner on Oct 22, 2024. It is now read-only.

Commit 524addf

Browse files
committed
docs: discourage usage of "devel" documentation
Users who landed on https://intel.github.io/pmem-csi/ or used https://intel.github.io/pmem-csi/latest were told how to install the development version of PMEM-CSI and then probably unintentionally tried that instead of using the latest stable release. We now make the latest stable release the main page, with "devel" in the URL for the development version, "latest" as symlink for the latest stable version (offered for those who still have those pages bookmarked or in emails). When pointing to documentation, we should always use the versioned pages because those URLs are stable.
1 parent fccbe93 commit 524addf

File tree

2 files changed

+11
-7
lines changed

2 files changed

+11
-7
lines changed

.github/workflows/publish.yml

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ on:
55
branches:
66
- devel
77
- release-0.7
8+
- release-0.8
9+
- release-0.9
810

911
jobs:
1012
build:
@@ -23,16 +25,18 @@ jobs:
2325
run: |
2426
mkdir $HOME/output
2527
touch $HOME/output/.nojekyll
26-
# This is the static index page for https://intel.github.io/pmem-csi,
27-
# copied from the "devel" branch.
28-
cp docs/html/index2.html $HOME/output/index.html
28+
# https://intel.github.io/pmem-csi/ redirects to the latest stable release.
29+
echo "<meta http-equiv=\"refresh\" content=\"0; URL='0.9/index.html'\" />" >"$HOME/output/index.html"
30+
# "latest" used to be what "devel" is now, i.e. the documentation for the "devel"
31+
# branch. Now it points to the latest stable release.
32+
ln -s 0.9 "$HOME/output/latest"
2933
- name: Build latest
3034
run: |
3135
GITHUB_SHA=$(git rev-parse HEAD)
3236
export GITHUB_SHA
3337
rm -rf _work/venv
3438
make vhtml
35-
mv _output/html $HOME/output/latest
39+
mv _output/html $HOME/output/devel
3640
- uses: actions/checkout@v2
3741
with:
3842
ref: release-0.7

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,10 @@ and bug fixes. Older releases are no longer supported.
1616

1717
Documentation is part of the source code for each release and also
1818
available in rendered form for easier reading:
19-
- [latest documentation, in development](https://intel.github.io/pmem-csi/latest/)
20-
- [latest 0.7.x release](https://intel.github.io/pmem-csi/0.7/)
21-
- [latest 0.8.x release](https://intel.github.io/pmem-csi/0.8/)
2219
- [latest 0.9.x release](https://intel.github.io/pmem-csi/0.9/)
20+
- [latest 0.8.x release](https://intel.github.io/pmem-csi/0.8/)
21+
- [latest 0.7.x release](https://intel.github.io/pmem-csi/0.7/)
22+
- [latest documentation, in development](https://intel.github.io/pmem-csi/devel/)
2323

2424
## Supported Kubernetes versions
2525

0 commit comments

Comments
 (0)