Hypertrace Documentation

This site was generated by www.stackbit.com, v0.2.99 and is deployed on Netlify. 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.

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 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.

The 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/
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 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

2. Install npm dependencies:

    npm install
   

3. get "stackbit-api-key" from project menu in Stackbit dashboard

4. run the following command to assign this key to STACKBIT_API_KEY environment variable:

    export STACKBIT_API_KEY={stackbit_netlify_api_key}
   

5. 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
   

6. Starts a development server

    npm run develop
   

7. Browse to http://localhost:8000/