Skip to content

Commit 41ae82f

Browse files
committed
Made minor changes
1 parent 5b05620 commit 41ae82f

1 file changed

Lines changed: 43 additions & 21 deletions

File tree

CONTRIBUTING.md

Lines changed: 43 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -4,20 +4,38 @@ Thanks for your interest in improving the NeuVector documentation!
44

55
## About this repo
66

7-
This repository contains the source for the NeuVector documentation site, published at https://open-docs.neuvector.com. Documentation content lives as Markdown files under `docs/`. The site itself is built with [Docusaurus](https://docusaurus.io/).
7+
This repository contains the source code for the official [NeuVector documentation site](https://open-docs.neuvector.com). The documentation content is written in Markdown and the site is statically generated using [Docusaurus](https://docusaurus.io/).
88

99
## Getting started
10+
## Get started
1011

11-
```shell
12-
git clone https://github.com/<your-fork>/docs.git
13-
cd docs
14-
yarn install
15-
yarn start
16-
```
12+
To preview your changes locally, install the following tools:
13+
14+
* [Node.js](https://nodejs.org/)
15+
* [Yarn](https://yarnpkg.com/)
16+
17+
1. Fork the repository to your GitHub account, then clone your fork and navigate to the `docs` directory.
18+
19+
```shell
20+
git clone https://github.com/<your-fork>/docs.git
21+
cd docs
22+
```
23+
24+
2. Install the project dependencies.
1725

18-
`yarn start` runs a local dev server with live reload, so you can preview your changes exactly as they'll render on the live site before submitting a PR.
26+
```shell
27+
yarn install
28+
```
1929

20-
To produce a static production build:
30+
3. Start the local development server.
31+
32+
```shell
33+
yarn start
34+
```
35+
36+
`yarn start` launches a local development server (usually at http://localhost:3000) with live reload enabled. This allows you to preview your changes exactly as they will render on the live site before you submit a Pull Request.
37+
38+
If you need to test the static production build locally to ensure everything compiles correctly:
2139

2240
```shell
2341
yarn build
@@ -26,23 +44,27 @@ yarn serve # preview the built output
2644

2745
## Reporting issues
2846

29-
If you find an error, gap, or outdated instruction in the docs, please open an issue describing:
30-
- The page/URL affected
31-
- What's currently wrong or unclear
32-
- What you'd expect instead
47+
If you find a typo, an error, a gap in the documentation, or an outdated instruction, please open an issue.
48+
49+
To help us resolve the issue quickly, please include:
50+
51+
- The URL or file path of the affected page.
52+
- A description of what is currently wrong or unclear.
53+
- What you would expect to see instead.
3354

3455
## Making a change
3556

36-
1. Fork the repo and create a branch for your change.
37-
2. Edit the relevant file under `docs/` — most content is plain Markdown (`.md`), though Docusaurus also supports `.mdx` for pages that embed
38-
React components, so check the file extension before assuming Markdown syntax alone will apply.
39-
3. If your change applies to content that also exists in an older doc version (see `versioned_docs/`), consider whether that version needs
40-
the same fix.
41-
4. Preview locally with `yarn start` to confirm formatting and any admonitions (`:::note`, `:::warning`, etc.) render correctly.
42-
5. Open a pull request against `main`, describing what changed and why.
57+
When you are ready to contribute a fix or an update, follow these steps:
58+
59+
1. Create a branch: Create a new branch on your fork for your changes (e.g., `git checkout -b fix/typo-in-getting-started`).
60+
2. Edit the content: Make your changes to the relevant files under the docs/ directory.
61+
* Most content is plain Markdown (.md), but Docusaurus also supports `.mdx` for pages that embed React components. Be sure to check the file extension before assuming standard Markdown syntax alone will apply.
62+
3. Check older versions: If your change applies to content that also exists in an older documentation version (found in the `versioned_docs`/ directory), please consider applying the same fix to those versions.
63+
4. Preview locally: Use `yarn start` to verify that your formatting for Docusaurus-specific admonitions like `:::note`, `:::warning`, and `:::info—renders` correctly.
64+
5. Submit a Pull Request: Open a Pull Request against the `main` branch. Provide a clear and concise description of what was changed and why.
4365

4466
**Important**: by submitting a pull request, you agree to allow the project owner to license your work under the same license as used by this project.
4567

4668
## Questions
4769

48-
For anything not covered here, feel free to open an issue.
70+
For anything not covered here, or if you need assistance with your contribution, please feel free to open an issue. We are here to help!

0 commit comments

Comments
 (0)