Skip to content

Generate previews for books affected by documentation changes #483

Closed
@lcawl

Description

@lcawl

Currently to preview their documentation changes, PR owners must build the appropriate book(s) locally. If there are multiple pages (or the layout of the book) affected, sometimes we build the books locally then host them on a website for easier review.

Rather than requiring PR owners to take these manual steps, we should integrate them in the PR process.

There are tools that facilitate generating and hosting previews automatically for PRs that contain doc changes. This would help authors quickly see if there are formatting errors and make a better overall review experience.

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementSomething we'd like to improve

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions