spring-projects / spring-projects/spring-security

Create a dedicated/obvious menu item to arrive quickly to "Lambda DSL" for Reference Documentation

Open
#13,606 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

status: waiting-for-triage type: enhancement
Dominant language
Java
Stars
9.6k
Forks
6.3k
Avg merge
2d 11h
Merged PRs (30d)
52

Description

Expected Behavior

Do more intuitive to know how to arrive to the Use the Lambda DSL section for the Reference Documentation

Current Behavior

If I want to know since when and for what was added Lambda DSL I must do the following:

  • Preparing for 7.0 -> Configuration

But observe, IMHO, it is located in an illogical section. Is not obvious that the desired information is located there.

Note: The Use the Lambda DSL section is very valuable to understand that since 5.2 Lambda DSL is available and due the 2 reasons explained after of the This has been done mainly for a couple of reasons sentence. Well covered the information, but: what could be relation between 5.2 and 7? Therefore, is not obvious that for the current location I should be able to get info about Lambda DSL.

Context

  • How has this issue affected you?

I arrived there due other reason of researching and not due a simple search by Google.

Right now is not obvious what section, as menu item, of the vertical menu must be selected/clicked to arrive to some section indicating that valuable information about of Lambda DSL

  • What are you trying to accomplish?

Use the Vertical Menu located of the left of the current Reference Documentation to detect straightly and obviously a link that indicates the Lambda DSL section

  • What other alternatives have you considered?

None, It seems the best approach is create a new section as menu item for the current Vertical Menu

  • Are you aware of any workarounds?

No

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

Locate the Reference Documentation's vertical menu and the existing Use the Lambda DSL section. Add an obvious dedicated menu item that leads directly to that section, then verify the navigation reaches the intended content.

Written by the indexing model from the issue text.

Assessment

Tech stack
java, spring
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.