Skip to content
This repository was archived by the owner on May 21, 2024. It is now read-only.

Commit 334b310

Browse files
authored
Update contributing.md and docs links in readme (#384)
1 parent 752dfa5 commit 334b310

File tree

2 files changed

+7
-3
lines changed

2 files changed

+7
-3
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
Official Python Pachyderm client.
88

99
This library provides the autogenerated gRPC/protobuf code for Pachyderm, along with a higher-level and more pythonic `Client` class.
10-
See the [API docs](https://python-pachyderm.readthedocs.io/en/v7.x/).
10+
See the [API docs](https://python-pachyderm.readthedocs.io/en/v7.1.x/).
1111

1212
## Installation
1313

@@ -48,7 +48,7 @@ f = client.get_file(("my_repo", "my_branch"), "/path_to/my_data.csv")
4848
df = pd.read_csv(f)
4949
```
5050

51-
For more sophisticated examples, [see the examples directory](https://github.com/pachyderm/python-pachyderm/tree/v7.x/examples).
51+
For more sophisticated examples, [see the examples directory](https://github.com/pachyderm/python-pachyderm/tree/v7.1.x/examples).
5252

5353
## Versioning
5454

contributing.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -158,4 +158,8 @@ This is mostly necessary for major releases, but it always reduces risk.
158158
- This is the python-pachyderm version that is currently in development in that branch.
159159
- [ ] (Only when releasing from `master`) In `master`, create a PR to update the python-pachyderm version in `version.json` to contain the next _minor_ release (e.g. 1.1.0)
160160
- This is the python-pachyderm version that is currently in development in `master`.
161-
- [ ] (Only when releasing from `master`) In the new patch release branch (e.g. `v1.0.x`), create a PR (or add to the above PR) to update `make release` so that it checks out `v1.0.x` instead of `master` when releasing from this branch.
161+
- [ ] (Only when releasing from `master`) In the new patch release branch (e.g. `v1.0.x`):
162+
- Create a PR (or add to the above PR) to update `make release` and `make-test-release` so that it checks out `v1.0.x` instead of `master` when releasing from this branch.
163+
- Go to the python-pachyderm Read the Docs (RTD) page and activate the [newly created patch release branch](https://readthedocs.org/projects/python-pachyderm/versions/). This will serve up that branch's docs on RTD.
164+
- Update the docs link in `README.md` to point to the branch's RTD page.
165+
- Update the examples directory link to point to the `examples/` directory of that Github branch.

0 commit comments

Comments
 (0)