Skip to content
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.

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

Update YAML metadata generation for asciidoc files #28491

Merged
merged 1 commit into from Oct 11, 2022

Conversation

ebullient
Copy link
Contributor

@ebullient ebullient commented Oct 10, 2022

Resolves #28480

errorsByFile.yaml:

.../docs/src/main/asciidoc/lra.adoc:
- Document does not have a preamble.
- Document does not follow naming conventions (type not recognized).
- Document does not define an id.
- Document does not specify associated categories

indexByFile.yaml:

...
doc-contribute-docs-howto.adoc:
  title: How to contribute documentation
  filename: doc-contribute-docs-howto.adoc
  summary: Outline the recommended steps for making successful contributions to Quarkus
    documentation.
  categories:
  - contributing
  id: howto-contribute-docs
  type: howto
...

indexByType.yaml:

types:
  reference:
    id: reference
    name: Reference
    index:
      ...
      doc-reference.adoc:
        title: About Quarkus documentation
        filename: doc-reference.adoc
        summary: A detailed reference for the structure and composition of Quarkus
          documentation.
        categories:
        - contributing
        id: reference-doc-quarkus-documentation
        type: reference
      ...

@quarkus-bot

This comment has been minimized.

@ebullient ebullient moved this from To do to In progress in Quarkus Documentation Oct 10, 2022
@ebullient ebullient moved this from In progress to Review pending in Quarkus Documentation Oct 10, 2022
Quarkus Documentation automation moved this from Review pending to Reviewer approved Oct 11, 2022
@gsmet gsmet merged commit be0f868 into quarkusio:main Oct 11, 2022
Quarkus Documentation automation moved this from Reviewer approved to Done Oct 11, 2022
@quarkus-bot quarkus-bot bot added this to the 2.14 - main milestone Oct 11, 2022
@gsmet
Copy link
Member

gsmet commented Oct 11, 2022

Ah sorry I was too quick to merge. Thought you might want this in sooner rather than later. @maxandersen @michelle-purcell feel free to comment, if there's a big issue, I'll rollback and create a new PR.

@ebullient
Copy link
Contributor Author

I think we can fail forward, @gsmet. :) Thank you!

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

Successfully merging this pull request may close these issues.

Docs: YAML Generator changes
4 participants