Skip to content

Commit

Permalink
Merge pull request #592 from jhkennedy/fix-docs-coc-591
Browse files Browse the repository at this point in the history
Add code of conduct and redirects to our docs
  • Loading branch information
jhkennedy authored Jun 12, 2024
2 parents 57c55d9 + 5f80ffb commit 9026706
Show file tree
Hide file tree
Showing 6 changed files with 498 additions and 494 deletions.
1 change: 1 addition & 0 deletions ci/environment-dev.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ dependencies:
- mkdocs>=1.2
- mkdocs-material>=7.1,<9.0
- markdown-include>=0.6
- mkdocs-redirects>=1.2.1
- mkdocstrings>=0.19.0
- mkdocstrings-python
- mkdocs-jupyter>=0.19.0
Expand Down
1 change: 1 addition & 0 deletions docs/contributing/code-of-conduct.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
--8<-- "CODE_OF_CONDUCT.md"
2 changes: 1 addition & 1 deletion docs/contributing/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ with the community and maintainers via
[a GitHub Discussion](https://github.com/nsidc/earthaccess/discussions),
or [any other method](our-meet-ups.md).

Please note that we have a [code of conduct](/CODE_OF_CONDUCT.md). Please follow it in all of your interactions with the project.
Please note that we have a [code of conduct](./code-of-conduct.md). Please follow it in all of your interactions with the project.

## First Steps to contribute

Expand Down
5 changes: 5 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,10 @@ plugins:
rendering:
show_root_heading: false
show_source: false
- redirects:
redirect_maps:
'CODE_OF_CONDUCT.md': 'contributing/code-of-conduct.md'
'CODE_OF_CONDUCT.md.md': 'contributing/code-of-conduct.md'
- mkdocs-jupyter:
execute: True
ignore:
Expand All @@ -60,6 +64,7 @@ nav:
- "Development": "contributing/development.md"
- "Releasing": "contributing/releasing.md"
- "Our meet-ups": "contributing/our-meet-ups.md"
- "Code of Conduct": "contributing/code-of-conduct.md"
- "Resources": "resources.md"
- USER GUIDE:
- "user_guide/index.md"
Expand Down
Loading

0 comments on commit 9026706

Please sign in to comment.