Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve website handling of 1.1_branch #1877

Merged
merged 5 commits into from
Nov 4, 2021
Merged

Improve website handling of 1.1_branch #1877

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
b9d30d7
Update docusaurus config with reference to 1.1_branch
Jasha10 Nov 4, 2021
e6847a6
docs: Update pointers to latest releases on each branch
Jasha10 Nov 4, 2021
334e58c
Update developer release guide with instructions on doc updates
Jasha10 Nov 4, 2021
10c6ba5
update release links in versioned docs (version-1.1)
Jasha10 Nov 4, 2021
7935436
add instruction with link to docusaurus versioned docs page
Jasha10 Nov 4, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion website/docs/development/release.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
6 changes: 3 additions & 3 deletions website/docs/intro.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,9 @@ Use the version switcher in the top bar to switch between documentation versions

| | Version | Release notes | Python Versions |
| -------|---------------------------|-------------------------------------------------------------------------------------| -------------------|
| ►| 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** |
| ►| 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
Expand Down
5 changes: 3 additions & 2 deletions website/docusaurus.config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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/",
},
Expand Down
6 changes: 3 additions & 3 deletions website/versioned_docs/version-1.1/intro.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,9 @@ Use the version switcher in the top bar to switch between documentation versions

| | Version | Release notes | Python Versions |
| -------|---------------------------|-------------------------------------------------------------------------------------| -------------------|
| ►| 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** |
| ►| 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
Expand Down