Giter VIP home page Giter VIP logo

documentation's Introduction

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:

$ make 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):

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

documentation's People

Contributors

black-adder avatar chandresh-pancholi avatar cwe1ss avatar falco20019 avatar geoand avatar jpkrohling avatar lucperkins avatar objectiser avatar pavolloffay avatar pgadige avatar pikbot avatar saloni-garg avatar sudoshweta avatar tiffon avatar yurishkuro avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.