This is the source code that runs the TelemetryJet documentation website. If you are looking for the repository for the TelemetryJet server, then head over to telemetryjet/telemetryjet.
- If you have a request for expanded documentation or question that is not answered in the docs, please open an issue!
- For bug reports or feature requests for the TelemetryJet platform, please refer to the main telemetryjet/telemetryjet repository.
- PRs or issues are welcome for any expanded documentation, spelling/grammar issues, or factual errors.
This repository uses Hugo to generate a static site from markdown files. The project also includes a custom theme, specifically designed for the documentation site. The theme sets up sidebar menus, headers and footers, etc.
The site is deployed using Netlify; The master branch is deployed to the production site and the develop
branch is deployed to the development site.
| Branch | Deploy Status | Target |
|---|---|---|
develop |
https://docs.dev.telemetryjet.com/ | |
master |
https://docs.telemetryjet.com/ |
Please install Hugo.
To run a development server, use:
hugo serve
To build and export the site to static HTML, use:
hugo
This will build the static site to the public/ directory as HTML. These files should not be uploaded to git; they are ignored and will be built by Netlify during the automated deployment.