Skip to content
Open
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
83 changes: 60 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,35 +1,54 @@
## This will eventually be the contributing guide, for now we want it up front
# Contribute Site

## Project Overview

Contribute Site is a documentation hub for cloud native contributors. It
provides practical guidance for individuals, project maintainers, and community
leaders so they can collaborate effectively and grow sustainable open source
ecosystems.

## Purpose

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.
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.
The purpose of this repository is to maintain one source of truth for
contributor knowledge, project operations, and community governance practices
across the cloud native landscape.

## Key Concepts

We hope that you visit this site often.
### Individual

## The Golden Path
Comment on lines +21 to 23
Develop the skills needed to become an effective contributor, including
communication, collaboration, and continuous learning.

We want to focus on the golden path first:
### Project

- The individual - skills you need to be an effective contributor
- The project - skills needed to manage projects, a different skillset
- The community - the group of groups, the larger governance structures like the
TOC and TABs
- The community - the group of groups, the larger governance structures like the TOC and TABs
Support maintainers and project teams with guidance on project lifecycle,
governance, and healthy contributor workflows.

_A healthy ecosystem will encourage the development of all three of these
skills_.
_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 +36 to +40
structures, and cross-project collaboration models.

## 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
Comment on lines 43 to +51

### Prerequisites

Expand All @@ -41,6 +60,10 @@ Ensure you have the following installed:
### Install Dependencies

Before starting the application, install the required packages by running:
- Node.js (LTS 20 or above recommended)
- npm

### Install dependencies

Comment on lines 60 to 67
```bash
npm install
Expand All @@ -49,6 +72,7 @@ npm install
### Run application

There are two different options you can adopt to run this website locally:
### Run development server

Comment on lines 72 to 76
> Note: `npm start` and `npm run build` automatically sync TechDocs content into
> `docs/techdocs/` if it does not exist yet. The first run may take longer
Expand All @@ -58,9 +82,8 @@ There are two different options you can adopt to run this website locally:
> local `docs/techdocs/` content in this repository as synced/generated.

#### 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 84 to +86

```bash
npm start -- --host 0.0.0.0 --port 3000 --poll 10000
Expand All @@ -72,17 +95,31 @@ http://localhost:3000.
#### Option 2: Running Locally

To run the site locally, use the following command:
#### Option 2: Local environment

Comment on lines 95 to 99
```bash
npm start
```

This will start the development server on the default port, typically
http://localhost:3000.
This will start the development server on the default port, typically `http://localhost:3000`.
The site is typically available at `http://localhost:3000`.

## Contributing

1. Create a branch from `main`.
2. Make your documentation or site updates.
3. Run formatting checks for README changes:

   ```bash
   npx prettier --write README.md
   npx prettier --check README.md
   ```
Comment on lines +111 to +116

4. Commit your changes with a clear message.
5. Open a pull request summarizing what changed and how it was validated.

## 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.
Comment on lines 121 to +125