-
Notifications
You must be signed in to change notification settings - Fork 164
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
docs: add contributor notes on where to find documentation branches #1113
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
open into dev
branch instead of main
but otherwise LGTM
.github/CONTRIBUTING.md
Outdated
@@ -106,3 +106,6 @@ the documentation. | |||
|
|||
## Updating Dependencies | |||
If you make changes to the `requirements` text files, please also update the `additional_dependencies` list under the `mypy` hook in `.pre-commit-config.yaml`. This is necessary for accurate type-checking. | |||
|
|||
## Contributing Documentation Changes and Fixes | |||
Please see the `gh-pages` and `dev-gh-pages` branches for all documentation. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Technically a PR for updating the documentation should only go into dev-gh-pages
-- and when we do a release a PR will be opened to gh-pages
. Follow-up clarity worthwhile for this new section
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good idea on clarification, see 5e36e17
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
looking good @carlsonp
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM -- small comment for follow-up PR. Thanks for the contribution @carlsonp
Head branch was pushed to by a user without write access
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
slightly nuance clarification
Seeing a test error: |
@carlsonp you should be good to rebase onto |
…d `gh-pages` branches exist for staging content
Co-authored-by: Taylor Turner <taylorfturner@gmail.com>
6fb1f3e
to
8d3d8a2
Compare
Rebased |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
slight update @carlsonp
Head branch was pushed to by a user without write access
Co-authored-by: Taylor Turner <taylorfturner@gmail.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
…apitalone#1113) * docs: add contributor notes on where to find documentation branches * docs: update documentation wording to spell out why `dev-gh-pages` and `gh-pages` branches exist for staging content * docs: add note on fork Co-authored-by: Taylor Turner <taylorfturner@gmail.com> * Update .github/CONTRIBUTING.md Co-authored-by: Taylor Turner <taylorfturner@gmail.com> --------- Co-authored-by: Taylor Turner <taylorfturner@gmail.com>
* Replace snappy with cramjam (#1091) * add downloads tile (#1085) * Replace snappy with cramjam * Delete test_no_snappy --------- Co-authored-by: Taylor Turner <taylorfturner@gmail.com> * Quick fix for dependency max pins (#1120) * Fix dask_expr * Keras and Tensorflow version fix * Keras and Tensorflow version fix * Fix keras bug * pre-commit fix (#1122) * docs: update test link to latest version (#1114) * docs: add contributor notes on where to find documentation branches (#1113) * docs: add contributor notes on where to find documentation branches * docs: update documentation wording to spell out why `dev-gh-pages` and `gh-pages` branches exist for staging content * docs: add note on fork Co-authored-by: Taylor Turner <taylorfturner@gmail.com> * Update .github/CONTRIBUTING.md Co-authored-by: Taylor Turner <taylorfturner@gmail.com> --------- Co-authored-by: Taylor Turner <taylorfturner@gmail.com> * update black version (#1131) * Add memray max version (#1132) * Bug fix for float precision calculation using categorical data with trailing zeros. (#1125) * Revert "Bug fix for float precision calculation using categorical data with t…" (#1133) This reverts commit d3159bd. * fix * make up to date * yep, shouldn't change * bump version --------- Co-authored-by: Gábor Lipták <gliptak@gmail.com> Co-authored-by: abajpai15 <73404357+abajpai15@users.noreply.github.com> Co-authored-by: Patrick Carlson <carlson2442@gmail.com> Co-authored-by: James Schadt <jamesrschadt@gmail.com>
No description provided.