From 50b779003b0ccddfef911d49302aff72c27ccc9d Mon Sep 17 00:00:00 2001 From: Travis Thurber Date: Mon, 8 Jan 2024 11:29:46 -0800 Subject: [PATCH 01/16] dev site workflow --- .github/workflows/01_test.yml | 2 +- .github/workflows/02_deploy.yml | 5 +- .github/workflows/03_dev_deploy.yml | 91 +++++++++++++++++++++++++++++ Dockerfile_dev | 13 +++++ docs/source/conf.py | 20 ++++--- landing/svelte.config.js | 2 +- 6 files changed, 122 insertions(+), 11 deletions(-) create mode 100644 .github/workflows/03_dev_deploy.yml create mode 100644 Dockerfile_dev diff --git a/.github/workflows/01_test.yml b/.github/workflows/01_test.yml index 8ad03d6..449df47 100644 --- a/.github/workflows/01_test.yml +++ b/.github/workflows/01_test.yml @@ -2,7 +2,7 @@ name: Build on: push: - branches: [ main ] + branches: [ main, feature/dev-site ] jobs: build: diff --git a/.github/workflows/02_deploy.yml b/.github/workflows/02_deploy.yml index 306be26..c0015fc 100644 --- a/.github/workflows/02_deploy.yml +++ b/.github/workflows/02_deploy.yml @@ -76,7 +76,10 @@ jobs: run: npm run build - name: Commit documentation changes run: | - cd landing/build + git clone --depth=1 --branch=gh-pages https://github.com/IMMM-SFA/msd_uncertainty_ebook.git previous_deploy + mkdir ./landing/build/dev + cp -r ./previous_deploy/dev/* ./landing/build/dev/ + cd ./landing/build git init git add -A git config --local user.email "action@github.com" diff --git a/.github/workflows/03_dev_deploy.yml b/.github/workflows/03_dev_deploy.yml new file mode 100644 index 0000000..55f9473 --- /dev/null +++ b/.github/workflows/03_dev_deploy.yml @@ -0,0 +1,91 @@ +name: Deploy + +on: + push: + branches: [ feature/dev-site ] + +jobs: + build: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + - uses: actions/setup-python@v2 + with: + python-version: '3.9' + - name: Install latex dependencies + run: sudo apt-get update -y && sudo apt-get install -y texlive latexmk texlive-latex-recommended texlive-latex-extra texlive-fonts-recommended ghostscript + - name: Update pip and install python dependencies + working-directory: 'docs/' + run: | + python -m pip install --upgrade pip + pip install -r requirements.txt + - name: Build html and pdf ebook + working-directory: 'docs/' + env: + NODE_ENV: development + run: | + make html latexpdf --keep-going LATEXMKOPTS="-interaction=nonstopmode" || true + make latexpdf --keep-going LATEXMKOPTS="-interaction=nonstopmode" || true + make latexpdf --keep-going LATEXMKOPTS="-interaction=nonstopmode" || true + continue-on-error: true + - name: Concatenate eBook cover with eBook + run: | + mv docs/build/latex/addressinguncertaintyinmultisectordynamicsresearch.pdf docs/build/latex/ebook_content.pdf + gs -dNOPAUSE -sDEVICE=pdfwrite -sOUTPUTFILE=docs/build/latex/addressinguncertaintyinmultisectordynamicsresearch.pdf -dBATCH docs/ebook_cover.pdf docs/build/latex/ebook_content.pdf + - uses: actions/setup-node@v2 + with: + node-version: '16' + cache: 'npm' + cache-dependency-path: landing/package-lock.json + - uses: jakejarvis/s3-sync-action@master + with: + args: --delete + env: + SOURCE_DIR: 'notebooks' + DEST_DIR: 'notebooks' + AWS_S3_BUCKET: ${{ secrets.AWS_S3_BUCKET_DEV }} + AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID_DEV }} + AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY_DEV }} + AWS_REGION: ${{ secrets.AWS_REGION_DEV }} + - name: Log in to Docker Hub + uses: docker/login-action@f054a8b539a109f9f41c372932f1ae047eff08c9 + with: + username: ${{ secrets.DOCKER_USERNAME }} + password: ${{ secrets.DOCKER_PASSWORD }} + - name: Build and push Docker image + uses: docker/build-push-action@ad44023a93711e3deb337508980b4b5e9bcdc5dc + with: + context: . + file: Dockerfile_dev + push: true + tags: thurber/uc-ebook.org:dev + - name: Install landing page dependencies + working-directory: 'landing/' + run: npm install + - name: Build landing page + working-directory: 'landing/' + env: + NODE_ENV: development + VITE_PDF_URL: https://uc-ebook.org/dev/images/addressinguncertaintyinmultisectordynamicsresearch.pdf + run: npm run build + - name: Commit documentation changes + run: | + git clone --depth=1 --branch=gh-pages https://github.com/IMMM-SFA/msd_uncertainty_ebook.git deploy + rm -rf ./deploy/.git + rm -rf ./deploy/dev + mkdir ./deploy/dev + cp -r ./landing/build/* ./deploy/dev/ + cp ./docs/build/latex/addressinguncertaintyinmultisectordynamicsresearch.pdf ./deploy/dev/images/ + cd ./deploy + git init + git add -A + git config --local user.email "action@github.com" + git config --local user.name "GitHub Action" + git commit -m 'deploy' -a || true + - name: Push changes to gh-pages + uses: ad-m/github-push-action@master + with: + branch: gh-pages-test + directory: deploy + force: true + github_token: ${{ secrets.GITHUB_TOKEN }} \ No newline at end of file diff --git a/Dockerfile_dev b/Dockerfile_dev new file mode 100644 index 0000000..b0170df --- /dev/null +++ b/Dockerfile_dev @@ -0,0 +1,13 @@ +FROM jupyter/minimal-notebook:2022-05-03 + +USER root + +RUN git clone --depth=1 --branch=feature/dev-site https://github.com/IMMM-SFA/msd_uncertainty_ebook.git msd_uncertainty_ebook +RUN cd msd_uncertainty_ebook && pip install . + +# Now create a symlinked data folder inside the msdbook package that links to /home/demo/data folder +RUN mkdir -p /home/demo/data +RUN rm -rf /opt/conda/lib/python3.9/site-packages/msdbook/data +RUN ln -s /home/demo/data /opt/conda/lib/python3.9/site-packages/msdbook/data + + diff --git a/docs/source/conf.py b/docs/source/conf.py index 11f227f..8429aac 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -17,19 +17,23 @@ sys.path.insert(0, os.path.abspath('../../')) sys.path.append(os.path.abspath("../../extensions")) +# if this is a dev build, the paths need to be adjusted +dev_web = '/dev' if ('NODE_ENV' in os.environ and os.environ['NODE_ENV'] == 'development') else '' +dev_nb = '.dev' if ('NODE_ENV' in os.environ and os.environ['NODE_ENV'] == 'development') else '' + # current datetime to use as the version today = f"Last updated: {datetime.utcnow().strftime('%b %d, %Y')}" # -- Notebook URLs ----------------------------------------------------------- -rst_prolog = """ -.. _nb_logistic_regression: https://uc-ebook.msdlive.org/user-redirect/lab/tree/notebooks/basin_users_logistic_regression.ipynb -.. _nb_saltelli_sobol: https://uc-ebook.msdlive.org/user-redirect/lab/tree/notebooks/sa_saltelli_sobol_ishigami.ipynb -.. _nb_hymod: https://uc-ebook.msdlive.org/user-redirect/lab/tree/notebooks/hymod.ipynb -.. _nb_fishery_dynamics: https://uc-ebook.msdlive.org/user-redirect/lab/tree/notebooks/fishery_dynamics.ipynb -.. _nb_discovery: https://uc-ebook.msdlive.org/user-redirect/lab/tree/notebooks/Bedford_Greene_SD_tutorial.ipynb -.. _nb_hmm: https://uc-ebook.msdlive.org/user-redirect/lab/tree/notebooks/Hidden-Markov_Modeling_Approaches_to_Creating_Synthetic_Streamflow_Scenarios.ipynb +rst_prolog = f""" +.. _nb_logistic_regression: https://uc-ebook{dev_nb}.msdlive.org/user-redirect/lab/tree/notebooks/basin_users_logistic_regression.ipynb +.. _nb_saltelli_sobol: https://uc-ebook{dev_nb}.msdlive.org/user-redirect/lab/tree/notebooks/sa_saltelli_sobol_ishigami.ipynb +.. _nb_hymod: https://uc-ebook{dev_nb}.msdlive.org/user-redirect/lab/tree/notebooks/hymod.ipynb +.. _nb_fishery_dynamics: https://uc-ebook{dev_nb}.msdlive.org/user-redirect/lab/tree/notebooks/fishery_dynamics.ipynb +.. _nb_discovery: https://uc-ebook{dev_nb}.msdlive.org/user-redirect/lab/tree/notebooks/Bedford_Greene_SD_tutorial.ipynb +.. _nb_hmm: https://uc-ebook{dev_nb}.msdlive.org/user-redirect/lab/tree/notebooks/Hidden-Markov_Modeling_Approaches_to_Creating_Synthetic_Streamflow_Scenarios.ipynb """ @@ -88,7 +92,7 @@ # theme options html_theme_options = { - 'path_to_docs': '/docs', + 'path_to_docs': f'{dev_web}/docs', 'repository_url': 'https://github.com/IMMM-SFA/msd_uncertainty_ebook', 'use_issues_button': True, 'use_download_button': True, diff --git a/landing/svelte.config.js b/landing/svelte.config.js index e937ee9..b3cf6af 100644 --- a/landing/svelte.config.js +++ b/landing/svelte.config.js @@ -13,7 +13,7 @@ const config = { assets: 'build' }), paths: { - base: '' + base: process.env.NODE_ENV === 'development' ? '/dev' : '' } } }; From 00e7befa4c9422781a3387b0bcd7c8b4497b7948 Mon Sep 17 00:00:00 2001 From: Travis Thurber Date: Mon, 8 Jan 2024 14:03:29 -0800 Subject: [PATCH 02/16] apply action to dev branch --- .github/workflows/01_test.yml | 2 +- .github/workflows/03_dev_deploy.yml | 8 +++----- 2 files changed, 4 insertions(+), 6 deletions(-) diff --git a/.github/workflows/01_test.yml b/.github/workflows/01_test.yml index 449df47..294ebbf 100644 --- a/.github/workflows/01_test.yml +++ b/.github/workflows/01_test.yml @@ -2,7 +2,7 @@ name: Build on: push: - branches: [ main, feature/dev-site ] + branches: [ main, dev ] jobs: build: diff --git a/.github/workflows/03_dev_deploy.yml b/.github/workflows/03_dev_deploy.yml index 55f9473..98b283d 100644 --- a/.github/workflows/03_dev_deploy.yml +++ b/.github/workflows/03_dev_deploy.yml @@ -1,8 +1,8 @@ -name: Deploy +name: Deploy Dev on: push: - branches: [ feature/dev-site ] + branches: [ dev ] jobs: build: @@ -66,7 +66,6 @@ jobs: working-directory: 'landing/' env: NODE_ENV: development - VITE_PDF_URL: https://uc-ebook.org/dev/images/addressinguncertaintyinmultisectordynamicsresearch.pdf run: npm run build - name: Commit documentation changes run: | @@ -75,7 +74,6 @@ jobs: rm -rf ./deploy/dev mkdir ./deploy/dev cp -r ./landing/build/* ./deploy/dev/ - cp ./docs/build/latex/addressinguncertaintyinmultisectordynamicsresearch.pdf ./deploy/dev/images/ cd ./deploy git init git add -A @@ -85,7 +83,7 @@ jobs: - name: Push changes to gh-pages uses: ad-m/github-push-action@master with: - branch: gh-pages-test + branch: gh-pages directory: deploy force: true github_token: ${{ secrets.GITHUB_TOKEN }} \ No newline at end of file From 256fed38c87b208eeb0d1f879f12857a537c8b10 Mon Sep 17 00:00:00 2001 From: crvernon Date: Wed, 10 Jan 2024 11:44:08 -0500 Subject: [PATCH 03/16] update branch target in dev dockerfile --- Dockerfile_dev | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Dockerfile_dev b/Dockerfile_dev index b0170df..70fe836 100644 --- a/Dockerfile_dev +++ b/Dockerfile_dev @@ -2,7 +2,7 @@ FROM jupyter/minimal-notebook:2022-05-03 USER root -RUN git clone --depth=1 --branch=feature/dev-site https://github.com/IMMM-SFA/msd_uncertainty_ebook.git msd_uncertainty_ebook +RUN git clone --depth=1 --branch=dev https://github.com/IMMM-SFA/msd_uncertainty_ebook.git msd_uncertainty_ebook RUN cd msd_uncertainty_ebook && pip install . # Now create a symlinked data folder inside the msdbook package that links to /home/demo/data folder From d864d267bb7a6bee8b45933c2f99280ff28d8902 Mon Sep 17 00:00:00 2001 From: crvernon Date: Mon, 5 Feb 2024 08:36:08 -0500 Subject: [PATCH 04/16] contribution proposal issue template --- .../ISSUE_TEMPLATE/contribution_proposal.yml | 72 +++++++++++++++++++ 1 file changed, 72 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/contribution_proposal.yml diff --git a/.github/ISSUE_TEMPLATE/contribution_proposal.yml b/.github/ISSUE_TEMPLATE/contribution_proposal.yml new file mode 100644 index 0000000..31f6a32 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/contribution_proposal.yml @@ -0,0 +1,72 @@ +name: Contribution Proposal +description: + Want to contribute to our eBook? Fill the following proposal form and we will review your contribution idea shortly. +labels: ["needs triage"] + +body: + - type: markdown + attributes: + value: | + ## Please fill out the form completly + **NOTE**: We require that all contributions including any code, data, or other content provided with them be fully open source. + + - type: textarea + id: issue-name + attributes: + label: Name + description: Please provide your name + validations: + required: true + + - type: textarea + id: issue-email + attributes: + label: Email + description: Please provide your email address + validations: + required: true + + - type: textarea + id: issue-institution + attributes: + label: Institution + description: Please provide your institution + validations: + required: true + + - type: textarea + id: issue-source + attributes: + label: Referral + description: How did you hear about the eBook? + validations: + required: true + + - type: dropdown + id: issue-category + attributes: + label: Topic Area + description: Select the part of the eBook you are hoping to contribute to. + options: + - General + - Sensitivity Analysis + - Uncertainty Quantification + - Jupyter Notebook + validations: + required: true + + - type: textarea + id: issue-description + attributes: + label: Description + description: Please provide a detailed description of the content you wish to contribute. + validations: + required: true + + - type: textarea + id: reproduction-info + attributes: + label: Additional Information + description: Please provide any additional information you want to share. + validations: + required: true \ No newline at end of file From 551ab92a4b14c9a24226b1ec13aba80c0c906a22 Mon Sep 17 00:00:00 2001 From: crvernon Date: Mon, 5 Feb 2024 08:36:33 -0500 Subject: [PATCH 05/16] contribution pr --- .../contribution_checklist.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 .github/PULL_REQUEST_TEMPLATE/contribution_checklist.md diff --git a/.github/PULL_REQUEST_TEMPLATE/contribution_checklist.md b/.github/PULL_REQUEST_TEMPLATE/contribution_checklist.md new file mode 100644 index 0000000..d3cfcab --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/contribution_checklist.md @@ -0,0 +1,17 @@ +## Tutorial Contribution +We require that all contributions including any code, data, or other content provided with them be fully open source. + +## Contribution Issue Link +Please reference the link to your approved contribution issue here: # (issue) + +## Checklist +Please ensure that you are able to check all of the following boxes before submission +- [ ] My contribution proposal has been approved +- [ ] I have read the contributing guidelines +- [ ] My code follows the style guidelines of this project +- [ ] I have performed a self-review of my own code +- [ ] I have commented my code, particularly in hard-to-understand areas +- [ ] I have made corresponding changes to the documentation +- [ ] My code is fully open source and can be distributed using the [BSD-2-Clause](https://opensource.org/license/bsd-2-clause/) license + +## Additional information \ No newline at end of file From 29a79170ca865a723672859a8cb49c6bc2c59bc9 Mon Sep 17 00:00:00 2001 From: crvernon Date: Mon, 5 Feb 2024 09:39:51 -0500 Subject: [PATCH 06/16] code of conduct --- CODE_OF_CONDUCT.md | 133 ++++++++++++++++++++++++++++++++ docs/source/code_of_conduct.rst | 133 ++++++++++++++++++++++++++++++++ docs/source/index.rst | 1 + 3 files changed, 267 insertions(+) create mode 100644 CODE_OF_CONDUCT.md create mode 100644 docs/source/code_of_conduct.rst diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..1e1beca --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,133 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +We as members, contributors, and leaders pledge to make participation in our +community a harassment-free experience for everyone, regardless of age, body +size, visible or invisible 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. + +We pledge to act and interact in ways that contribute to an open, welcoming, +diverse, inclusive, and healthy community. + +## Our Standards + +Examples of behavior that contributes to a positive environment for our +community include: + +* Demonstrating empathy and kindness toward other people +* Being respectful of differing opinions, viewpoints, and experiences +* Giving and gracefully accepting constructive feedback +* Accepting responsibility and apologizing to those affected by our mistakes, +and learning from the experience +* Focusing on what is best not just for us as individuals, but for the overall +community + +Examples of unacceptable behavior include: + +* The use of sexualized language or imagery, and sexual attention or +advances of any kind +* Trolling, insulting or derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or email +address, without their explicit permission +* Other conduct which could reasonably be considered inappropriate in a +professional setting + +## Enforcement Responsibilities + +Community leaders are responsible for clarifying and enforcing our standards +of acceptable behavior and will take appropriate and fair corrective action in +response to any behavior that they deem inappropriate, threatening, offensive, +or harmful. + +Community leaders have the right and responsibility to remove, edit, or reject +comments, commits, code, wiki edits, issues, and other contributions that are +not aligned to this Code of Conduct, and will communicate reasons for moderation +decisions when appropriate. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies +when an individual is officially representing the community in public spaces. +Examples of representing our community include using an official e-mail +address, posting via an official social media account, or acting as an appointed +representative at an online or offline event. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported to [Chris Vernon](mailto:chris.vernon@pnnl.gov) +and/or [Travis Thurber](mailto:travis.thurber@pnnl.gov). +All complaints will be reviewed and investigated promptly and fairly. + +Community leaders are obligated to respect the privacy and security of the +reporter of any incident. + +This code of conduct, including the consequences laid out below, applies equally +to the community leaders, of course. Any temporary or permanent ban will result +in the person in question being removed from the leadership. + +## Enforcement Guidelines + +Community leaders will follow these Community Impact Guidelines in determining +the consequences for any action they deem in violation of this Code of Conduct: + +### 1. Correction + +**Community Impact**: Use of inappropriate language or other behavior deemed +unprofessional or unwelcome in the community. + +**Consequence**: A private, written warning from community leaders, providing +clarity around the nature of the violation and an explanation of why the +behavior was inappropriate. A public apology may be requested. + +### 2. Warning + +**Community Impact**: A violation through a single incident or series of +actions. + +**Consequence**: A warning with consequences for continued behavior. No +interaction with the people involved, including unsolicited interaction with +those enforcing the Code of Conduct, for a specified period of time. This +includes avoiding interactions in community spaces as well as external channels +like social media. Violating these terms may lead to a temporary or permanent +ban. + +### 3. Temporary Ban + +**Community Impact**: A serious violation of community standards, including +sustained inappropriate behavior. + +**Consequence**: A temporary ban from any sort of interaction or public +communication with the community for a specified period of time. No public or +private interaction with the people involved, including unsolicited interaction +with those enforcing the Code of Conduct, is allowed during this period. +Violating these terms may lead to a permanent ban. + +### 4. Permanent Ban + +**Community Impact**: Demonstrating a pattern of violation of community +standards, including sustained inappropriate behavior, harassment of an +individual, or aggression toward or disparagement of classes of individuals. + +**Consequence**: A permanent ban from any sort of public interaction within the +community. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], +version 2.0, +available at https://www.contributor-covenant.org/version/2/0/ +code_of_conduct.html. + +Community Impact Guidelines were inspired by [Mozilla's code of conduct +enforcement ladder](https://github.com/mozilla/diversity). + +[homepage]: https://www.contributor-covenant.org + +For answers to common questions about this code of conduct, see the FAQ at +https://www.contributor-covenant.org/faq. Translations are available at https:// +www.contributor-covenant.org/translations. \ No newline at end of file diff --git a/docs/source/code_of_conduct.rst b/docs/source/code_of_conduct.rst new file mode 100644 index 0000000..2320629 --- /dev/null +++ b/docs/source/code_of_conduct.rst @@ -0,0 +1,133 @@ +Contributor Covenant Code of Conduct +==================================== + +Our Pledge +---------- + +We as members, contributors, and leaders pledge to make participation in our +community a harassment-free experience for everyone, regardless of age, body +size, visible or invisible 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. + +We pledge to act and interact in ways that contribute to an open, welcoming, +diverse, inclusive, and healthy community. + +Our Standards +------------- + +Examples of behavior that contributes to a positive environment for our +community include: + +- Demonstrating empathy and kindness toward other people +- Being respectful of differing opinions, viewpoints, and experiences +- Giving and gracefully accepting constructive feedback +- Accepting responsibility and apologizing to those affected by our mistakes, + and learning from the experience +- Focusing on what is best not just for us as individuals, but for the overall + community + +Examples of unacceptable behavior include: + +- The use of sexualized language or imagery, and sexual attention or + advances of any kind +- Trolling, insulting or derogatory comments, and personal or political attacks +- Public or private harassment +- Publishing others' private information, such as a physical or email + address, without their explicit permission +- Other conduct which could reasonably be considered inappropriate in a + professional setting + +Enforcement Responsibilities +---------------------------- + +Community leaders are responsible for clarifying and enforcing our standards +of acceptable behavior and will take appropriate and fair corrective action in +response to any behavior that they deem inappropriate, threatening, offensive, +or harmful. + +Community leaders have the right and responsibility to remove, edit, or reject +comments, commits, code, wiki edits, issues, and other contributions that are +not aligned to this Code of Conduct, and will communicate reasons for moderation +decisions when appropriate. + +Scope +----- + +This Code of Conduct applies within all community spaces, and also applies +when an individual is officially representing the community in public spaces. +Examples of representing our community include using an official e-mail +address, posting via an official social media account, or acting as an appointed +representative at an online or offline event. + +Enforcement +----------- + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported to Chris Vernon (mailto:chris.vernon@pnnl.gov) +and/or Travis Thurber (mailto:travis.thurber@pnnl.gov). +All complaints will be reviewed and investigated promptly and fairly. + +Community leaders are obligated to respect the privacy and security of the +reporter of any incident. + +This code of conduct, including the consequences laid out below, applies equally +to the community leaders, of course. Any temporary or permanent ban will result +in the person in question being removed from the leadership. + +Enforcement Guidelines +---------------------- + +Community leaders will follow these Community Impact Guidelines in determining +the consequences for any action they deem in violation of this Code of Conduct: + +1. Correction + **Community Impact**: Use of inappropriate language or other behavior deemed + unprofessional or unwelcome in the community. + + **Consequence**: A private, written warning from community leaders, providing + clarity around the nature of the violation and an explanation of why the + behavior was inappropriate. A public apology may be requested. + +2. Warning + **Community Impact**: A violation through a single incident or series of + actions. + + **Consequence**: A warning with consequences for continued behavior. No + interaction with the people involved, including unsolicited interaction with + those enforcing the Code of Conduct, for a specified period of time. This + includes avoiding interactions in community spaces as well as external channels + like social media. Violating these terms may lead to a temporary or permanent + ban. + +3. Temporary Ban + **Community Impact**: A serious violation of community standards, including + sustained inappropriate behavior. + + **Consequence**: A temporary ban from any sort of interaction or public + communication with the community for a specified period of time. No public or + private interaction with the people involved, including unsolicited interaction + with those enforcing the Code of Conduct, is allowed during this period. + Violating these terms may lead to a permanent ban. + +4. Permanent Ban + **Community Impact**: Demonstrating a pattern of violation of community + standards, including sustained inappropriate behavior, harassment of an + individual, or aggression toward or disparagement of classes of individuals. + + **Consequence**: A permanent ban from any sort of public interaction within the + community. + +Attribution +----------- + +This Code of Conduct is adapted from the Contributor Covenant, version 2.0, +available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. + +Community Impact Guidelines were inspired by Mozilla's code of conduct +enforcement ladder (https://github.com/mozilla/diversity). + +For answers to common questions about this code of conduct, see the FAQ at +https://www.contributor-covenant.org/faq. Translations are available at https:// +www.contributor-covenant.org/translations. diff --git a/docs/source/index.rst b/docs/source/index.rst index 26611de..a697a35 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -67,6 +67,7 @@ Addressing Uncertainty in MultiSector Dynamics Research preface citation acknowledgements + code_of_conduct .. raw:: latex From a02a4645661014b6373053cc86e26fb482274b56 Mon Sep 17 00:00:00 2001 From: crvernon Date: Mon, 5 Feb 2024 10:16:00 -0500 Subject: [PATCH 07/16] update contribution guidlines --- .../contribution_checklist.md | 16 +++++++++------- docs/source/contributing.rst | 18 ++++++++++++++++++ 2 files changed, 27 insertions(+), 7 deletions(-) create mode 100644 docs/source/contributing.rst diff --git a/.github/PULL_REQUEST_TEMPLATE/contribution_checklist.md b/.github/PULL_REQUEST_TEMPLATE/contribution_checklist.md index d3cfcab..10f63ab 100644 --- a/.github/PULL_REQUEST_TEMPLATE/contribution_checklist.md +++ b/.github/PULL_REQUEST_TEMPLATE/contribution_checklist.md @@ -1,5 +1,5 @@ ## Tutorial Contribution -We require that all contributions including any code, data, or other content provided with them be fully open source. +The following upon submission starts the review process for your draft Jupyter notebook contribution to the eBook. Please see our `contribution documentation `_ for additional guidance. ## Contribution Issue Link Please reference the link to your approved contribution issue here: # (issue) @@ -7,11 +7,13 @@ Please reference the link to your approved contribution issue here: # (issue) ## Checklist Please ensure that you are able to check all of the following boxes before submission - [ ] My contribution proposal has been approved -- [ ] I have read the contributing guidelines -- [ ] My code follows the style guidelines of this project - [ ] I have performed a self-review of my own code -- [ ] I have commented my code, particularly in hard-to-understand areas -- [ ] I have made corresponding changes to the documentation -- [ ] My code is fully open source and can be distributed using the [BSD-2-Clause](https://opensource.org/license/bsd-2-clause/) license +- [ ] All elements of my contribution are fully open-source and can be distributed with an `Open Source Initiative approved license `_ with an understanding that they may be used in community demonstrations and other activities. Author citations will be present in the notebook for any contributed work to ensure the author(s) receive full credit for their contribution. +- [ ] Any data or code reused in your submission are correctly cited giving credit to the original authors. +- [ ] The notebook provided is written in English and able to be a stand-alone product that needs no further explanation past what is written in the notebook to make use of it. +- [ ] The provided work is not merely a regurgitation of an existing tutorial or demonstration but represents a novel contribution. +- [ ] All contributions and communication thereof must abide by our `code of conduct `_. -## Additional information \ No newline at end of file +## Additional information + +## Please upload your draft notebook as an attachment to this pull request diff --git a/docs/source/contributing.rst b/docs/source/contributing.rst new file mode 100644 index 0000000..5dcec51 --- /dev/null +++ b/docs/source/contributing.rst @@ -0,0 +1,18 @@ +****************** +Contribution Guide +****************** + +Our eBook is a living product that we hope continues to grow over time to stay relevant with methodological and technological advancements in the field of uncertainty quantificaiton and MultiSector Dynamics at large. We extend an invitation to you the reader to contribute to one of our interactive Jupyter notebook tutorials. If you feel you have a contribution that would be relevant and generalizable to the MSD community, please submit a proposal idea `here `_. Your proposal will be reviewing by our team and feedback and/or a decision will be provided shortly. Any contribution accepted will receive it's own DOI and citation so that you may provide an independent reference to your work as you see fit. + +Please consider the following requirements for contribution: + +- All elements of your contribution MUST be fully open-source and can be distributed with an `Open Source Initiative approved license `_ with an understanding that they may be used in community demonstrations and other activities. Author citations will be present in the notebook for any contributed work to ensure the author(s) receive full credit for their contribution. +- Any data or code reused in your submission must be correctly cited giving credit to the original authors. +- The notebook provided must be written in English and able to be a stand-alone product that needs no further explanation past what is written in the notebook to make use of it. +- The provided work is not merely a regurgitation of an existing tutorial or demonstration but represents a novel contribution. +- All contributions and communication thereof must abide by our `code of conduct `_. + + +If you feel your work meets the criteria above, please submit a proposal issue `here `_. If your proposal is approved, please submit your draft notebook for review as an attachment using our submission `template `_. We will then review your submission and provide feedback. Once your contribution has been deemed ready to deploy, we will generate a DOI for your work, launch it to our MSD-LIVE set of interactive notebooks, and feature the contribution in the index of our eBook. + +Please feel free to reach out with any further questions. From a715c6900f6bc968e18c7011cc301fca6250abcc Mon Sep 17 00:00:00 2001 From: crvernon Date: Mon, 5 Feb 2024 10:18:18 -0500 Subject: [PATCH 08/16] update issue template --- .github/ISSUE_TEMPLATE/contribution_proposal.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/contribution_proposal.yml b/.github/ISSUE_TEMPLATE/contribution_proposal.yml index 31f6a32..6af6349 100644 --- a/.github/ISSUE_TEMPLATE/contribution_proposal.yml +++ b/.github/ISSUE_TEMPLATE/contribution_proposal.yml @@ -1,6 +1,6 @@ name: Contribution Proposal description: - Want to contribute to our eBook? Fill the following proposal form and we will review your contribution idea shortly. + Want to contribute to our eBook? Fill the following proposal form and we will review your contribution idea shortly. See our `contribution documentation `_ for additional information. labels: ["needs triage"] body: From 581005dc3867cd4b572477e1758c44463908620d Mon Sep 17 00:00:00 2001 From: crvernon Date: Mon, 5 Feb 2024 10:26:46 -0500 Subject: [PATCH 09/16] fix broken link --- docs/source/code_of_conduct.rst | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/docs/source/code_of_conduct.rst b/docs/source/code_of_conduct.rst index 2320629..fe74513 100644 --- a/docs/source/code_of_conduct.rst +++ b/docs/source/code_of_conduct.rst @@ -1,5 +1,5 @@ -Contributor Covenant Code of Conduct -==================================== +Code of Conduct +=============== Our Pledge ---------- @@ -129,5 +129,4 @@ Community Impact Guidelines were inspired by Mozilla's code of conduct enforcement ladder (https://github.com/mozilla/diversity). For answers to common questions about this code of conduct, see the FAQ at -https://www.contributor-covenant.org/faq. Translations are available at https:// -www.contributor-covenant.org/translations. +https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations. From 7d531eb2915bb06c5a7aacd845abdd6f1db7492d Mon Sep 17 00:00:00 2001 From: crvernon Date: Mon, 5 Feb 2024 10:40:26 -0500 Subject: [PATCH 10/16] pin sphinx applehelp version --- docs/requirements.txt | 1 + setup.py | 1 + 2 files changed, 2 insertions(+) diff --git a/docs/requirements.txt b/docs/requirements.txt index 0a45ef1..41ecb30 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -2,6 +2,7 @@ autodoc~=0.5.0 ipython~=8.0.1 mathjax~=0.1.2 nbsphinx~=0.8.6 +sphinxcontrib-applehelp==1.0.7 sphinx~=4.0.2 sphinx-book-theme~=0.2.0 sphinxcontrib-bibtex~=2.4.1 \ No newline at end of file diff --git a/setup.py b/setup.py index 4ff9acd..dc7e267 100644 --- a/setup.py +++ b/setup.py @@ -50,6 +50,7 @@ def get_requirements(): 'mathjax~=0.1.2', 'nbsphinx~=0.8.6', 'setuptools~=57.0.0', + 'sphinxcontrib-applehelp==1.0.7', 'sphinx~=4.0.2', 'sphinx-book-theme~=0.2.0', 'sphinxcontrib-bibtex~=2.4.1', From 3d33760d707dad87425eef73a678f44c8f0c817b Mon Sep 17 00:00:00 2001 From: crvernon Date: Mon, 5 Feb 2024 10:46:33 -0500 Subject: [PATCH 11/16] unmin major versions --- docs/requirements.txt | 15 +++++++-------- setup.py | 21 ++++++++++----------- 2 files changed, 17 insertions(+), 19 deletions(-) diff --git a/docs/requirements.txt b/docs/requirements.txt index 41ecb30..9f3d70d 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,8 +1,7 @@ -autodoc~=0.5.0 -ipython~=8.0.1 -mathjax~=0.1.2 -nbsphinx~=0.8.6 -sphinxcontrib-applehelp==1.0.7 -sphinx~=4.0.2 -sphinx-book-theme~=0.2.0 -sphinxcontrib-bibtex~=2.4.1 \ No newline at end of file +autodoc>=0.5.0 +ipython>=8.0.1 +mathjax>=0.1.2 +nbsphinx>=0.8.6 +sphinx>=4.0.2 +sphinx-book-theme>=0.2.0 +sphinxcontrib-bibtex>=2.4.1 \ No newline at end of file diff --git a/setup.py b/setup.py index dc7e267..a0fc80d 100644 --- a/setup.py +++ b/setup.py @@ -44,17 +44,16 @@ def get_requirements(): ], extras_require={ 'dev': [ - 'autodoc~=0.5.0', - 'build~=0.5.1', - 'ipython~=8.0.1', - 'mathjax~=0.1.2', - 'nbsphinx~=0.8.6', - 'setuptools~=57.0.0', - 'sphinxcontrib-applehelp==1.0.7', - 'sphinx~=4.0.2', - 'sphinx-book-theme~=0.2.0', - 'sphinxcontrib-bibtex~=2.4.1', - 'twine~=3.4.1' + 'autodoc>=0.5.0', + 'build>=0.5.1', + 'ipython>=8.0.1', + 'mathjax>=0.1.2', + 'nbsphinx>=0.8.6', + 'setuptools>=57.0.0', + 'sphinx>=4.0.2', + 'sphinx-book-theme>=0.2.0', + 'sphinxcontrib-bibtex>=2.4.1', + 'twine>=3.4.1' ] } ) \ No newline at end of file From 6239ee087714374f3fd3335d55c2f0f1ecd3acc0 Mon Sep 17 00:00:00 2001 From: crvernon Date: Mon, 5 Feb 2024 10:55:54 -0500 Subject: [PATCH 12/16] add contribution page to main --- docs/source/index.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/source/index.rst b/docs/source/index.rst index a697a35..170c127 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -68,6 +68,7 @@ Addressing Uncertainty in MultiSector Dynamics Research citation acknowledgements code_of_conduct + contributing .. raw:: latex From f51caf93be501aab1532874d778db49a47185507 Mon Sep 17 00:00:00 2001 From: crvernon Date: Mon, 5 Feb 2024 11:06:14 -0500 Subject: [PATCH 13/16] contribution proposal issue desc shorten --- .github/ISSUE_TEMPLATE/contribution_proposal.yml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/contribution_proposal.yml b/.github/ISSUE_TEMPLATE/contribution_proposal.yml index 6af6349..db08198 100644 --- a/.github/ISSUE_TEMPLATE/contribution_proposal.yml +++ b/.github/ISSUE_TEMPLATE/contribution_proposal.yml @@ -1,6 +1,6 @@ name: Contribution Proposal description: - Want to contribute to our eBook? Fill the following proposal form and we will review your contribution idea shortly. See our `contribution documentation `_ for additional information. + Want to contribute to our eBook? Fill the following proposal form and we will review your contribution idea shortly. labels: ["needs triage"] body: @@ -8,6 +8,7 @@ body: attributes: value: | ## Please fill out the form completly + See our `contribution documentation `_ for additional information. **NOTE**: We require that all contributions including any code, data, or other content provided with them be fully open source. - type: textarea From bd995dfa926e408a46cf984c9e56ba69b0c0c48b Mon Sep 17 00:00:00 2001 From: crvernon Date: Mon, 5 Feb 2024 11:47:20 -0500 Subject: [PATCH 14/16] rst links to md --- .github/PULL_REQUEST_TEMPLATE/contribution_checklist.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE/contribution_checklist.md b/.github/PULL_REQUEST_TEMPLATE/contribution_checklist.md index 10f63ab..778d5c6 100644 --- a/.github/PULL_REQUEST_TEMPLATE/contribution_checklist.md +++ b/.github/PULL_REQUEST_TEMPLATE/contribution_checklist.md @@ -1,5 +1,5 @@ ## Tutorial Contribution -The following upon submission starts the review process for your draft Jupyter notebook contribution to the eBook. Please see our `contribution documentation `_ for additional guidance. +The following upon submission starts the review process for your draft Jupyter notebook contribution to the eBook. Please see our [contribution documentation](https://uc-ebook.org/dev/docs/html/contributing.html) for additional guidance. ## Contribution Issue Link Please reference the link to your approved contribution issue here: # (issue) @@ -8,11 +8,11 @@ Please reference the link to your approved contribution issue here: # (issue) Please ensure that you are able to check all of the following boxes before submission - [ ] My contribution proposal has been approved - [ ] I have performed a self-review of my own code -- [ ] All elements of my contribution are fully open-source and can be distributed with an `Open Source Initiative approved license `_ with an understanding that they may be used in community demonstrations and other activities. Author citations will be present in the notebook for any contributed work to ensure the author(s) receive full credit for their contribution. +- [ ] All elements of my contribution are fully open-source and can be distributed with an [Open Source Initiative approved license](https://opensource.org/licenses/) with an understanding that they may be used in community demonstrations and other activities. Author citations will be present in the notebook for any contributed work to ensure the author(s) receive full credit for their contribution. - [ ] Any data or code reused in your submission are correctly cited giving credit to the original authors. - [ ] The notebook provided is written in English and able to be a stand-alone product that needs no further explanation past what is written in the notebook to make use of it. - [ ] The provided work is not merely a regurgitation of an existing tutorial or demonstration but represents a novel contribution. -- [ ] All contributions and communication thereof must abide by our `code of conduct `_. +- [ ] All contributions and communication thereof must abide by our [code of conduct](https://uc-ebook.org/dev/docs/html/code_of_conduct.html). ## Additional information From 28d78a08b51d13997cc9d754e2c1b74178fd9f76 Mon Sep 17 00:00:00 2001 From: Chris Vernon Date: Mon, 3 Jun 2024 15:12:28 -0400 Subject: [PATCH 15/16] revise the code of conduct formality --- .../ISSUE_TEMPLATE/contribution_proposal.yml | 2 +- .../contribution_checklist.md | 4 +- CODE_OF_CONDUCT.md | 77 +------------------ docs/source/code_of_conduct.rst | 74 ------------------ docs/source/contributing.rst | 4 +- 5 files changed, 6 insertions(+), 155 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/contribution_proposal.yml b/.github/ISSUE_TEMPLATE/contribution_proposal.yml index db08198..dc6691e 100644 --- a/.github/ISSUE_TEMPLATE/contribution_proposal.yml +++ b/.github/ISSUE_TEMPLATE/contribution_proposal.yml @@ -8,7 +8,7 @@ body: attributes: value: | ## Please fill out the form completly - See our `contribution documentation `_ for additional information. + See our `contribution documentation `_ for additional information. **NOTE**: We require that all contributions including any code, data, or other content provided with them be fully open source. - type: textarea diff --git a/.github/PULL_REQUEST_TEMPLATE/contribution_checklist.md b/.github/PULL_REQUEST_TEMPLATE/contribution_checklist.md index 778d5c6..16147e7 100644 --- a/.github/PULL_REQUEST_TEMPLATE/contribution_checklist.md +++ b/.github/PULL_REQUEST_TEMPLATE/contribution_checklist.md @@ -1,5 +1,5 @@ ## Tutorial Contribution -The following upon submission starts the review process for your draft Jupyter notebook contribution to the eBook. Please see our [contribution documentation](https://uc-ebook.org/dev/docs/html/contributing.html) for additional guidance. +The following upon submission starts the review process for your draft Jupyter notebook contribution to the eBook. Please see our [contribution documentation](https://uc-ebook.org/docs/html/contributing.html) for additional guidance. ## Contribution Issue Link Please reference the link to your approved contribution issue here: # (issue) @@ -12,7 +12,7 @@ Please ensure that you are able to check all of the following boxes before submi - [ ] Any data or code reused in your submission are correctly cited giving credit to the original authors. - [ ] The notebook provided is written in English and able to be a stand-alone product that needs no further explanation past what is written in the notebook to make use of it. - [ ] The provided work is not merely a regurgitation of an existing tutorial or demonstration but represents a novel contribution. -- [ ] All contributions and communication thereof must abide by our [code of conduct](https://uc-ebook.org/dev/docs/html/code_of_conduct.html). +- [ ] All contributions and communication thereof must abide by our [code of conduct](https://uc-ebook.org/docs/html/code_of_conduct.html). ## Additional information diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index 1e1beca..7db4d3b 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -36,18 +36,6 @@ address, without their explicit permission * Other conduct which could reasonably be considered inappropriate in a professional setting -## Enforcement Responsibilities - -Community leaders are responsible for clarifying and enforcing our standards -of acceptable behavior and will take appropriate and fair corrective action in -response to any behavior that they deem inappropriate, threatening, offensive, -or harmful. - -Community leaders have the right and responsibility to remove, edit, or reject -comments, commits, code, wiki edits, issues, and other contributions that are -not aligned to this Code of Conduct, and will communicate reasons for moderation -decisions when appropriate. - ## Scope This Code of Conduct applies within all community spaces, and also applies @@ -56,66 +44,6 @@ Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. -## Enforcement - -Instances of abusive, harassing, or otherwise unacceptable behavior may be -reported to [Chris Vernon](mailto:chris.vernon@pnnl.gov) -and/or [Travis Thurber](mailto:travis.thurber@pnnl.gov). -All complaints will be reviewed and investigated promptly and fairly. - -Community leaders are obligated to respect the privacy and security of the -reporter of any incident. - -This code of conduct, including the consequences laid out below, applies equally -to the community leaders, of course. Any temporary or permanent ban will result -in the person in question being removed from the leadership. - -## Enforcement Guidelines - -Community leaders will follow these Community Impact Guidelines in determining -the consequences for any action they deem in violation of this Code of Conduct: - -### 1. Correction - -**Community Impact**: Use of inappropriate language or other behavior deemed -unprofessional or unwelcome in the community. - -**Consequence**: A private, written warning from community leaders, providing -clarity around the nature of the violation and an explanation of why the -behavior was inappropriate. A public apology may be requested. - -### 2. Warning - -**Community Impact**: A violation through a single incident or series of -actions. - -**Consequence**: A warning with consequences for continued behavior. No -interaction with the people involved, including unsolicited interaction with -those enforcing the Code of Conduct, for a specified period of time. This -includes avoiding interactions in community spaces as well as external channels -like social media. Violating these terms may lead to a temporary or permanent -ban. - -### 3. Temporary Ban - -**Community Impact**: A serious violation of community standards, including -sustained inappropriate behavior. - -**Consequence**: A temporary ban from any sort of interaction or public -communication with the community for a specified period of time. No public or -private interaction with the people involved, including unsolicited interaction -with those enforcing the Code of Conduct, is allowed during this period. -Violating these terms may lead to a permanent ban. - -### 4. Permanent Ban - -**Community Impact**: Demonstrating a pattern of violation of community -standards, including sustained inappropriate behavior, harassment of an -individual, or aggression toward or disparagement of classes of individuals. - -**Consequence**: A permanent ban from any sort of public interaction within the -community. - ## Attribution This Code of Conduct is adapted from the [Contributor Covenant][homepage], @@ -123,11 +51,8 @@ version 2.0, available at https://www.contributor-covenant.org/version/2/0/ code_of_conduct.html. -Community Impact Guidelines were inspired by [Mozilla's code of conduct -enforcement ladder](https://github.com/mozilla/diversity). - [homepage]: https://www.contributor-covenant.org For answers to common questions about this code of conduct, see the FAQ at https://www.contributor-covenant.org/faq. Translations are available at https:// -www.contributor-covenant.org/translations. \ No newline at end of file +www.contributor-covenant.org/translations. diff --git a/docs/source/code_of_conduct.rst b/docs/source/code_of_conduct.rst index fe74513..56672b8 100644 --- a/docs/source/code_of_conduct.rst +++ b/docs/source/code_of_conduct.rst @@ -39,19 +39,6 @@ Examples of unacceptable behavior include: - Other conduct which could reasonably be considered inappropriate in a professional setting -Enforcement Responsibilities ----------------------------- - -Community leaders are responsible for clarifying and enforcing our standards -of acceptable behavior and will take appropriate and fair corrective action in -response to any behavior that they deem inappropriate, threatening, offensive, -or harmful. - -Community leaders have the right and responsibility to remove, edit, or reject -comments, commits, code, wiki edits, issues, and other contributions that are -not aligned to this Code of Conduct, and will communicate reasons for moderation -decisions when appropriate. - Scope ----- @@ -61,72 +48,11 @@ Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. -Enforcement ------------ - -Instances of abusive, harassing, or otherwise unacceptable behavior may be -reported to Chris Vernon (mailto:chris.vernon@pnnl.gov) -and/or Travis Thurber (mailto:travis.thurber@pnnl.gov). -All complaints will be reviewed and investigated promptly and fairly. - -Community leaders are obligated to respect the privacy and security of the -reporter of any incident. - -This code of conduct, including the consequences laid out below, applies equally -to the community leaders, of course. Any temporary or permanent ban will result -in the person in question being removed from the leadership. - -Enforcement Guidelines ----------------------- - -Community leaders will follow these Community Impact Guidelines in determining -the consequences for any action they deem in violation of this Code of Conduct: - -1. Correction - **Community Impact**: Use of inappropriate language or other behavior deemed - unprofessional or unwelcome in the community. - - **Consequence**: A private, written warning from community leaders, providing - clarity around the nature of the violation and an explanation of why the - behavior was inappropriate. A public apology may be requested. - -2. Warning - **Community Impact**: A violation through a single incident or series of - actions. - - **Consequence**: A warning with consequences for continued behavior. No - interaction with the people involved, including unsolicited interaction with - those enforcing the Code of Conduct, for a specified period of time. This - includes avoiding interactions in community spaces as well as external channels - like social media. Violating these terms may lead to a temporary or permanent - ban. - -3. Temporary Ban - **Community Impact**: A serious violation of community standards, including - sustained inappropriate behavior. - - **Consequence**: A temporary ban from any sort of interaction or public - communication with the community for a specified period of time. No public or - private interaction with the people involved, including unsolicited interaction - with those enforcing the Code of Conduct, is allowed during this period. - Violating these terms may lead to a permanent ban. - -4. Permanent Ban - **Community Impact**: Demonstrating a pattern of violation of community - standards, including sustained inappropriate behavior, harassment of an - individual, or aggression toward or disparagement of classes of individuals. - - **Consequence**: A permanent ban from any sort of public interaction within the - community. - Attribution ----------- This Code of Conduct is adapted from the Contributor Covenant, version 2.0, available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. -Community Impact Guidelines were inspired by Mozilla's code of conduct -enforcement ladder (https://github.com/mozilla/diversity). - For answers to common questions about this code of conduct, see the FAQ at https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations. diff --git a/docs/source/contributing.rst b/docs/source/contributing.rst index 5dcec51..3733237 100644 --- a/docs/source/contributing.rst +++ b/docs/source/contributing.rst @@ -10,9 +10,9 @@ Please consider the following requirements for contribution: - Any data or code reused in your submission must be correctly cited giving credit to the original authors. - The notebook provided must be written in English and able to be a stand-alone product that needs no further explanation past what is written in the notebook to make use of it. - The provided work is not merely a regurgitation of an existing tutorial or demonstration but represents a novel contribution. -- All contributions and communication thereof must abide by our `code of conduct `_. +- All contributions and communication thereof must abide by our `code of conduct `_. -If you feel your work meets the criteria above, please submit a proposal issue `here `_. If your proposal is approved, please submit your draft notebook for review as an attachment using our submission `template `_. We will then review your submission and provide feedback. Once your contribution has been deemed ready to deploy, we will generate a DOI for your work, launch it to our MSD-LIVE set of interactive notebooks, and feature the contribution in the index of our eBook. +If you feel your work meets the criteria above, please submit a proposal issue `here `_. If your proposal is approved, please submit your draft notebook for review as an attachment using our submission `template `_. We will then review your submission and provide feedback. Once your contribution has been deemed ready to deploy, we will generate a DOI for your work, launch it to our MSD-LIVE set of interactive notebooks, and feature the contribution in the index of our eBook. Please feel free to reach out with any further questions. From ac78bb75b420163a7cbe2a8dda6856781ec21a66 Mon Sep 17 00:00:00 2001 From: Travis Thurber Date: Mon, 3 Jun 2024 12:30:25 -0700 Subject: [PATCH 16/16] Update contributing.rst --- docs/source/contributing.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/source/contributing.rst b/docs/source/contributing.rst index 3733237..c89f0e9 100644 --- a/docs/source/contributing.rst +++ b/docs/source/contributing.rst @@ -2,7 +2,7 @@ Contribution Guide ****************** -Our eBook is a living product that we hope continues to grow over time to stay relevant with methodological and technological advancements in the field of uncertainty quantificaiton and MultiSector Dynamics at large. We extend an invitation to you the reader to contribute to one of our interactive Jupyter notebook tutorials. If you feel you have a contribution that would be relevant and generalizable to the MSD community, please submit a proposal idea `here `_. Your proposal will be reviewing by our team and feedback and/or a decision will be provided shortly. Any contribution accepted will receive it's own DOI and citation so that you may provide an independent reference to your work as you see fit. +Our eBook is a living product that we hope continues to grow over time to stay relevant with methodological and technological advancements in the field of uncertainty quantificaiton and MultiSector Dynamics at large. We extend an invitation to you the reader to contribute to one of our interactive Jupyter notebook tutorials. If you feel you have a contribution that would be relevant and generalizable to the MSD community, please submit a proposal idea `here `_. Your proposal will be reviewing by our team and feedback and/or a decision will be provided shortly. Any contribution accepted will receive it's own DOI and citation so that you may provide an independent reference to your work as you see fit. Please consider the following requirements for contribution: @@ -13,6 +13,6 @@ Please consider the following requirements for contribution: - All contributions and communication thereof must abide by our `code of conduct `_. -If you feel your work meets the criteria above, please submit a proposal issue `here `_. If your proposal is approved, please submit your draft notebook for review as an attachment using our submission `template `_. We will then review your submission and provide feedback. Once your contribution has been deemed ready to deploy, we will generate a DOI for your work, launch it to our MSD-LIVE set of interactive notebooks, and feature the contribution in the index of our eBook. +If you feel your work meets the criteria above, please submit a proposal issue `here `_. If your proposal is approved, please submit your draft notebook for review as an attachment using our submission `template `_. We will then review your submission and provide feedback. Once your contribution has been deemed ready to deploy, we will generate a DOI for your work, launch it to our MSD-LIVE set of interactive notebooks, and feature the contribution in the index of our eBook. Please feel free to reach out with any further questions.