Welcome to Segment’s Documentation Repository

Here, you can contribute to the Segment Documentation site.

Note: On Friday, October 1st, the default branch of this repository was changed from master to develop. If you have a fork of segment-docs, please ensure the default branch of the fork is updated accordingly.

Overview

This repository contains the documentation website code and source files for https://segment.com/docs.

In this article, find information about:

Prerequisites
Contributing
A list of READMEs
Code of conduct
License agreement

Prerequisites

The following are a list of prerequisites you may want to consider downloading and installing to successfully contribute to the Segment docs repo:

Download and install a source code editor like Visual Studio Code.
Download and install a package manager such as Homebrew to install new software.
Create an account on GitHub if you don't have one already, or sign in with your existing GitHub account.
Add the GitHub extension to your editor (in VSC: https://marketplace.visualstudio.com/items?itemName=GitHub.vscode-pull-request-github).
Clone the Segment docs repo.
Download and install the latest version of node.js. Consider using a version manager such as ASDF or nvm-windows.
Install dependencies npm i
Install vale. An ASDF plugin is also available.

Contributing

The Segment docs team accepts contributions in the form of issues and pull requests.

All accepted contributions, in the form of approved pull requests and resolved issues, are deployed twice weekly, on Tuesday and Thursdays. As a result, once your pull request is closed, or your issue resolved, you may not see these changes on the site immediately.

Issues

If you see an error or something incorrect on a specific page, click Request docs change to create an issue to bring it to the team’s attention.

Pull Requests

If you would like to update the documentation yourself, create a Pull Request to bring it to the team’s attention. Click Edit this page to edit the page directly on GitHub. Alternatively, you can clone the repository and submit your Pull Request that way. For more information, see Contributing and the Developer Guide.