Skip to content

Commit 5314af2

Browse files
committed
Merge branch 'develop' into update-pendo-destination-urls
2 parents 1a3a7e2 + d3f33b1 commit 5314af2

File tree

78 files changed

+5702
-1824
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

78 files changed

+5702
-1824
lines changed

CONTRIBUTING.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,16 @@ Sources pages check if the source is a cloud-app, then include information about
7777

7878
Content with in each `.md` file is markdown. For information about styling, and available extensions, see `_src/utils/formatguide.md` or the live version [here](https://segment.com/docs/utils/formatguide).
7979

80+
## Building a preview
81+
82+
Netlify allows you to build a preview environment on any PR you create in GitHub. This is helpful when you want to send out a review, and the formatting and design are important to those reviewers.
83+
84+
To build a preview site, add `[netlify-build]` to a commit message on your PR. Here's an example of what the preview build will look like:
85+
86+
https://github.com/segmentio/segment-docs/pull/6051#issuecomment-1942723573
87+
88+
You can rebuild the preview by adding a new commit with `[netlify-build]` in the commit message.
89+
8090
### Front matter
8191

8292
Repository Markdown files often contain front matter metadata, which you'll find at the top of the file. These front matter variables instruct Jekyll how to build and render the page as HTML.

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,25 @@ This repository contains the documentation website code and source files for htt
1111

1212
In this article, find information about:
1313

14+
- Prerequisites
1415
- Contributing
1516
- A list of READMEs
1617
- Code of conduct
1718
- License agreement
1819

20+
## Prerequisites
21+
The following are a list of prerequisites you may want to consider downloading and installing to successfully contribute to the Segment docs repo:
22+
23+
1. Download and install a source code editor like [Visual Studio Code](https://code.visualstudio.com/download).
24+
1. Download and install a package manager such as [Homebrew](https://brew.sh/) to install new software.
25+
1. [Create an account on GitHub](https://docs.github.com/en/get-started/quickstart/creating-an-account-on-github) if you don't have one already, or sign in with your existing GitHub account.
26+
1. Add the GitHub extension to your editor (in VSC: https://marketplace.visualstudio.com/items?itemName=GitHub.vscode-pull-request-github).
27+
1. [Clone](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository) the Segment docs repo.
28+
1. Download and install the latest version of [node.js](https://nodejs.org/en/download). Consider using a version manager such as [ASDF](https://github.com/asdf-vm/asdf) or [nvm-windows](https://docs.microsoft.com/en-us/windows/dev-environment/javascript/nodejs-on-windows).
29+
1. Install dependencies
30+
`npm i`
31+
1. Install [vale](https://docs.errata.ai/vale/install). An [ASDF plugin](https://github.com/osg/asdf-vale) is also available.
32+
1933
## Contributing
2034

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

src/_data/catalog/destination_categories.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# AUTOGENERATED FROM PUBLIC API. DO NOT EDIT
2-
# destination categories last updated 2024-02-13
2+
# destination categories last updated 2024-02-27
33
items:
44
- display_name: A/B Testing
55
slug: a-b-testing

0 commit comments

Comments
 (0)