Skip to content

change stable to be a symlink to the latest released version #468

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.

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

Merged
merged 3 commits into from
Sep 3, 2020
Merged

change stable to be a symlink to the latest released version #468

merged 3 commits into from
Sep 3, 2020

Conversation

mattip
Copy link
Contributor

@mattip mattip commented Aug 31, 2020

The idea is to make the stable directory a symlink to the latest released documents, to remove one point of friction when releasing a new version. This is the way numpy does it: the stable symlink seamlessly works with github docs to point to the 1.19.0 docs

This has a merge conflict since the docs are updated every night somehow the stable docs got out of sync?. I will rebase fix it if I can convince the maintainers as to the approach, but then it must be merged before the next nightly build. Edit: Not clear why there is a conflict, the files on my checkout are identical.

The commits to reconstruct this were (on linux where symlinks work)

git checkout site
git pull
git checkout -b stable
cd docs
git rm -r 1.6.0
git commit -m"remove links in 1.6.0"
git mv stable 1.6.0
git commit -m"move stable to 1.6.0"
ln -s 1.6.0 stable
git add stable
git commit -m"recreate stable as a soft link to 1.6.0"
git push

@netlify
Copy link

netlify bot commented Aug 31, 2020

Deploy preview for pytorch-dot-org-preview processing.

Building with commit 38a14e8

https://app.netlify.com/sites/pytorch-dot-org-preview/deploys/5f507fd9e0525a00071e3443

@mattip
Copy link
Contributor Author

mattip commented Aug 31, 2020

The preview works, stable documents are visible even though they are a symlink.

@brianjo brianjo self-assigned this Sep 2, 2020
@brianjo brianjo requested a review from zou3519 September 2, 2020 21:14
Copy link
Contributor

@zou3519 zou3519 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is amazing -- the reason why I put in the redirect pages way back when was because I didn't think github pages would support symlinks. The symlinks are a much cleaner solution and will definitely improve our docs build process

@brianjo
Copy link
Contributor

brianjo commented Sep 2, 2020

@mattip Thanks for this PR. I'm having a little trouble fixing the conflict. If you could do so, please feel free to fix and merge. (I can fix the file later if there's a data loss.)

@mattip
Copy link
Contributor Author

mattip commented Sep 3, 2020

CI is green. I cannot merge (no permissions).

@brianjo
Copy link
Contributor

brianjo commented Sep 3, 2020

Awesome! Thanks @mattip!

@brianjo brianjo merged commit b3f743f into pytorch:site Sep 3, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants