Skip to content

Docs should point to samples in minor version branches #9986

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
marcusdacoregio opened this issue Jun 22, 2021 · 2 comments · Fixed by #10011
Closed

Docs should point to samples in minor version branches #9986

marcusdacoregio opened this issue Jun 22, 2021 · 2 comments · Fixed by #10011
Assignees
Labels
in: docs An issue in Documentation or samples status: backported An issue that has been backported to maintenance branches type: bug A general bug
Milestone

Comments

@marcusdacoregio
Copy link
Contributor

marcusdacoregio commented Jun 22, 2021

Expected Behavior
Spring Security docs links that point to Spring Security Samples should point to the minor version branches instead of the version tags. Instead of pointing to 5.5.1 for example, it should point to 5.5.x.

This way we don't have to release Spring Security Samples every time a Spring Security release is done.

This should be backported to 5.5.x.

Current Behavior

Today the docs are pointing to a specific version tag that doesn't have related samples release

@marcusdacoregio marcusdacoregio added in: docs An issue in Documentation or samples type: enhancement A general enhancement labels Jun 22, 2021
@marcusdacoregio marcusdacoregio added this to the 5.5.2 milestone Jun 22, 2021
@marcusdacoregio marcusdacoregio self-assigned this Jun 22, 2021
@marcusdacoregio marcusdacoregio changed the title Spring Security docs should point to samples in minor version branches Docs should point to samples in minor version branches Jun 22, 2021
@marcusdacoregio marcusdacoregio modified the milestones: 5.5.2, 5.6.0-M1 Jun 22, 2021
@marcusdacoregio marcusdacoregio added type: bug A general bug and removed type: enhancement A general enhancement labels Jun 28, 2021
marcusdacoregio added a commit to marcusdacoregio/spring-security that referenced this issue Jun 29, 2021
@spring-projects-issues spring-projects-issues added the status: backported An issue that has been backported to maintenance branches label Jul 1, 2021
@gtiwari333
Copy link

@marcusdacoregio
Copy link
Contributor Author

Hi @gtiwari333.

The current in the docs link of Spring Security refers to 5.5.1. Since this was merged for 5.6.0-M1 and 5.5.2 it should be fixed when we do the next release.

You can refer to the docs for the snapshot release, like so: https://docs.spring.io/spring-security/site/docs/5.5.2-SNAPSHOT/reference/html5/#servlet-saml2

akohli96 pushed a commit to akohli96/spring-security that referenced this issue Aug 25, 2021
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 status: backported An issue that has been backported to maintenance branches type: bug A general bug
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants