Improve README structure and add contribution - #343
Open
alessandrasotelo11-lgtm wants to merge 2 commits into
Open
Improve README structure and add contribution#343alessandrasotelo11-lgtm wants to merge 2 commits into
alessandrasotelo11-lgtm wants to merge 2 commits into
Conversation
- Added project overview for better clarity - Improved structure and readability of README - Added contributing guidelines for new contributors - Included setup instructions for local development Signed-off-by: Alessandra Sotelo <alessandra.sotelo.11@gmail.com>
✅ Deploy Preview for contribute-cncf-io ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Signed-off-by: Alessandra Sotelo <alessandra.sotelo.11@gmail.com>
Author
|
Hi! Updates completed and checks passed. Ready for review. Thanks! |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the repository’s README.md to better explain what the Contribute Site is, how the “golden path” is structured, and how to set up and contribute to the project.
Changes:
- Adds a new project overview section and expands the purpose/golden-path narrative.
- Reorganizes local setup instructions and introduces a brief tech stack section.
- Adds a short contributing checklist tailored to README edits.
| @@ -1,35 +1,54 @@ | |||
| ## This will eventually be the contributing guide, for now we want it up front | |||
Comment on lines
+21
to
23
| ### Individual | ||
|
|
||
| ## The Golden Path |
Comment on lines
43
to
+51
| ## Setup locally | ||
| ## Tech Stack | ||
|
|
||
| To set up the development environment for this Docusaurus site, you can choose | ||
| between two methods: using a devcontainer or running the site locally with the | ||
| `docusaurus dev` command. Follow the steps below: | ||
| To set up the development environment for this Docusaurus site, you can choose between two methods: using a devcontainer or running the site locally with the `docusaurus dev` command. Follow the steps below: | ||
| - [Docusaurus](https://docusaurus.io/) for static site generation | ||
| - [Node.js](https://nodejs.org/) (LTS 20+ recommended) | ||
| - [npm](https://www.npmjs.com/) for dependency and script management | ||
|
|
||
| ## Setup Locally |
| find useful. Additionally it will act as a reference point to other open source | ||
| communities - we want to represent our "style" of open source, in a way that is | ||
| consumable by others. | ||
| One source of truth for all of the information that a CNCF Contributor would find useful. Additionally it will act as a reference point to other open source communities - we want to represent our "style" of open source, in a way that is consumable by others. |
Comment on lines
+36
to
+40
| _A healthy ecosystem will encourage the development of all three of these skills_. | ||
| ### Community | ||
|
|
||
| The site is intended to be read in this order by a new contributor. It is also | ||
| intended to support you through your entire cloud native journey, we expect | ||
| mentors and experienced individuals to also share advanced things. | ||
| The site is intended to be read in this order by a new contributor. It is also intended to support you through your entire cloud native journey, we expect mentors and experienced individuals to also share advanced things. | ||
| Strengthen the wider ecosystem by documenting shared standards, leadership |
Comment on lines
72
to
76
| ### Run application | ||
|
|
||
| There are two different options you can adopt to run this website locally: | ||
| ### Run development server | ||
|
|
Comment on lines
84
to
+86
| #### Option 1: Using Devcontainer | ||
|
|
||
| If you are using a devcontainer, start the application with the following | ||
| command: | ||
| If you are using a devcontainer, start the application with the following command: | ||
| #### Option 1: Devcontainer |
Comment on lines
95
to
99
| #### Option 2: Running Locally | ||
|
|
||
| To run the site locally, use the following command: | ||
| #### Option 2: Local environment | ||
|
|
Comment on lines
+111
to
+116
| 3. Run formatting checks for README changes: | ||
|
|
||
| ```bash | ||
| npx prettier --write README.md | ||
| npx prettier --check README.md | ||
| ``` |
Comment on lines
121
to
+125
| ## ChillOps | ||
| ## Author | ||
|
|
||
| Feel free to start diving in with PRs, we want to remain opinionated on this | ||
| golden path for now, and then add branches and side quests after we've shipped | ||
| more meat. We want people to feel good when they read this site because they | ||
| found something useful, so feel free to file issues with your ideas! | ||
| Feel free to start diving in with PRs, we want to remain opinionated on this golden path for now, and then add branches and side quests after we've shipped more meat. We want people to feel good when they read this site because they found something useful, so feel free to file issues with your ideas! | ||
| Maintained by the CNCF contributor community. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Added project overview for better clarity
Improved structure and readability of README
Added contributing guidelines for new contributors
Included setup instructions for local development
[X ] I have read and followed the Contributing page.
This PR has content that I did not fully write myself.
I have the experience and knowledge necessary to understand, review, and validate all content in this PR.1
Footnotes
Yes, I can answer maintainer questions about the content of this PR, without using AI. ↩