Skip to content

Latest commit

 

History

History
32 lines (23 loc) · 1.43 KB

CONTRIBUTING.md

File metadata and controls

32 lines (23 loc) · 1.43 KB

Dev Setup

  • Fork and clone the repository
  • Install Hugo
    • Please note that you need to install the "extended" version of Hugo (with built-in support) to run the site locally.
  • Install npm
  • Run make serve
    • If you are on OS X and see an error like too many open files or pipe failed, you may need to increase the file descriptor limit. See this Hugo GitHub issue.
  • Open http://localhost:30000 to check the site

A few notes to be aware of:

  • Before submitting a PR be sure to run make test and address any issues uncovered
  • Any make target that requires get-milestones requires that a GH_TOKEN environment variable be set

Deploy previews

Whenever you submit a pull request to this repo, Netlify creates a deploy preview for the changes in that specific PR. You can view the deploy preview in the Netlify panel that appears under the PR description.

Publishing the site

The OpenTelemetry website is published automatically by Netlify. When changes are pushed to the main branch, Netlify re-builds and re-deploys the site and stages a deploy preview for those changes.

Site administrators can access the admin interface here.