Skip to content

Commit 9089045

Browse files
authored
Merge pull request #6056 from segmentio/updating_contributing_readme
adding build preview instructions to contribution guide
2 parents 7a972cb + 54306f4 commit 9089045

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
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.

0 commit comments

Comments
 (0)