Skip to content

Maintain the list of reference documentation authors in a single place #20896

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

Closed
wilkinsona opened this issue Apr 9, 2020 · 3 comments
Closed
Assignees
Labels
type: task A general task
Milestone

Comments

@wilkinsona
Copy link
Member

wilkinsona commented Apr 9, 2020

The authors are currently listed in multiple places:

  • index.htmladoc, index.htmlsingleadoc, and spring-boot-reference.pdfadoc in 2.2.x
  • index.adoc, and index.singleadoc in master

To guarantee that the list of authors is the same across the HTML, HTML single, and PDF documentation, we should try to list the authors in a separate file that is included in each index file.

@wilkinsona wilkinsona added the type: task A general task label Apr 9, 2020
@wilkinsona wilkinsona added this to the 2.2.x milestone Apr 9, 2020
@cicioflaviu
Copy link
Contributor

Can I take this task?

@wilkinsona
Copy link
Member Author

Thanks for the offer, @cicioflaviu, but I think we should figure out what's going on with #20934 first.

@wilkinsona
Copy link
Member Author

While researching #20934, I learned that multiple authors should be separated by semi-colons and not commas as we currently do. We can take care of that at the same time as switching to a single source for the list of authors.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: task A general task
Projects
None yet
Development

No branches or pull requests

2 participants