-
-
Notifications
You must be signed in to change notification settings - Fork 503
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
Make v1 Documentation Available #733
Comments
How does one configure this? |
Readthedocs supports publishing various different versions based off of git tags: https://docs.readthedocs.io/en/stable/versions.html Because the prior documentation doesn't seem to exist any more, I'm unsure on how you would be able to upload this (without modifying the already existing git tags) |
Oh right, before we were self-hosting the docs on github, from a |
Unfortunately my project doesn't allow me to update sh, since it'll be installed as a part of our OS provisioning process. Even though the branch is deleted, it looks like you can pull it from the last PRs to that branch, so I've gone ahead and cloned this branch locally to get the documentation. This is theoretically the same as the last change to the gh-pages branch, assuming there were no changes done without PRs. If you merge this in as a branch (eg v1-docs), you could then setup readthedocs to host this prior version. |
Good sleuthing. Would you mind making a pull request for this please? |
I don't believe I have the permissions to create a pull request for this. Since this will need to be a new branch (since the old gh-pages branch has no common history at all with any of the code), it will need to be done with somebody with push permissions to this repo. Github does not allow people to open PRs to new branches (see https://stackoverflow.com/questions/9796370/github-pull-request-to-a-new-upstream-branch) |
Maybe it's easier to just add a note to the current docs if something is different in a 1.* version. There are some key changes but not much else. Could you explain what is out of date for you in the current docs that you need to reference the old docs for? |
The largest different for me & my team is the difference in return types from v1 to v2. We'll often do our local testing in a virtual environment (that will install the latest version of v2 by default), and then attempt to do something like putting the output of a sh Command into I might suggest moving the I would be happy to potentially work on this migration, though I am inexperienced with sphinx and readthedocs. |
Thanks for offering to work on improving the docs :) I like this idea better than trying to make the old docs work with readthedocs. Moving |
I am unfortunately still bound to using sh v1.14.2 due to reliance on the system-packaged version of sh on Red Hat-based systems. It would be significantly easier to navigate this older version if readthedocs had an old version of sh available. As of yet, my best solution has been using the internet archive to access this documentation, which is a slow and frustrating approach. The previous branch that this was hosted on doesn't seem to exist anymore.
The text was updated successfully, but these errors were encountered: