rmfitzpatrick / opentracing.io

OpenTracing website

opentracing.io

This repository contains the source code for http://opentracing.io website.

Contributing

Contributions are always welcome, no matter how large or small. Before contributing, please read the code of conduct.

License

Copyright (c) 2016-present, The OpenTracing Authors.

Licensed under the Apache License, Version 2.0.

By contributing to opentracing.io, you agree that your contributions will be licensed under its Apache 2.0 License.

Updating the Docs

If you'd like to work on the website locally, first install Hugo and a fork this repository:

• Install Hugo: https://gohugo.io/getting-started/installing/#quick-install
• Fork this repository on GitHub: https://help.github.com/articles/fork-a-repo/

Once hugo is installed, you can build the website. First, open up a terminal, navigate to the directory you would like to work in, and clone your fork of this repository.

git clone https://github.com/YOUR_USERNAME/opentracing.io.git
cd opentracing.io

Build the website using make:

make

One the site is setup, you can start the site locally in development mode:

make serve

Navigate to http://localhost:1313/ to see the site. Any content changes you make will automatically appear.

That's it! Most articles can be found in the /content directory, and are written in Markdown. For basic changes, use the following flow:

• edit the markdown files directly
• commit and push to your fork
• make a pull request

For larger structral changes, please see the Hugo Documentation.