Cwikius-Spring
/
spring-security
mirror of https://github.com/spring-projects/spring-security.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add messaging to documentation about sample migration 

Closes gh-9815
This commit is contained in:
Marcus Hert da Coregio 2021-05-26 17:01:15 -03:00 committed by Marcus Hert Da Coregio
parent 3219fd554d
commit d60981fd59
5 changed files with 27 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/guides/spring-security-docs-guides.gradle
View File

@ -5,6 +5,8 @@ asciidoctor {
baseDir = file('src/docs/asciidoc')
options eruby: 'erubis'
def ghTag = snapshotBuild ? 'main' : project.version
def ghSamplesUrl = "https://github.com/spring-projects/spring-security-samples/tree/$ghTag"
attributes copycss : '',
icons : 'font',
'source-highlighter': 'prettify',
@ -17,7 +19,9 @@ asciidoctor {
'spring-security-version' : project.version,
'download-url' : getDownloadUrl(),
'include-maven-repository' : getMavenRepositoryInclude(),
revnumber : project.version
revnumber : project.version,
'gh-samples-url': ghSamplesUrl,
'gh-old-samples-url': "https://github.com/spring-projects/spring-security/tree/5.4.x/samples"
}
ext.spec = copySpec {

7
docs/guides/src/docs/asciidoc/_includes/setting-up-the-sample-boot.asc
View File

@ -16,7 +16,12 @@ This section outlines how to setup a workspace within https://spring.io/tools/st
=== Obtaining the sample project
Extract the {download-url}[Spring Security Distribution] to a known location and remember it as _SPRING_SECURITY_HOME_.
Clone the {gh-samples-url}[Spring Security Samples project] to a known location and remember it as _SPRING_SECURITY_HOME_.
[NOTE]
====
These samples are being migrated to a separate project, however, you can still find
the not migrated samples in an older branch of the {gh-old-samples-url}[Spring Security repository].
====
=== Import the {starter-appname} sample application

7
docs/guides/src/docs/asciidoc/_includes/setting-up-the-sample.asc
View File

@ -16,7 +16,12 @@ This section outlines how to setup a workspace within https://spring.io/tools/st
=== Obtaining the sample project
Extract the {download-url}[Spring Security Distribution] to a known location and remember it as _SPRING_SECURITY_HOME_.
Clone the {gh-samples-url}[Spring Security Samples project] to a known location and remember it as _SPRING_SECURITY_HOME_.
[NOTE]
====
These samples are being migrated to a separate project, however, you can still find
the not migrated samples in an older branch of the {gh-old-samples-url}[Spring Security repository].
====
=== Import the {starter-appname} sample application

5
docs/manual/spring-security-docs-manual.gradle
View File

@ -16,11 +16,14 @@ asciidoctor {
asciidoctorj {
def ghTag = snapshotBuild ? 'main' : project.version
def ghUrl = "https://github.com/spring-projects/spring-security/tree/$ghTag"
def ghOldSamplesUrl = "https://github.com/spring-projects/spring-security/tree/5.4.x/samples"
def ghSamplesUrl = "https://github.com/spring-projects/spring-security-samples/tree/$ghTag"
attributes 'spring-security-version' : project.version,
'spring-boot-version' : springBootVersion,
revnumber : project.version,
'gh-url': ghUrl,
'gh-samples-url': "$ghUrl/samples"
'gh-samples-url': ghSamplesUrl,
'gh-old-samples-url': ghOldSamplesUrl
attributeProvider resolvedVersions(project.configurations.testRuntimeClasspath)
}

6
docs/manual/src/docs/asciidoc/_includes/about/samples.adoc
View File

@ -2,3 +2,9 @@
= Samples
Spring Security includes many {gh-samples-url}[samples] applications.
[NOTE]
====
These samples are being migrated to a separate project, however, you can still find
the not migrated samples in an older branch of the {gh-old-samples-url}[Spring Security repository].
====