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

Fix Authors attribute #3214

Merged
merged 1 commit into from
Apr 30, 2024
Merged

Fix Authors attribute #3214

merged 1 commit into from
Apr 30, 2024

Conversation

pderop
Copy link
Contributor

@pderop pderop commented Apr 30, 2024

currently, authors are declared in two places:

  • in docs/modules/ROOT/pages/about-doc.adoc: authors are declared in the Multiple authors line, in the start page (about-adoc.adoc). Authors are then displayed when browsing antora documentation (in the start page).

  • in antora.yml, using an author attribute: this was attempt to make the authors also appearing in the front page of the generated pdf.

But the authors are not currently included in the front page of the PDF.

this PR moves the author attribute from the antora attributes to the asciidoc attributes in the antora.yml, and this fixes the problem: authors are now displayed in the front page of the generated PDF.

@pderop pderop added the type/documentation A documentation update label Apr 30, 2024
@pderop pderop added this to the 1.2.0-M2 milestone Apr 30, 2024
@pderop pderop self-assigned this Apr 30, 2024
@pderop pderop requested a review from a team April 30, 2024 08:46
@pderop
Copy link
Contributor Author

pderop commented Apr 30, 2024

To test the PR:

  • switch to jdk17
  • ./gradlew antora -PforcePdf
  • check front page from PDF: ./docs/build/assembler/reactor-netty/1.2.0/reactor-netty-reference-guide.pdf

@pderop
Copy link
Contributor Author

pderop commented Apr 30, 2024

@violetagg , thanks!

@pderop pderop merged commit cbc8a5d into reactor:main Apr 30, 2024
12 of 14 checks passed
@pderop pderop deleted the fix-author-attribute branch April 30, 2024 10:13
pderop added a commit that referenced this pull request Apr 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type/documentation A documentation update
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants