spring-projects / spring-projects/spring-security

Add a configuring spring security section to the introduction part of the docs

Open
#8,194 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

in: docs type: enhancement
Dominant language
Java
Stars
9.6k
Forks
6.3k
Avg merge
2d 11h
Merged PRs (30d)
52

Description

There are lots of ways to configure spring security, xml, java config classic, java config lambdas, boot auto configuration. The internet is full of blog posts, stackoveflow questions, on how to configure spring security to do x, or y. Many of these posts are out of date, it is super confusing to know if you are doing things right. Given that a misconfiguration of spring security in an application can be devastating for the business running the application. I recommend adding an authoritative chapter on configuring security to the introduction part of the docs. Below is a proposed outline of the chapter.

  • Overview section that provides a summary of the all the different options for configuring spring. For each configuration approach provide and 1 paragraph description of the approach, it's historical evolution, which version of spring security it was introduced in. Will be supported into the future.
  • Recommenced approach A section that provides clear guidance on what approach is recommend as of that version of the spring security, for different situations, boot vs. not boot ... etc.
  • Java Config DSL Overview A section that provides an overview of the Java configuration DSL, how it works, how to format the code when working with it ... etc. This is the big picture that a user needs to know to understand the rest of the docs.
  • Kotlin Support a section that explains how kotlin supports work.
  • XML Config Overview A section that provides an overview of the XML config. This is the big picture that a user needs to know to understand the rest of the docs.
  • migrating from xml to java config A section that provides hints on how to migrate from xml to javaconfig

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue names no specific files or tests. Start by reviewing the existing introduction and configuration documentation, then map the proposed sections against current XML, Java configuration, Kotlin, and Boot guidance. Done means adding an authoritative chapter that covers the outlined approaches, recommendations, DSL overviews, and migration guidance.

Written by the indexing model from the issue text.

Assessment

Tech stack
java, kotlin
Domain
documentation, security
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.