Skip to content

Commit

Permalink
adding doc contribution guidelines
Browse files Browse the repository at this point in the history
  • Loading branch information
rupesh2 committed Feb 21, 2024
1 parent c246a00 commit 4f7d516
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,28 @@ scripts/format.sh
> [earthdata-feedstock](https://github.com/conda-forge/earthdata-feedstock), as this
> project was renamed early in its life. The conda package is named `earthaccess`.
## Steps to make changes to documentation
1. Fork [earthaccess](https://github.com/nsidc/earthaccess) in the GitHub user interface to create your own copy. Later on, you may need to sync your fork with the upstream original repository. This can also be done in the GitHub UI or command line. If you get stuck, the emergency escape hatch is to take a fresh fork again! :)
2. Clone the repo: `git clone [email protected]:<yourusername>/earthaccess.git`
3. Change the directory: `cd earthaccess\binder`
4. Create conda environment: `conda env create -f environment-dev.yml`. If you see a warning that the environment already exists, do `conda env remove -n earthaccess-dev`
5. Activate conda: `conda activate earthaccess-dev`
6. Change to the base project directory. `cd ..`
7. Install packages : `pip install --editable .`
8. Run mkdocs script: `./scripts/docs-live.sh`
10. On your browser, go to: `https://0.0.0.0:8008`
11. You can now change any pages in the `docs` folder in your text editor, which will instantly reflect in the browser.
12. Commit the changes and push them to the forked repository:
```bash
git status # check git status to see what changed
git switch -c "test" # create a new branch
git add . # add changes
git commit -m "add commit messages" # commit changes
git push -u origin test # push changes
```
13. Open a pull request (PR) in the GitHub user interface from your fork to the original `nsidc/earthaccess` repo. When you ran `git push` in a previous step, it provided a convenient link to open that PR directly.
14. In the PR interface, you can view the progress of the GitHub Actions workflows specific to the PR at the bottom of the page.

---

## Code of Conduct
Expand Down

0 comments on commit 4f7d516

Please sign in to comment.