Repository files navigation

Here, you can contribute to the Segment Documentation site.

Note: On Friday, October 1st, the default branch of this repository was changed frommaster todevelop. If you have a fork ofsegment-docs, please ensure the default branch of the fork is updated accordingly.

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

In this article, find information about:

• Prerequisites
• Contributing
• A list of READMEs
• Code of conduct
• License agreement

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

1. Download and install a source code editor likeVisual Studio Code.
2. Download and install a package manager such asHomebrew to install new software.
3. Create an account on GitHub if you don't have one already, or sign in with your existing GitHub account.
4. Add the GitHub extension to your editor (in VSC:https://marketplace.visualstudio.com/items?itemName=GitHub.vscode-pull-request-github).
5. Clone the Segment docs repo.
6. Download and install the latest version ofnode.js. Consider using a version manager such asASDF ornvm-windows.
7. Install dependenciesnpm i
8. Installvale. AnASDF plugin is also available.

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.

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.

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, seeContributing and theDeveloper Guide.

• Contributing
• Style Guide
• Developer Guide

Shield:

This work is licensed under aCreative Commons Attribution 4.0 International License.