maverick/docbrown
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add a note to clarify deploy preview link (#5800)

Browse source 
We never explicitly say that the deploy preview link only is applicable to docs changes, but we probably should!
This commit is contained in:
Vaidehi Joshi 2020-01-28 15:19:09 -08:00 • committed by GitHub
parent a19ce5518e
commit d36faa6462
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
docs/contributing.md
View file

@ -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