Improve website handling of 1.1_branch (#1877)

facebookresearch · Nov 4, 2021 · 8fa7a64 · 8fa7a64
1 parent c2ebedc
commit 8fa7a64
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 9 deletions.
diff --git a/website/docs/development/release.md b/website/docs/development/release.md
@@ -11,4 +11,7 @@ The release process may be automated in the future.
 - Update NEWS.md with towncrier
 - Create a wheel and source dist for hydra-core: `python -m build`
 - Upload pip package: `python -m twine upload dist/*`
-
+- Update the link to the latest stable release in `website/docs/intro.md`
+- If you are creating a new release branch:
+  - [tag a new versioned copy of the docs using docusaurus](https://docusaurus.io/docs/versioning#tagging-a-new-version)
+  - update `website/docusaurus.config.js` with a pointer to the new release branch on github
diff --git a/website/docs/intro.md b/website/docs/intro.md
@@ -27,9 +27,9 @@ Use the version switcher in the top bar to switch between documentation versions
 
 |        |          Version          |  Release notes                                                                      | Python Versions    |
 | -------|---------------------------|-------------------------------------------------------------------------------------| -------------------|
-| &#9658;| 1.1 (Stable)              | [Release notes](https://github.com/facebookresearch/hydra/releases/tag/v1.1.0)      | **3.6 - 3.9**      |
-|        | 1.0                       | [Release notes](https://github.com/facebookresearch/hydra/releases/tag/v1.0.0rc1)   | **3.6 - 3.8**      |
-|        | 0.11                      | [Release notes](https://github.com/facebookresearch/hydra/releases/tag/0.11.0)      | **2.7, 3.5 - 3.8** |
+| &#9658;| 1.1 (Stable)              | [Release notes](https://github.com/facebookresearch/hydra/releases/tag/v1.1.1)      | **3.6 - 3.9**      |
+|        | 1.0                       | [Release notes](https://github.com/facebookresearch/hydra/releases/tag/v1.0.7)      | **3.6 - 3.8**      |
+|        | 0.11                      | [Release notes](https://github.com/facebookresearch/hydra/releases/tag/v0.11.3)     | **2.7, 3.5 - 3.8** |
 
 
 ## Quick start guide

diff --git a/website/docusaurus.config.js b/website/docusaurus.config.js
@@ -15,8 +15,9 @@ module.exports = {
     projectName: 'hydra', // Usually your repo name.
     customFields: {
         githubLinkVersionToBaseUrl: {
-            // TODO: Update once a branch is cut for 1.1
-            "1.1": "https://github.com/facebookresearch/hydra/blob/main/",
+            // TODO: Update once a branch is cut for 1.2
+            "1.2": "https://github.com/facebookresearch/hydra/blob/main/",
+            "1.1": "https://github.com/facebookresearch/hydra/blob/1.1_branch/",
             "1.0": "https://github.com/facebookresearch/hydra/blob/1.0_branch/",
             current: "https://github.com/facebookresearch/hydra/blob/main/",
         },

diff --git a/website/versioned_docs/version-1.1/intro.md b/website/versioned_docs/version-1.1/intro.md
@@ -27,9 +27,9 @@ Use the version switcher in the top bar to switch between documentation versions
 
 |        |          Version          |  Release notes                                                                      | Python Versions    |
 | -------|---------------------------|-------------------------------------------------------------------------------------| -------------------|
-| &#9658;| 1.1 (Stable)              | [Release notes](https://github.com/facebookresearch/hydra/releases/tag/v1.1.0)      | **3.6 - 3.9**      |
-|        | 1.0                       | [Release notes](https://github.com/facebookresearch/hydra/releases/tag/v1.0.0rc1)   | **3.6 - 3.8**      |
-|        | 0.11                      | [Release notes](https://github.com/facebookresearch/hydra/releases/tag/0.11.0)      | **2.7, 3.5 - 3.8** |
+| &#9658;| 1.1 (Stable)              | [Release notes](https://github.com/facebookresearch/hydra/releases/tag/v1.1.1)      | **3.6 - 3.9**      |
+|        | 1.0                       | [Release notes](https://github.com/facebookresearch/hydra/releases/tag/v1.0.7)      | **3.6 - 3.8**      |
+|        | 0.11                      | [Release notes](https://github.com/facebookresearch/hydra/releases/tag/v0.11.3)     | **2.7, 3.5 - 3.8** |
 
 
 ## Quick start guide