Skip to content

Latest commit

 

History

History
193 lines (143 loc) · 6.2 KB

CONTRIBUTING.md

File metadata and controls

193 lines (143 loc) · 6.2 KB
Raw

Contributing to OpenTelemetry.io

Quick fixes

For small changes to a single file, you can edit directly in GitHub by clicking Edit this file button and then following the instructions in Editing files.

Dev setup

Cloud-IDE setup

These instructions are for Gitpod.io, adjust as needed for your favorite cloud IDE:

  1. Fork this repo. For help, see Fork a repo.

  2. From gitpod.io/workspaces, create a new workspace (do this only once) or open an existing workspace over your fork. You can also visit a link of the form: https://gitpod.io#https://github.com/YOUR_GITHUB_ID/opentelemetry.io.

    Note: If you have the necessary permissions to work from this repo, or just want to look around, open https://gitpod.io/#https://github.com/open-telemetry/opentelemetry.io.

Gitpod will automatically install the repo-specific packages for you. You're now ready to build, serve and/or make updates to the website files.

Local setup

  1. Fork and then clone this repo.

  2. Change to the repo directory.

  3. Install or upgrade to the active LTS release of Node.js. We recommend using nvm to manage your Node installation. Under Linux, run the following command (which will install/upgrade to the version specified in .nvmrc):

    $ nvm install

    To install under Windows, use nvm-windows:

    > nvm install lts && nvm use lts

  4. Get npm packages and other prerequisites:

    $ npm install

You're now ready to build, serve and/or make updates to the website files.

Build

To build the site run:

$ npm run build

You'll find the generated site files under public.

Serve

To serve the site run:

$ npm run serve

The site will be served at localhost:1313.

If you need to test Netlify redirects, use the following command, and visit the site at localhost:8888:

$ npm run serve:netlify

Note 1: The serve command serves files from memory, not from disk.

Note 2: See an error like too many open files or pipe failed under macOS? You may need to increase the file descriptor limit. See Hugo issue #6109.

Content and submodules

The website is built from the following content:

  • Files under content/, static/, etc. per Hugo defaults.
  • Mount points, defined in hugo.yaml under mounts.
  • Content from git submodules under content-modules.

Note that nonstandard mount points and symlinked sections under content/ refer to directories under content-modules, and no where else.

Found a problem?

If you find a problem with the content of this repo, or you would like to request an enhancement, create an issue.

NOTE: As a general policy, we only assign issues to community members who have already made contributions to the OpenTelemetry organization.

Submitting a change

Enhancements and fixes to the website are most welcome! Before submitting a pull request (PR) to the repo, run the following command and address any reported issues:

$ npm run test

If you only want to check the format of files, run:

$ npm run check:format
...
Checking formatting...
All matched files use Prettier code style!

To fix the format of files, run:

$ npm run format

Submodule changes

If you change any content inside of a content-modules submodule, then you'll need to first submit a PR (containing the submodule changes) to the submodule's repo. Only after the submodule PR has been accepted, can you update the submodule and have the changes appear in this website.

It is easiest to manage your content-modules changes by working with the repo that the corresponding submodule is linked to, rather than inside the submodule itself.

For expert contributors, you can work directly in the submodule. You'll then be able to directly build and serve your (submodule) changes. By default, the CI scripts get submodules on every invocation. To prevent this behavior while you work within a submodule, set the environment variable GET="no". You'll also need to git fetch --unshallow the submodule before you can submit a PR. Alternatively, set DEPTH="100" and re-fetch submodules.

Site deploys and PR previews

If you submit a PR, Netlify will create a deploy preview so that you can review your changes. Once your PR is merged, Netlify deploys the updated site to the production server.

Note: PR previews include draft pages, but production builds do not.

To see deploy logs and more, visit project's dashboard -- Netlify login required.