https://github.com/hypertrace/hypertrace-docs-website
Hypertrace website and documentation
https://github.com/hypertrace/hypertrace-docs-website
documentation website
Last synced: 7 months ago
JSON representation
Hypertrace website and documentation
- Host: GitHub
- URL: https://github.com/hypertrace/hypertrace-docs-website
- Owner: hypertrace
- License: other
- Created: 2020-06-24T03:57:59.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2024-09-12T02:45:38.000Z (over 1 year ago)
- Last Synced: 2024-09-12T12:28:57.139Z (over 1 year ago)
- Topics: documentation, website
- Language: JavaScript
- Homepage: https://www.hypertrace.org/
- Size: 15.8 MB
- Stars: 0
- Watchers: 3
- Forks: 6
- Open Issues: 91
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Hypertrace Documentation
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.
## Contribute
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).
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.
Digging into the repo structure a little:
### Structure
This is a mirrored copy of the documentation available on the [Hypertrace docs website](https://docs.hypertrace.org).
The [src/pages](/src/pages/) folder structure matches the URL structure for the website.
**For example:** Say you want to edit the deployment article for deploying hypertrace on docker for desktop.
docs.hypertrace.org location: [https://docs.hypertrace.org/deployments/docker/](https://docs.hypertrace.org/deployments/docker/)
doc location:
`src/pages/deployments/docker.md`
If you add a screen shot or picture, put it in the media folder closest to the article you're contributing to.
### Easy way to contribute
- 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.
- You can make necessary changes and raise PR.
- Once PR is approved and merged your changes will be live on website.
### Running Your Site Locally
1. Install [Node.js and npm](https://nodejs.org/en/)
1. Install npm dependencies:
npm install
1. get "stackbit-api-key" from project menu in [Stackbit dashboard](https://app.stackbit.com/dashboard)
1. run the following command to assign this key to `STACKBIT_API_KEY` environment variable:
export STACKBIT_API_KEY={stackbit_netlify_api_key}
1. run the following command to fetch additional site contents from Stackbit if needed:
npx @stackbit/stackbit-pull --stackbit-pull-api-url=https://api.stackbit.com/pull/5ef2ce965ad8d00019477dec
1. Starts a development server
npm run develop
1. Browse to [http://localhost:8000/](http://localhost:8000/)