Skip to content

Commit 9fc158b

Browse files
committed
Add a note about serving docs locally or on personal forks
1 parent 74aee82 commit 9fc158b

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

CONTRIBUTING.md

+7
Original file line numberDiff line numberDiff line change
@@ -301,3 +301,10 @@ newly published version.
301301

302302
When a new commit is made to the `master`, the documentation is built and
303303
automatically uploaded to github pages.
304+
305+
If you want to see the changes to the documentation when rendered, run `mkdocs
306+
serve` to build the documentation and serve it locally. Alternatively, if you
307+
merge your own changes to your own fork's `master` branch, this workflow will
308+
serve the documentation at `https://<your-github-username>.github.io/tfx`. This
309+
provides a convenient way for developers to check deployments before they merge
310+
a PR to the upstream `tfx` repository.

0 commit comments

Comments
 (0)