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

Update links to Spring Security's reference documentation #28618

Closed
rwinch opened this issue Nov 11, 2021 · 4 comments
Closed

Update links to Spring Security's reference documentation #28618

rwinch opened this issue Nov 11, 2021 · 4 comments
Labels
type: documentation A documentation update
Milestone

Comments

@rwinch
Copy link
Member

rwinch commented Nov 11, 2021

The docs group has made some changes to how the URLs are going to be handled. Spring Boot should update spring-security attribute to point to https://spring.io/projects/spring-security/reference

@spring-projects-issues spring-projects-issues added the status: waiting-for-triage An issue we've not yet triaged label Nov 11, 2021
@philwebb
Copy link
Member

Is it live yet? I get a 404 currently.

@wilkinsona
Copy link
Member

As discussed previously, it'd also be good to have a versioned URL so that someone reading a certain version of Boot's docs is linked to the matching version of Security's docs.

@rwinch
Copy link
Member Author

rwinch commented Nov 12, 2021

Is it live yet? I get a 404 currently.

Sorry it I pointed to the incorrect URL. It should be http://docs.spring.io/spring-security/reference/

As discussed previously, it'd also be good to have a versioned URL so that someone reading a certain version of Boot's docs is linked to the matching version of Security's docs.

The URL for a specific version is http://docs.spring.io/spring-security/reference/{version}

For example, http://docs.spring.io/spring-security/reference/5.6.0-RC1 is the link for 5.6.0-RC1. For now 5.6.0-RC1 is the latest release (there are no GA releases either), so it redirects to the versionless URL. The URL will stop redirecting once there is a newer version available. Similarly, http://docs.spring.io/spring-security/reference/5.6 will always point to the latest 5.6.x release. For now it redirects to the versionless URL, but once there is a newer GA version available 5.6 will stop redirecting to the versionless URL and point to the latest patch release. This logic is very similar to the symlinks we currently use, but uses redirects instead.

@philwebb philwebb added type: documentation A documentation update and removed status: waiting-for-triage An issue we've not yet triaged labels Nov 15, 2021
@philwebb philwebb added this to the 2.6.x milestone Nov 15, 2021
@wilkinsona
Copy link
Member

Thanks, Rob.

We currently take the actual Security version and then remove the last . and anything that follows it:

def securityVersion = versionConstraints["org.springframework.security:spring-security-core"]
securityVersion = securityVersion.substring(0, securityVersion.lastIndexOf("."))

I think that'll continue to work although I wonder if it's exactly what we want. https://docs.spring.io/spring-security/reference/5.6.0-SNAPSHOT and https://docs.spring.io/spring-security/reference/5.6.1-SNAPSHOT are not found so it looks like we have to do something for -SNAPSHOT versions, but it also sounds like we could leave other versions (5.6.0-RC1, 5.6.0, 5.6.1, and so on) unchanged and they would work.

@philwebb philwebb modified the milestones: 2.6.x, 2.6.0 Nov 17, 2021
@wilkinsona wilkinsona changed the title Update spring-security URL Update links to Spring Security's reference documentation Nov 18, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: documentation A documentation update
Projects
None yet
Development

No branches or pull requests

4 participants