google / google/sbsim

Documentation Site - Staging Previews

Open
#116 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
123
Forks
56
Avg merge
17d 18h
Merged PRs (30d)
3

Description

Right now when someone submits a PR that contains updated docstrings or changes to the documentation site, we need to pull down the code and run the documentation site locally to preview the changes.

However it would be nice to implement an automated workflow whereby on each PR we are able to view the updated documentation site on a PR-specific staging server.

Alternatively, if having separate PR-specific servers isn't feasible or practical, we can have a repo maintainer manually run a command to deploy the documentation site from a given branch to a single staging preview server. This should be fine because most often we would only be concerned with previewing one PR at a time.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.