Skip to content

"mvn verify" should catch bugs in the docs #12583

@mikemccand

Description

@mikemccand

I'm not sure how to implement this but I think it's important for the quality of our docs.

In Apache Lucene, if I mess up javadocs, "ant compile" or "ant pre-commit" will catch it.

But for ES, I think (?) I must clone the docs repo (https://github.com/elastic/docs) and follow its steps to make sure all is good.

Can we make this easier somehow, e.g. fold it under "mvn verify"?

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions