Thanks to visit codestin.com
Credit goes to github.com

Skip to content

adding build preview instructions to contribution guide #6056

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Feb 15, 2024
Merged

adding build preview instructions to contribution guide #6056

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
66a100d
adding build preview instructions to contribution guide
cmastr Feb 14, 2024
2f5a61a
Update CONTRIBUTING.md
cmastr Feb 15, 2024
fa0f0a4
Update CONTRIBUTING.md
cmastr Feb 15, 2024
9de6d4c
Update CONTRIBUTING.md
cmastr Feb 15, 2024
54306f4
Update CONTRIBUTING.md
cmastr Feb 15, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,16 @@ Sources pages check if the source is a cloud-app, then include information about

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).

## Building a preview

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.

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:

https://github.com/segmentio/segment-docs/pull/6051#issuecomment-1942723573

You can rebuild the preview by adding a new commit with `[netlify-build]` in the commit message.

### Front matter

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.
Expand Down