Skip to content

Commit 99bb5de

Browse files
authored
addds how to contribute to documentation in README
1 parent aade9fc commit 99bb5de

File tree

1 file changed

+28
-4
lines changed

1 file changed

+28
-4
lines changed

README.md

Lines changed: 28 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,33 @@
1-
# Hypertrace Docs website
1+
# Hypertrace Documentation
22

3-
This site was generated by [www.stackbit.com](https://www.stackbit.com), v0.2.99.
3+
This site was generated by [www.stackbit.com](https://www.stackbit.com), v0.2.99 and is deployed on [Netlify](https://netlify.com). The site is published automatically by Netlify whenever changes are merged to the main branch.
44

5-
Stackbit Libris Theme original README is located [here](./README.theme.md).
5+
## Contribute
6+
To contribute, fork the project and submit a pull request! You can look at our contributing guidelines [here](https://github.com/hypertrace/hypertrace/blob/main/.github/CONTRIBUTING.md).
67

7-
# Running Your Site Locally
8+
If you want to submit prospective content but contributing to public documentation takes too much time/planning, submit your idea or draft to the [Prospective Docs](./prospective-docs) folder and we'll figure it out from there.
9+
10+
Digging into the repo structure a little:
11+
12+
### Structure
13+
14+
This is a mirrored copy of the documentation available on the [Hypertrace docs website](https://docs.hypertrace.org).
15+
16+
The [src/pages](/src/pages/) folder structure matches the URL structure for the website.
17+
18+
**For example:** Say you want to edit the deployment article for deploying hypertrace on docker for desktop.
19+
docs.hypertrace.org location: [https://docs.hypertrace.org/deployments/docker/](https://docs.hypertrace.org/deployments/docker/)
20+
doc location:
21+
`src/pages/deployments/docker.md`
22+
23+
If you add a screen shot or picture, put it in the media folder closest to the article you're contributing to.
24+
25+
### Easy way to contribute
26+
- All the pages on [docs.hypertrace.org](http://docs.hypertrace.org) have edit button so you can simply click on edit button on page and it will open source file for that page.
27+
- You can make necessary changes and raise PR.
28+
- Once PR is approved and merged your changes will be live on website.
29+
30+
### Running Your Site Locally
831

932
1. Install [Node.js and npm](https://nodejs.org/en/)
1033

@@ -27,3 +50,4 @@ Stackbit Libris Theme original README is located [here](./README.theme.md).
2750
npm run develop
2851

2952
1. Browse to [http://localhost:8000/](http://localhost:8000/)
53+

0 commit comments

Comments
 (0)