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

Improve Documentation #12508

Open
3 of 11 tasks
jzheaux opened this issue Jan 10, 2023 · 0 comments
Open
3 of 11 tasks

Improve Documentation #12508

jzheaux opened this issue Jan 10, 2023 · 0 comments
Assignees
Labels
in: docs An issue in Documentation or samples type: enhancement A general enhancement

Comments

@jzheaux
Copy link
Contributor

jzheaux commented Jan 10, 2023

Each section of Spring Security's reference manual should be reviewed in consideration of the following structure:

  • Start with "what to do"
    • show code samples that cover 90% of applications
    • show testing what was added
    • link to relevant Spring Security Sample commit diffs
    • link to the next relevant documentation step(s)
  • Follow with "how it works"
    • use diagrams to explain workflows
    • include tradeoffs and security principles
    • show tabular information
  • Follow with 10% usage

and the following principles:

  • Linked "what to dos" should make progressive sense together
  • Use headers for contextual linking
  • Favor the latest recommendations
  • Explain deprecated recommendations relative to the benefits of the latest ones
  • Not have outdated recommendations
  • Use XML/Java/Kotlin tabs
  • Link to other Spring projects; Framework, Data, Boot, MVC, etc.

Here are the sections that are planned so far:

@jzheaux jzheaux added in: docs An issue in Documentation or samples type: enhancement A general enhancement labels Jan 10, 2023
@jzheaux jzheaux self-assigned this Jan 10, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
in: docs An issue in Documentation or samples type: enhancement A general enhancement
Projects
None yet
Development

No branches or pull requests

1 participant