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

[FEA] create a formal process for updating the github-pages branch #471

Closed
revans2 opened this issue Jul 30, 2020 · 1 comment
Closed

[FEA] create a formal process for updating the github-pages branch #471

revans2 opened this issue Jul 30, 2020 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation feature request New feature or request

Comments

@revans2
Copy link
Collaborator

revans2 commented Jul 30, 2020

Right now we have docs in the release branch and docs in the github-pages branch. We don't really have any separation between docs that are associated with a release and docs that are general. This can lead to issues like here

#467 (comment)

where we try to update general documentation and end up updating release specific information.

We need a formal split between the docs, or we need a good process in place to avoid this in the future.

@revans2 revans2 added feature request New feature or request ? - Needs Triage Need team to review and classify labels Jul 30, 2020
@sameerz sameerz added documentation Improvements or additions to documentation and removed ? - Needs Triage Need team to review and classify labels Jul 31, 2020
@sameerz sameerz self-assigned this Aug 4, 2020
@revans2
Copy link
Collaborator Author

revans2 commented Aug 4, 2020

We discussed this and for now only a hot fix can go into gh-pages directly and in parallel go into the current development branch. In all other cases the changes should only go into the current development branch, and it will be merged into gh-pages as a part of the release.

At some point when we are supporting more then one release at a time we can look at how to have version specific docs in gh-pages.

@revans2 revans2 closed this as completed Aug 4, 2020
@jlowe jlowe changed the title [FEA] create a formal process for updateing the github-pages branch [FEA] create a formal process for updating the github-pages branch Sep 14, 2020
pxLi pushed a commit to pxLi/spark-rapids that referenced this issue May 12, 2022
tgravescs pushed a commit to tgravescs/spark-rapids that referenced this issue Nov 30, 2023
Signed-off-by: spark-rapids automation <70000568+nvauto@users.noreply.github.com>
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 feature request New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants