Edit documentation (#3590)

* Edit documentation * Update .github/CONTRIBUTING.md * Move contributing guide and edit linking * Update CODE_OF_CONDUCT.md --------- Co-authored-by: SSwiniarski <[email protected]>
Codecademy · Oct 28, 2023 · ac4a4a3 · ac4a4a3
1 parent 697c4b5
commit ac4a4a3
Show file tree

Hide file tree

Showing 8 changed files with 24 additions and 15 deletions.
diff --git a/.github/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md
@@ -29,7 +29,7 @@ Examples of unacceptable behavior include:
 - Plagiarism of any kind from other documentation sites
 - 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
+- Trolling, spamming, 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
@@ -63,7 +63,16 @@ Project maintainers who do not follow or enforce the Code of Conduct in good fai
 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. Warning
+### 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**: Plagiarism or use of inappropriate language or other behavior deemed
 unprofessional or unwelcome in PRs, Issues, comments, reviews, and the community.
@@ -77,7 +86,7 @@ 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.
 
-### 2. Temporary Ban
+### 3. Temporary Ban
 
 **Community Impact**: A serious violation of community standards, including
 sustained inappropriate behavior, or the 2nd case of plagerism after receiving the 1st warning.
@@ -88,7 +97,7 @@ 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.
 
-### 3. Permanent Ban
+### 4. Permanent Ban
 
 **Community Impact**: Demonstrating a pattern of violation of community
 standards, including sustained inappropriate behavior, harassment of an
@@ -100,7 +109,7 @@ Docs and the community. Any future PRs will be automatically closed.
 ## Attribution
 
 This Code of Conduct is adapted from the [Contributor Covenant][homepage],
-version 2.0.
+version 2.1.
 
 [homepage]: https://www.contributor-covenant.org
 

diff --git a/.github/ISSUE_TEMPLATE/entry_edit.yml b/.github/ISSUE_TEMPLATE/entry_edit.yml
@@ -24,7 +24,7 @@ body:
   - type: markdown
     attributes:
       value: |
-        In addition to the [Contributing Guide](https://github.com/Codecademy/docs/blob/main/.github/CONTRIBUTING.md), we recommend checking out the following before submtting a PR:
+        In addition to the [Contributing Guide](https://github.com/Codecademy/docs/blob/main/CONTRIBUTING.md), we recommend checking out the following before submtting a PR:
         - [Entry templates](https://github.com/Codecademy/docs/blob/main/documentation/)
         - [Content standards](https://github.com/Codecademy/docs/blob/main/documentation/content-standards.md)
         - [Markdown style guide](https://curriculum-documentation.codecademy.com/content-guidelines/markdown-style-guide/)

diff --git a/.github/ISSUE_TEMPLATE/entry_request.yml b/.github/ISSUE_TEMPLATE/entry_request.yml
@@ -12,7 +12,7 @@ body:
   - type: markdown
     attributes:
       value: |
-        In addition to the [Contributing Guide](https://github.com/Codecademy/docs/blob/main/.github/CONTRIBUTING.md), we recommend checking out the following before submtting a PR:
+        In addition to the [Contributing Guide](https://github.com/Codecademy/docs/blob/main/CONTRIBUTING.md), we recommend checking out the following before submtting a PR:
         - [Entry templates](https://github.com/Codecademy/docs/blob/main/documentation/)
         - [Content standards](https://github.com/Codecademy/docs/blob/main/documentation/content-standards.md)
         - [Markdown style guide](https://curriculum-documentation.codecademy.com/content-guidelines/markdown-style-guide/)

diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -1,5 +1,5 @@
 <!--
-👋 Hi, thanks for sending a PR to Codecademy Docs! 💖
+👋 Hi, thanks for submitting a PR to Codecademy Docs! 💖
 Please fill out all fields below to ensure your PR is reviewed quickly.
 
 **IMPORTANT**

diff --git a/.github/CONTRIBUTING.md → CONTRIBUTING.md b/.github/CONTRIBUTING.md → CONTRIBUTING.md
@@ -20,7 +20,7 @@ There are many ways to contribute to Docs:
 - Give feedback in the [Typeform Survey](https://codecademyready.typeform.com/to/hzVIWDgz).
 - Join the [#CodecademyDocs](https://twitter.com/search?q=%23CodecademyDocs&src=typed_query&f=live) discussion on Twitter.
 
-If you're new to Docs and contributing for the first time, it is recommended that you visit the [Issues](https://github.com/Codecademy/docs/issues) section and ask to be assigned to an [open issue](https://github.com/Codecademy/docs/blob/main/.github/CONTRIBUTING.md#how-do-i-claim-an-issue) that interests you. Otherwise, feel free to submit a [PR](https://www.codecademy.com/resources/docs/git/pull-requests) by creating a new [branch](https://www.codecademy.com/resources/docs/git/branch) in your fork to create a new entry or edit an existing one.
+If you're new to Docs and contributing for the first time, it is recommended that you visit the [Issues](https://github.com/Codecademy/docs/issues) section and ask to be assigned to an [open issue](https://github.com/Codecademy/docs/blob/main/CONTRIBUTING.md#how-do-i-claim-an-issue) that interests you. Otherwise, feel free to submit a [PR](https://www.codecademy.com/resources/docs/git/pull-requests) by creating a new [branch](https://www.codecademy.com/resources/docs/git/branch) in your fork to create a new entry or edit an existing one.
 
 ## How do I claim an Issue?
 
@@ -112,11 +112,11 @@ To link your Codecademy user profile to GitHub:
 4. Select the Github icon under "Or log in using:"
 5. Proceed through the OAuth process.
 
-## Any tips for a Pull Request (PR)?
+## Any requirements for a Pull Request (PR)?
 
 - Before making a PR, make sure you pushed your changes from a branch other than `main`.
 - Name the new branch after the changes being pushed to the PR.
-- Keep your PRs byte-sized. No more than 3 new entries per PR!
+- Keep your PRs byte-sized. No more than 3 new entries per PR! And no more than 3 PRs open at a time!
 - All contributors must sign the [Contributor License Agreement (CLA)](<[url](https://cla-assistant.io/Codecademy/docs)>) when contributing for the first time.
 - All required [status checks](https://docs.github.com/en/github/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks) are expected to pass in each PR.
 - PRs will be marked as **invalid** if there is no consistent activity within a **2-week period** on the contributor's part and content does not meet or pass standard formatting, quality, and plagiarism checks.

diff --git a/README.md b/README.md
@@ -12,7 +12,7 @@
 
 ## What stage of development are we in right now?
 
-Docs is live with over 1000 high-quality entries. Now that the MVP is out, our goal is to transition some ownership of Docs content to the Codecademy community, since maintaining a resource of this type at-scale is only possible if it's open-contribution. That means we need your help, whether it's contributing, reviewing, or evangelizing!
+Docs is live with over 2000 high-quality entries. Now that the MVP is out, our goal is to transition some ownership of Docs content to the Codecademy community, since maintaining a resource of this type at-scale is only possible if it's open-contribution. That means we need your help, whether it's contributing, reviewing, or evangelizing!
 
 ### 📝 Content Team
 
@@ -45,7 +45,7 @@ There are many ways to contribute to Docs:
 
 Whether you are a code newbie or a seasoned hacker, there's something for you!
 
-Please read through the [Contribution Guide](https://www.codecademy.com/resources/docs/contribution-guide) ✨. There you'll find a write-up of our content standards and style guide, as well as templates for creating your entries.
+Please read through the [Contributing Guide](https://github.com/Codecademy/docs/blob/main/CONTRIBUTING.md). There, you'll find a write-up of our content standards and style guide, as well as templates for creating your entries.
 
 ## Additional Notes
 

diff --git a/documentation/catalog-content.md b/documentation/catalog-content.md
@@ -1,6 +1,6 @@
 # Catalog Content
 
-The [metadata](https://github.com/Codecademy/docs/blob/main/documentation/content-standards.md#standards-metadata) which go at the top of the file, should include **two** slugs. Preferably:
+The [metadata](https://github.com/Codecademy/docs/blob/main/documentation/content-standards.md#standards-metadata), located at the top of the file, should include **two** slugs. Preferably:
 
 - A free course
 - A Pro course/Path

diff --git a/documentation/content-standards.md b/documentation/content-standards.md
@@ -61,7 +61,7 @@ All code blocks should be delineated by triple backticks (```). Languages can be
 
 ### Codebytes: Runnable Code Blocks
 
-Codecademy has a new feature called [Codebytes](https://www.codecademy.com/codebyte-editor) that will allow learners to click a button to run code blocks themselves! The output to the console will appear next to the code block.
+Codecademy has a feature called [Codebytes](https://www.codecademy.com/codebyte-editor) that will allow learners to click a button to run code blocks themselves! The output to the console will appear next to the code block.
 
 Codebytes is a great tool to incorporate into some entries (for instance, if you want learners to think about what a code block will output before they see it in action, or if you want to show a learner how a function that incorporates randomization produces different output each time).