New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Discuss: Auto-merge `auto generated update of versioned plugin documentation` on clean docs-ci (and delete branch) #88

Open

2 tasks

karenzone opened this issue Mar 22, 2023 · 0 comments

Labels

VPR

Contributor

karenzone commented Mar 22, 2023

Pros:

Keeps plugin docs in Versioned Plugin Reference (VPR) up-to-date without manual review and merge.

Neutral:

Failing docs CI still would require manual troubleshooting and fixes to both output and source files.

Cons:

This is the last line of defense where I verify that plugin docs are of sufficient quality before they're merged.
Ideally, plugin docs have been throughly reviewed before PRs are merged, but a lot of less-than-ideal wording and formatting still gets through. Some of those things could be mitigated with improved CI/linking on the plugin repos as proposed in Add enhanced CI to capture common doc problems #84.

ToDo:

Make sure that the new content branch is deleted after merge to keep the docgen/PR process going.
Come up with some kind of [somewhat loud] alerting mechanism when there is a docs-ci failure.

karenzone added the VPR label

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment