Repository navigation
Consider moving docs from gh-pages branch back to ./docs folder #902
Description
Investigate whether we should move the docs tree from the gh-pages branch back to the main branches under ./docs.
Benefits to doing this:
- Simplify changes by including both code and doc changes in the same PR (rather than two separate ones).
- Simplify releases because when the code changes are merged from
developmenttomain, the doc changes will come along as well. In the past we had some doc PRs which specifically we had to hold merging until the release had happened.
I'm not aware of any reasons to not do this (i.e. no downside). @vogelsgesang volunteered to help with this if we decide to do it.
@jacalata @t8y8 @dzucker-tab can you weigh in here with any notes from the past? I see some older changes where we moved from ./docs to gh-pages and I'm not sure the reasoning. Perhaps at the time, GitHub Pages required the separate branch.
Activity
t8y8 commentedon Sep 24, 2021
I think it allowed us to rev docs independently of releases or something like that? I don't remember the exact reason why we did it. Maybe there were merge conflicts?
I don't have a strong opinion -- either format works for me as long as the docs build pipeline is happy.
bcantoni commentedon Sep 24, 2021
Ahh that's a great point. I was focusing just on the Code+Docs combo pull requests.
If we do make this change, the steps for a Docs-only change would be slightly more work:
developmentbranchdevelopmenttomainto make the changes liveLooking at recent history on
gh-pages(https://github.com/tableau/server-client-python/commits/gh-pages) it's definitely a mix of Docs-only and Docs to match code changes. The former are usually pretty lightweight so doing the cherry-pick wouldn't be too hard.jacalata commentedon Sep 20, 2024
will keep the newer item open to track this.