Skip to content

Commit 425d008

Browse files
Add messaging to documentation about sample migration
Closes gh-9815
1 parent b73104c commit 425d008

File tree

5 files changed

+27
-4
lines changed

5 files changed

+27
-4
lines changed

docs/guides/spring-security-docs-guides.gradle

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ asciidoctor {
55
baseDir = file('src/docs/asciidoc')
66
options eruby: 'erubis'
77

8+
def ghTag = snapshotBuild ? 'main' : project.version
9+
def ghSamplesUrl = "https://github.com/spring-projects/spring-security-samples/tree/$ghTag"
810
attributes copycss : '',
911
icons : 'font',
1012
'source-highlighter': 'prettify',
@@ -17,7 +19,9 @@ asciidoctor {
1719
'spring-security-version' : project.version,
1820
'download-url' : getDownloadUrl(),
1921
'include-maven-repository' : getMavenRepositoryInclude(),
20-
revnumber : project.version
22+
revnumber : project.version,
23+
'gh-samples-url': ghSamplesUrl,
24+
'gh-old-samples-url': "https://github.com/spring-projects/spring-security/tree/5.4.x/samples"
2125
}
2226

2327
ext.spec = copySpec {

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

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,12 @@ This section outlines how to setup a workspace within https://spring.io/tools/st
1616

1717
=== Obtaining the sample project
1818

19-
Extract the {download-url}[Spring Security Distribution] to a known location and remember it as _SPRING_SECURITY_HOME_.
19+
Clone the {gh-samples-url}[Spring Security Samples project] to a known location and remember it as _SPRING_SECURITY_HOME_.
20+
[NOTE]
21+
====
22+
These samples are being migrated to a separate project, however, you can still find
23+
the not migrated samples in an older branch of the {gh-old-samples-url}[Spring Security repository].
24+
====
2025

2126
=== Import the {starter-appname} sample application
2227

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

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,12 @@ This section outlines how to setup a workspace within https://spring.io/tools/st
1616

1717
=== Obtaining the sample project
1818

19-
Extract the {download-url}[Spring Security Distribution] to a known location and remember it as _SPRING_SECURITY_HOME_.
19+
Clone the {gh-samples-url}[Spring Security Samples project] to a known location and remember it as _SPRING_SECURITY_HOME_.
20+
[NOTE]
21+
====
22+
These samples are being migrated to a separate project, however, you can still find
23+
the not migrated samples in an older branch of the {gh-old-samples-url}[Spring Security repository].
24+
====
2025

2126
=== Import the {starter-appname} sample application
2227

docs/manual/spring-security-docs-manual.gradle

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,11 +16,14 @@ asciidoctor {
1616
asciidoctorj {
1717
def ghTag = snapshotBuild ? 'main' : project.version
1818
def ghUrl = "https://github.com/spring-projects/spring-security/tree/$ghTag"
19+
def ghOldSamplesUrl = "https://github.com/spring-projects/spring-security/tree/5.4.x/samples"
20+
def ghSamplesUrl = "https://github.com/spring-projects/spring-security-samples/tree/$ghTag"
1921
attributes 'spring-security-version' : project.version,
2022
'spring-boot-version' : springBootVersion,
2123
revnumber : project.version,
2224
'gh-url': ghUrl,
23-
'gh-samples-url': "$ghUrl/samples"
25+
'gh-samples-url': ghSamplesUrl,
26+
'gh-old-samples-url': ghOldSamplesUrl
2427
attributeProvider resolvedVersions(project.configurations.testRuntimeClasspath)
2528
}
2629

docs/manual/src/docs/asciidoc/_includes/about/samples.adoc

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,9 @@
22
= Samples
33

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

0 commit comments

Comments
 (0)