Skip to content

Commit

Permalink
Add a note about serving docs locally or on personal forks
Browse files Browse the repository at this point in the history
  • Loading branch information
peytondmurray committed Oct 4, 2024
1 parent 74aee82 commit 9fc158b
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -301,3 +301,10 @@ newly published version.

When a new commit is made to the `master`, the documentation is built and
automatically uploaded to github pages.

If you want to see the changes to the documentation when rendered, run `mkdocs
serve` to build the documentation and serve it locally. Alternatively, if you
merge your own changes to your own fork's `master` branch, this workflow will
serve the documentation at `https://<your-github-username>.github.io/tfx`. This
provides a convenient way for developers to check deployments before they merge
a PR to the upstream `tfx` repository.

0 comments on commit 9fc158b

Please sign in to comment.