Skip to content

Commit

Permalink
Add a note to clarify deploy preview link (#5800)
Browse files Browse the repository at this point in the history
We never explicitly say that the deploy preview link only is applicable to docs changes, but we probably should!
  • Loading branch information
vaidehijoshi committed Jan 28, 2020
1 parent a19ce55 commit d36faa6
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions docs/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,13 @@ This will start a server where you can browse the documentation:
If you add new pages or rename existing pages, you'll need to restart the server
for those changes to take effect.

Since our documentation is built on GitDocs, which is built on Netlify, you can
use the generated deploy preview link to check out your documentation changes.
Once you make a PR, click on "Show all checks" and find the "deploy/netlify"
row. If your deploy preview is ready, you can click on "Details" to see the
preview. Please note that the deploy preview only reflects any documentation
changes you make (and not any changes elsewhere in the app).

# Useful links

The docs are a collection of [Markdown files][markdown] that also utilize
Expand Down

0 comments on commit d36faa6

Please sign in to comment.