Skip to content

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

Description

@karenzone

Pros:

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.

Activity

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions