Skip to content
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

Convert top-level docs to myst on stable branch #172

Merged
merged 10 commits into from
Nov 21, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 32 additions & 0 deletions AUTHORS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Credits

## Project Coordinators

- [Eric Hutton](https://github.com/mcflugen)
- [Mark Piper](https://github.com/mdpiper)

## Contributors

- Richard Barnes
- Ibrahim Demir
- Greg Ewing
- Michael Galloy
- Sam Harrison
- Julian Hofer
- Rolf Hut
- Eric Hutton
- Allen Lee
- Eric Morway
- Boyana Norris
- Scott Peckham
- Mark Piper
- Carlos Erazo Ramirez
- Mike Taves
- Greg Tucker
- Ashani Vaidya
- Martijn Visser
- Ben van Werkhoven

If you have contributed to the BMI project and your name is missing,
please send an email to the coordinators, or open a pull request
for this page in the [BMI repository](https://github.com/csdms/bmi).
35 changes: 0 additions & 35 deletions AUTHORS.rst

This file was deleted.

5 changes: 3 additions & 2 deletions CITATION.rst → CITATION.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
Citation
========
# Citation

If you use the Basic Model Interface for work/research
presented in a publication, we ask that you please cite:

```{eval-rst}
.. tab-set::

.. tab-item:: APA
Expand Down Expand Up @@ -50,3 +50,4 @@ presented in a publication, we ask that you please cite:
},
journal={Journal of Open Source Software}
}
```
49 changes: 21 additions & 28 deletions CODE-OF-CONDUCT.rst → CODE-OF-CONDUCT.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
Contributor Covenant Code of Conduct
====================================
# Contributor Covenant Code of Conduct

Our Pledge
----------
## Our Pledge

In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to making participation in our project and
Expand All @@ -11,31 +9,29 @@ size, disability, ethnicity, sex characteristics, gender identity and expression
level of experience, education, socio-economic status, nationality, personal
appearance, race, religion, or sexual identity and orientation.

Our Standards
-------------
## Our Standards

Examples of behavior that contributes to creating a positive environment
include:

* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members
- Using welcoming and inclusive language
- Being respectful of differing viewpoints and experiences
- Gracefully accepting constructive criticism
- Focusing on what is best for the community
- Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

* The use of sexualized language or imagery and unwelcome sexual attention or
- The use of sexualized language or imagery and unwelcome sexual attention or
advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic
- Trolling, insulting/derogatory comments, and personal or political attacks
- Public or private harassment
- Publishing others' private information, such as a physical or electronic
address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a
- Other conduct which could reasonably be considered inappropriate in a
professional setting

Our Responsibilities
--------------------
## Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable
behavior and are expected to take appropriate and fair corrective action in
Expand All @@ -47,8 +43,7 @@ that are not aligned to this Code of Conduct, or to ban temporarily or
permanently any contributor for other behaviors that they deem inappropriate,
threatening, offensive, or harmful.

Scope
-----
## Scope

This Code of Conduct applies within all project spaces, and it also applies when
an individual is representing the project or its community in public spaces.
Expand All @@ -57,11 +52,10 @@ project e-mail address, posting via an official social media account, or acting
as an appointed representative at an online or offline event. Representation of
a project may be further defined and clarified by project maintainers.

Enforcement
-----------
## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team at [email protected]. All
reported by contacting the project team at <mailto:[email protected]>. All
complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. The project team is
obligated to maintain confidentiality with regard to the reporter of an incident.
Expand All @@ -71,13 +65,12 @@ Project maintainers who do not follow or enforce the Code of Conduct in good
faith may face temporary or permanent repercussions as determined by other
members of the project's leadership.

Attribution
-----------
## Attribution

This Code of Conduct is adapted from the
`Contributor Covenant <https://www.contributor-covenant.org>`_, version 1.4,
[Contributor Covenant](https://www.contributor-covenant.org), version 1.4,
available at
`<https://www.contributor-covenant.org/version/1/4/code-of-conduct.html>`_.
[https://www.contributor-covenant.org/version/1/4/code-of-conduct.html](https://www.contributor-covenant.org/version/1/4/code-of-conduct.html).

For answers to common questions about this code of conduct, see
`<https://www.contributor-covenant.org/faq>`_.
[https://www.contributor-covenant.org/faq](https://www.contributor-covenant.org/faq).
21 changes: 0 additions & 21 deletions LICENSE

This file was deleted.

20 changes: 20 additions & 0 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# The MIT License (MIT)

Copyright (c) `2014` `Community Surface Dynamics Modeling System`

Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
the Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
149 changes: 0 additions & 149 deletions README.rst

This file was deleted.

5 changes: 2 additions & 3 deletions docs/source/citation.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,2 @@
```{eval-rst}
.. include:: ../../CITATION.rst
```
:::{include} ../../CITATION.md
:::
5 changes: 2 additions & 3 deletions docs/source/conduct.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,2 @@
```{eval-rst}
.. include:: ../../CODE-OF-CONDUCT.rst
```
:::{include} ../../CODE-OF-CONDUCT.md
:::
5 changes: 2 additions & 3 deletions docs/source/credits.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,2 @@
```{eval-rst}
.. include:: ../../AUTHORS.rst
```
:::{include} ../../AUTHORS.md
:::
Loading
Loading