From 66a100d2e5465b17e182c6e340f26f4ff4ddd63d Mon Sep 17 00:00:00 2001 From: Casie Oxford Date: Wed, 14 Feb 2024 09:32:29 -0600 Subject: [PATCH 1/5] adding build preview instructions to contribution guide --- CONTRIBUTING.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 23476a66c2..393011ff63 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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. From 2f5a61a47d4ca718b8817a8da775dee1aa72ad69 Mon Sep 17 00:00:00 2001 From: Casie Oxford Date: Thu, 15 Feb 2024 09:39:33 -0600 Subject: [PATCH 2/5] Update CONTRIBUTING.md Co-authored-by: pwseg <86626706+pwseg@users.noreply.github.com> --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 393011ff63..efb6c2af2a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -79,7 +79,7 @@ Content with in each `.md` file is markdown. For information about styling, and ## 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. +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: From fa0f0a462d2a7a0775ada834a0a7bd0be5c9259e Mon Sep 17 00:00:00 2001 From: Casie Oxford Date: Thu, 15 Feb 2024 09:39:43 -0600 Subject: [PATCH 3/5] Update CONTRIBUTING.md Co-authored-by: pwseg <86626706+pwseg@users.noreply.github.com> --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index efb6c2af2a..30714f24fe 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -85,7 +85,7 @@ To build a preview site, add `netlify-build` to a commit message on your PR. Her 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. +You can rebuild the preview by adding a new commit with `[netlify-build]` in the commit message. ### Front matter From 9de6d4cbc6b429c093ef2bbf90fec06ff7a1bbdd Mon Sep 17 00:00:00 2001 From: Casie Oxford Date: Thu, 15 Feb 2024 09:39:51 -0600 Subject: [PATCH 4/5] Update CONTRIBUTING.md Co-authored-by: pwseg <86626706+pwseg@users.noreply.github.com> --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 30714f24fe..0304ced007 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -81,7 +81,7 @@ Content with in each `.md` file is markdown. For information about styling, and 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: +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 From 54306f4f418c541af6fc084c067da9f424334c3e Mon Sep 17 00:00:00 2001 From: Casie Oxford Date: Thu, 15 Feb 2024 09:39:59 -0600 Subject: [PATCH 5/5] Update CONTRIBUTING.md Co-authored-by: pwseg <86626706+pwseg@users.noreply.github.com> --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0304ced007..211033363a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -77,7 +77,7 @@ 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 +## 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.