jaegertracing/documentation

Name: documentation

Owner: Jaeger - Distributed Tracing System

Description: Documentation for the Jaeger Distributed Tracing project.

Created: 2017-11-20 11:58:13.0

Updated: 2018-05-17 09:18:34.0

Pushed: 2018-05-22 19:42:14.0

Homepage: https://jaegertracing.io/

Size: 1585

Language: HTML

GitHub Committers

UserMost Recent Commit# Commits

Other Committers

UserEmailMost Recent Commit# Commits

README

Jaeger website

This repo houses all the assets used to build the Jaeger website, available at https://jaegertracing.io.

The site is built and hosted by Netlify.

Requirements

In order to develop the Jaeger site locally, you'll need to have the following installed:

Setup
macOS

To develop the website on macOS, you'll first need to have Homebrew installed. Once you have Homebrew:

ke macos-setup

This will install Hugo, the site's static site generator, and all necessary Node.js assets.

Linux

Coming soon.

Running the site locally

If you want to develop the site locally, you can run a single command (assuming that you've run the setup):

ke dev

This will start up a local server on localhost port 1313. When you make changes to either the content of the website (in content) or to the Sass and JavaScript assets of the page (in themes/jaeger-docs/source), the browser will automatically update to reflect those changes (usually in under one second).

Publishing the site

The site is published automatically by Netlify whenever changes are merged to the master branch. The site cannot be published in an ad-hoc way (e.g. through a make command or script in the repo).

Contributing to the site

We strongly encourage you to contribute to this site! For more information, see the contributing guide.

License

Apache 2.0 License.


This work is supported by the National Institutes of Health's National Center for Advancing Translational Sciences, Grant Number U24TR002306. This work is solely the responsibility of the creators and does not necessarily represent the official views of the National Institutes of Health.