Skip to content

Commit

Permalink
Start contributing docs
Browse files Browse the repository at this point in the history
  • Loading branch information
maxrjones committed Jun 12, 2024
1 parent 98ecae4 commit 238b991
Show file tree
Hide file tree
Showing 3 changed files with 31 additions and 0 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -159,3 +159,4 @@ cython_debug/
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
#.idea/
virtualizarr/_version.py
docs/generated/
29 changes: 29 additions & 0 deletions docs/contributing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Contributing

## Contributing documentation

### Build the documentation locally

```bash
mamba env create -f ci/doc.yml
mamba activate docs
cd docs # From project's root
rm -rf generated
make clean
make html
```

### Access the documentation locally

Open `docs/_build/html/index.html` in a web browser

## Making a release

1. Navigate to the [https://github.com/zarr-developers/virtualizarr/releases](https://github.com/zarr-developers/virtualizarr/releases) release page.
2. Select draft a new release.
3. Select 'Choose a tag', then 'create a new tag'
4. Enter the name for the new tag following the [EffVer](https://jacobtomlinson.dev/effver/) versioning scheme (e.g., releasing v0.2.0 as the next release denotes that “some small effort may be required to make sure this version works for you”).
4. Click 'Generate Release Notes' to draft notes based on merged pull requests.
5. Edit the draft release notes for consistency.
6. Publish the release.
7. Navigate to the GitHub actions page and approve the deployment to run the PyPI release section in the `release` GitHub actions environment. This requires having privileges set in the [environment protection rules](https://github.com/zarr-developers/VirtualiZarr/settings/environments/3162544968/edit), which currently includes being part of the `virtualizarr-core-devs` GitHub team.
1 change: 1 addition & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,4 +83,5 @@ usage
faq
api
releases
contributing
```

0 comments on commit 238b991

Please sign in to comment.