Find/replace for Spring Authorization Server

README.adoc

@@ -1,4 +1,4 @@
-= Spring Security Docs Home
+= Spring Authorization Server Docs Home
 ifndef::env-github[:toc:]
 ifdef::env-github[]
 :important-caption: :exclamation:
@@ -9,10 +9,10 @@ This README describes the processes and tools used to build the documentation fo
 
 == Overview
 
-The Spring Security reference docs are generated using Antora.
+The Spring Authorization Server reference docs are generated using Antora.
 The Gradle Antora Plugin is used as the primary interface to Antora.
 
-You're viewing the playbook branch for the Spring Security project.
+You're viewing the playbook branch for the Spring Authorization Server project.
 The playbook branch hosts the docs build used to build and publish the production docs site, and is thus the documentation home base.
 If you're a docs developer, you'll mostly work in this branch.
 If you're a writer, you'll mostly work in software branches.
@@ -21,8 +21,8 @@ If you're a writer, you'll mostly work in software branches.
 
 The playbook branch, named *docs-build*, hosts the primary documentation build.
 The documentation itself is located in a dedicated subproject in each software branch (i.e., the docs are stored alongside the code).
-Software branches, also referred to as release line branches or content branches, follow the pattern `major.minor.x` (e.g., 6.0.x), or `main` for the latest release line.
-Software tags follow the pattern `major.minor.patch` (e.g., 6.0.1).
+Software branches, also referred to as release line branches or content branches, follow the pattern `major.minor.x` (e.g., 1.1.x), or `main` for the latest release line.
+Software tags follow the pattern `major.minor.patch` (e.g., 1.1.1).
 The latest version of the docs for each release line is always sourced from a tag.
 The release line branches host the prerelease materials for the next version.
 
@@ -53,7 +53,7 @@ In order to access other versions that are published, the URL must be known in a
 == Usage
 
 To prepare your system for building the documentation, <<prerequisites,install the prerequisites>>, then <<prepare-workspace,prepare your workspace>>.
-Then you can build the documentation in either the main branch or 6.0.x branch.
+Then you can build the documentation in either the main branch or 1.1.x branch.
 
 .Branch checkout instead of worktrees
 [NOTE]
@@ -92,22 +92,22 @@ Your workspace will be the folder that contains the git worktrees of the project
 
 . In your terminal, create a directory for the project and then change into that directory.
 
- $ mkdir spring-security
- $ cd spring-security
+ $ mkdir spring-authorization-server
+ $ cd spring-authorization-server
 
 . Clone the project repository and create the worktree for the main branch.
 Then change into the new *main* worktree.
 
- $ git clone https://github.com/spring-projects/spring-security main
+ $ git clone https://github.com/spring-projects/spring-authorization-server main
  $ cd main
 
-. Set up a worktree for the 6.0.x branch by running the following commands:
+. Set up a worktree for the 1.1.x branch by running the following commands:
 
- $ git worktree add ../6.0.x 6.0.x --track
+ $ git worktree add ../1.1.x 1.1.x --track
 
-. Repeat the last step for all release line branches (e.g., 5.8.x, 5.7.x, etc) you intend to work with.
+. Repeat the last step for all release line branches (e.g., 0.4.x, 1.0.x, etc) you intend to work with.
 
-Now you're ready to build the docs in the main or 6.0.x branches.
+Now you're ready to build the docs in the main or 1.1.x branches.
 
 === Build the documentation in the main branch (writers)
 
@@ -125,7 +125,7 @@ SDKMAN! will switch to the required JDK, provisioning it first if it isn't alrea
 . Generate the documentation with Antora using the following command:
 +
 --
- $ ./gradlew -PbuildSrc.skipTests=true :spring-security-docs:antora
+ $ ./gradlew -PbuildSrc.skipTests=true :spring-authorization-server-docs:antora
 
 You can also run this command directly from the _docs_ folder:
 
@@ -139,13 +139,13 @@ The retrieved playbook file will be cached as _cached-antora-playbook.yml_.
 
 . Navigate to the local file URI shown in the terminal to view the generated documentation.
 
-=== Build the documentation in the 6.0.x branch (writers)
+=== Build the documentation in the 1.1.x branch (writers)
 
 NOTE: The instructions in this section assume you've completed the steps in <<prepare-workspace>>.
 
-. First, change to the *6.0.x* worktree.
+. First, change to the *1.1.x* worktree.
 
- $ cd ../6.0.x
+ $ cd ../1.1.x
 
 . Switch to the required JDK using SDKMAN! by running the following command:
 +
@@ -158,9 +158,9 @@ SDKMAN! will switch to the required JDK, provisioning it first if it isn't alrea
 . Generate the documentation with the following command:
 +
 --
- $ ./gradlew -PbuildSrc.skipTests=true :spring-security-docs:antora
+ $ ./gradlew -PbuildSrc.skipTests=true :spring-authorization-server-docs:antora
 
-This command will build the documentation for the *6.0.x* branch.
+This command will build the documentation for the *1.1.x* branch.
 The Antora playbook is retrieved by the playbook provider from the *docs-build* branch.
 The retrieved playbook file will be cached as _cached-antora-playbook.yml_.
 --
@@ -294,7 +294,7 @@ A partial build is a single version sources from a single git reference.
 A partial build requested by git reference using the CI workflow variable *build-refname*.
 Here's an example of how to trigger the CI workflow for a partial build:
 
- $ gh workflow run deploy-docs.yml --repo spring-projects/spring-security --ref docs-build -f build-refname=5.7.x
+ $ gh workflow run deploy-docs.yml --repo spring-projects/spring-authorization-server --ref docs-build -f build-refname=1.1.x
 
 The partial build is coordinated by the Antora Atlas extension and set up by the @springio/antora-extensions/partial-build-extension extension.
 See https://github.com/spring-io/antora-extensions#partial-build[Partial Build] for a detailed explanation of the partial build extension and how to configure it.
@@ -327,17 +327,17 @@ You can trigger the production document build using the Deploy Docs entry in the
 
 *To trigger a partial build*, enter the `gh` command and options to build a single version (based on the release line branch name):
 
- $ gh workflow run deploy-docs.yml --ref docs-build -f build-refname=5.7.x
+ $ gh workflow run deploy-docs.yml --ref docs-build -f build-refname=1.1.x
 
 Run `gh help workflow run` to show the docs for this command and other examples of how to use it.
 
-If you're not running the `gh` command from within the cloned repository, you can specify the repository using the `--repo` CLI option (e.g., `--repo spring-projects/spring-security`).
+If you're not running the `gh` command from within the cloned repository, you can specify the repository using the `--repo` CLI option (e.g., `--repo spring-projects/spring-authorization-server`).
 
 == Extensions
 
-The Spring Security docs have additional requirements above what Antora provides by default.
+The Spring Authorization Server docs have additional requirements above what Antora provides by default.
 To fulfill these requirements, the docs build employs a handful of Antora and Asciidoctor extensions to build successfully.
-You can't build the Spring Security docs using the base distribution of Antora.
+You can't build the Spring Authorization Server docs using the base distribution of Antora.
 Fortunately, this extra complexity is encapsulated in the Antora playbook and several distributed extensions.
 
 IMPORTANT: The order of Antora extensions in the playbook matters.
@@ -378,9 +378,9 @@ See https://github.com/spring-io/asciidoctor-extensions[Spring.io Asciidoctor Ex
 [#tabs-migration]
 == Tabs migration
 
-The Spring Security docs contain two variations of the tabs syntax, https://github.com/spring-io/spring-asciidoctor-backends#tabs[Spring Tabs] and https://github.com/asciidoctor/asciidoctor-tabs[Asciidoctor Tabs].
+The Spring Authorization Server docs contain two variations of the tabs syntax, https://github.com/spring-io/spring-asciidoctor-backends#tabs[Spring Tabs] and https://github.com/asciidoctor/asciidoctor-tabs[Asciidoctor Tabs].
 Moving forward, Asciidoctor Tabs is the syntax that should be used.
-However, since the Spring Security docs include content from tags that were written before Asciidoctor Tabs was introduced, the docs build must still be able to process the Spring Tabs syntax where it is used.
+However, since the Spring Authorization Server docs include content from tags that were written before Asciidoctor Tabs was introduced, the docs build must still be able to process the Spring Tabs syntax where it is used.
 
 When the docs build runs, the Spring Tabs are automatically converted to Asciidoctor Tabs by the @springio/antora-extensions/tabs-migration-extension extension.
 Spring Tabs are never in the final output (unless the tabs migration extension is switched off).
@@ -388,7 +388,7 @@ This extension also has the ability to unwrap the example block that encloses ad
 If Spring Tabs are not detected in a document, the migration will not run on that document.
 See https://github.com/spring-io/antora-extensions#tabs-migration[Tabs Migration] for a detailed explanation of this extension and how to configure it.
 
-For the Spring Security docs, the tabs migration will always have to be used as long as there are tags in the build that contain Spring Tabs.
+For the Spring Authorization Server docs, the tabs migration will always have to be used as long as there are tags in the build that contain Spring Tabs.
 However, to reduce the amount of work the tabs migration extension has to do, the migration should be made permanent where possible.
 Thus, we recommend making the migration permanent in release line branches that are active, and thus all future tags.
 
@@ -445,7 +445,7 @@ That file is published as part of the site.
 
 The crawler is periodically run on the production site by the *Rebuild Search Index* workflow.
 The crawler creates a fresh search index and replaces the previous one.
-The name of the index is *spring-security-docs*.
+The name of the index is *spring-authorization-server-docs*.
 
 When the crawler runs, it downloads the _docsearch-config.json_ file from the production site and runs the docsearch action on it.
 
@@ -471,8 +471,8 @@ Here's an inventory of the files or software versions to check and keep up to da
 * Content sources in playbook (_antora-playbook.yml_ and _local-antora-playbook.yml_; ideally use patterns to minimize maintenance)
 * List of registered extensions (_antora-playbook.yml_, _local-antora-playbook.yml_, and _lib/antora/templates/per-branch-antora-playbook.yml_)
 
-.Content branches (e.g., *6.0.x*)
-* Gradle Antora Plugin (_docs/spring-security-docs.gradle_)
+.Content branches (e.g., *1.1.x*)
+* Gradle Antora Plugin (_docs/spring-authorization-server-docs.gradle_)
 * GitHub Actions libraries (_.github/workflows/deploy-docs.yml_, _.github/workflows/rebuild-search-index.yml_)
 
 Recall that the playbook used for the local docs preview in content branches is maintained in the *docs-build* branch in _lib/antora/templates/per-branch-antora-playbook.yml_.

antora-playbook.yml

@@ -9,14 +9,15 @@ antora:
     root_component_name: 'authorization-server'
 site:
   title: Spring Authorization Server
-  url: https://rwinch.github.io/spring-authorization-server
+  url: https://docs.spring.io/spring-authorization-server
   robots: allow
 git:
   ensure_git_suffix: false
 content:
   sources:
-  - url: https://github.com/rwinch/spring-authorization-server
-    branches: [antora]
+  - url: https://github.com/spring-projects/spring-authorization-server
+    branches: [main]
+    tags: []
     start_path: docs
 asciidoc:
   attributes:

gradle.properties

@@ -1,2 +1,2 @@
 group=org.springframework.security
-description=Spring Security Docs Site
+description=Spring Authorization Server Docs Site

lib/antora/templates/per-branch-antora-playbook.yml

@@ -21,7 +21,7 @@ asciidoc:
   attributes:
     hide-uri-scheme: '@'
     page-pagination: ''
-    primary-site-url: https://rwinch.github.io/spring-authorization-server/reference
+    primary-site-url: https://docs.spring.io/spring-authorization-server/reference
     tabs-sync-option: '@'
   extensions:
   - '@asciidoctor/tabs'