You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+28-4Lines changed: 28 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -1,10 +1,33 @@
1
-
# Hypertrace Docs website
1
+
# Hypertrace Documentation
2
2
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.
4
4
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).
6
7
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.
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
8
31
9
32
1. Install [Node.js and npm](https://nodejs.org/en/)
10
33
@@ -27,3 +50,4 @@ Stackbit Libris Theme original README is located [here](./README.theme.md).
27
50
npm run develop
28
51
29
52
1. Browse to [http://localhost:8000/](http://localhost:8000/)
0 commit comments