-
Notifications
You must be signed in to change notification settings - Fork 13
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
versioning online documentation #187
Comments
The "update-doc" branch is for updating the online doc. The online doc should be stable between releases. Use the "update-doc" branch to update doc explicitly. Do not update online doc each time there is a commit on "main" branch. It may cause the online doc out of sync with the official release. |
This should be done before next release. |
Checked in doc files for v1.2.0 93d7ed5 |
Checked in doc files for v1.0.0 v1.1.0 v1.3.0 dev-doc URLs https://gplates.github.io/gplately/v1.1.0/ |
redirect the doc root to the latest official release doc The latest official doc should be consistent with the latest offical release. Redirect the online doc root to the latest offical release 1.3.0. |
Basically, the work is done. Keep this issue open for another 3 days just in case something happens. https://gplates.github.io/gplately/ |
See comments above |
The official online documentation should be compatible with each official release. I suggest that we create online documentation for each release and also create"dev doc" for the product in development. The screenshot below is what NumPy does. Maybe we should do the same. Some customers might not want to wait for the official doc to come out.
The text was updated successfully, but these errors were encountered: