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.

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

Closed
michaelchin opened this issue Jun 6, 2024 · 7 comments
Closed

versioning online documentation #187

michaelchin opened this issue Jun 6, 2024 · 7 comments
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request medium
Milestone

Comments

@michaelchin
Copy link
Contributor

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.

Screenshot 2024-06-06 at 10 00 01 AM
@michaelchin michaelchin added documentation Improvements or additions to documentation low suggestion ideas to discuss labels Jun 6, 2024
@michaelchin
Copy link
Contributor Author

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.

@michaelchin
Copy link
Contributor Author

This should be done before next release.

@michaelchin michaelchin added enhancement New feature or request medium and removed low suggestion ideas to discuss labels Jun 24, 2024
@michaelchin michaelchin self-assigned this Jun 24, 2024
@michaelchin michaelchin pinned this issue Jun 24, 2024
@michaelchin
Copy link
Contributor Author

michaelchin commented Jun 24, 2024

Checked in doc files for v1.2.0 93d7ed5
URL for the doc https://gplates.github.io/gplately/v1.2.0/

@michaelchin
Copy link
Contributor Author

@michaelchin
Copy link
Contributor Author

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.

faa4e41

@michaelchin
Copy link
Contributor Author

@michaelchin
Copy link
Contributor Author

See comments above

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request medium
Projects
None yet
Development

No branches or pull requests

1 participant