From 209248d96d9f9e3baade68e3baf82577695c367e Mon Sep 17 00:00:00 2001 From: Joe Grandja Date: Fri, 21 Jan 2022 01:47:15 -0500 Subject: [PATCH] Revert "Add docs outline with Antora skeleton" This reverts commit edd7cf2434a5fa88f81b85274dd96e25d4e7f93d. --- docs/.gitignore | 2 - docs/antora.yml | 11 ----- docs/local-antora-playbook.yml | 16 ------- docs/modules/ROOT/nav.adoc | 7 --- .../ROOT/pages/configuration-model.adoc | 18 ------- docs/modules/ROOT/pages/core-components.adoc | 28 ----------- docs/modules/ROOT/pages/getting-help.adoc | 3 -- docs/modules/ROOT/pages/getting-started.adoc | 18 ------- docs/modules/ROOT/pages/index.adoc | 3 -- docs/modules/ROOT/pages/overview.adoc | 13 ----- .../ROOT/pages/protocol-endpoints.adoc | 48 ------------------- docs/modules/appendix/nav.adoc | 1 - docs/modules/appendix/pages/index.adoc | 3 -- docs/modules/guides/nav.adoc | 2 - docs/modules/guides/pages/index.adoc | 28 ----------- docs/modules/guides/pages/page-1.adoc | 1 - docs/package.json | 6 --- 17 files changed, 208 deletions(-) delete mode 100644 docs/.gitignore delete mode 100644 docs/antora.yml delete mode 100644 docs/local-antora-playbook.yml delete mode 100644 docs/modules/ROOT/nav.adoc delete mode 100644 docs/modules/ROOT/pages/configuration-model.adoc delete mode 100644 docs/modules/ROOT/pages/core-components.adoc delete mode 100644 docs/modules/ROOT/pages/getting-help.adoc delete mode 100644 docs/modules/ROOT/pages/getting-started.adoc delete mode 100644 docs/modules/ROOT/pages/index.adoc delete mode 100644 docs/modules/ROOT/pages/overview.adoc delete mode 100644 docs/modules/ROOT/pages/protocol-endpoints.adoc delete mode 100644 docs/modules/appendix/nav.adoc delete mode 100644 docs/modules/appendix/pages/index.adoc delete mode 100644 docs/modules/guides/nav.adoc delete mode 100644 docs/modules/guides/pages/index.adoc delete mode 100644 docs/modules/guides/pages/page-1.adoc delete mode 100644 docs/package.json diff --git a/docs/.gitignore b/docs/.gitignore deleted file mode 100644 index 074ab526..00000000 --- a/docs/.gitignore +++ /dev/null @@ -1,2 +0,0 @@ -package-lock.json -node_modules \ No newline at end of file diff --git a/docs/antora.yml b/docs/antora.yml deleted file mode 100644 index 759aac96..00000000 --- a/docs/antora.yml +++ /dev/null @@ -1,11 +0,0 @@ -name: reference -version: 0.2.2 -prerelease: '-SNAPSHOT' - -title: Spring Authorization Server -display_version: latest -start_page: ROOT:index.adoc -nav: - - modules/ROOT/nav.adoc - - modules/guides/nav.adoc - - modules/appendix/nav.adoc diff --git a/docs/local-antora-playbook.yml b/docs/local-antora-playbook.yml deleted file mode 100644 index 1124988e..00000000 --- a/docs/local-antora-playbook.yml +++ /dev/null @@ -1,16 +0,0 @@ -site: - title: Spring Authorization Server - url: https://docs.spring.io/spring-authorization-server - start_page: reference::index.adoc -asciidoc: - attributes: - page-pagination: true -content: - sources: - - url: ../ - branches: [guides] - start_path: docs -ui: - bundle: - url: https://github.com/spring-io/antora-ui-spring/releases/download/latest/ui-bundle.zip - snapshot: true diff --git a/docs/modules/ROOT/nav.adoc b/docs/modules/ROOT/nav.adoc deleted file mode 100644 index 8f0baea1..00000000 --- a/docs/modules/ROOT/nav.adoc +++ /dev/null @@ -1,7 +0,0 @@ -.xref:index.adoc[Reference Manual] -* xref:overview.adoc[Overview] -* xref:getting-help.adoc[Getting Help] -* xref:getting-started.adoc[Getting Started] -* xref:configuration-model.adoc[Configuration Model] -* xref:core-components.adoc[Core Components] -* xref:protocol-endpoints.adoc[Protocol Endpoints] diff --git a/docs/modules/ROOT/pages/configuration-model.adoc b/docs/modules/ROOT/pages/configuration-model.adoc deleted file mode 100644 index 54e1f001..00000000 --- a/docs/modules/ROOT/pages/configuration-model.adoc +++ /dev/null @@ -1,18 +0,0 @@ -= Configuration Model - -This page is under construction. - -[[oauth2-authorization-server-configurer]] -== `OAuth2AuthorizationServerConfigurer` - -This section is under construction. - -[[oauth2-authorization-server-configuration]] -== `OAuth2AuthorizationServerConfiguration` - -This section is under construction. - -[[provider-settings]] -== `ProviderSettings` / `ProviderContext` - -This section is under construction. diff --git a/docs/modules/ROOT/pages/core-components.adoc b/docs/modules/ROOT/pages/core-components.adoc deleted file mode 100644 index e47ad285..00000000 --- a/docs/modules/ROOT/pages/core-components.adoc +++ /dev/null @@ -1,28 +0,0 @@ -= Core Components - -This page is under construction. - -[[registered-client-repository]] -== `RegisteredClientRepository` / `RegisteredClient` - -This section is under construction. - -[[oauth2-authorization-service]] -== `OAuth2AuthorizationService` / `OAuth2Authorization` - -This section is under construction. - -[[oauth2-authorization-consent-service]] -== `OAuth2AuthorizationConsentService` / `OAuth2AuthorizationConsent` - -This section is under construction. - -[[jwt-encoder]] -== `JwtEncoder` - -This section is under construction. - -[[oauth2-token-customizer]] -== `OAuth2TokenCustomizer` / `OAuth2TokenContext` - -This section is under construction. diff --git a/docs/modules/ROOT/pages/getting-help.adoc b/docs/modules/ROOT/pages/getting-help.adoc deleted file mode 100644 index 441c87c9..00000000 --- a/docs/modules/ROOT/pages/getting-help.adoc +++ /dev/null @@ -1,3 +0,0 @@ -= Getting Help - -This page is under construction. diff --git a/docs/modules/ROOT/pages/getting-started.adoc b/docs/modules/ROOT/pages/getting-started.adoc deleted file mode 100644 index 8b8e990d..00000000 --- a/docs/modules/ROOT/pages/getting-started.adoc +++ /dev/null @@ -1,18 +0,0 @@ -= Getting Started - -This page is under construction. - -[[system-requirements]] -== System Requirements - -This section is under construction. - -[[installing-spring-authorization-server]] -== Installing Spring Authorization Server - -This section is under construction. - -[[developing-your-first-application]] -== Developing Your First Spring Authorization Server Application - -This section is under construction. diff --git a/docs/modules/ROOT/pages/index.adoc b/docs/modules/ROOT/pages/index.adoc deleted file mode 100644 index 9799ee01..00000000 --- a/docs/modules/ROOT/pages/index.adoc +++ /dev/null @@ -1,3 +0,0 @@ -= Reference Manual - -This page is under construction. diff --git a/docs/modules/ROOT/pages/overview.adoc b/docs/modules/ROOT/pages/overview.adoc deleted file mode 100644 index 493b1501..00000000 --- a/docs/modules/ROOT/pages/overview.adoc +++ /dev/null @@ -1,13 +0,0 @@ -= Overview - -This page is under construction. - -[[introducing-spring-authorization-server]] -== Introducing Spring Authorization Server - -This section is under construction. - -[[feature-list]] -== Feature List - -This section is under construction. diff --git a/docs/modules/ROOT/pages/protocol-endpoints.adoc b/docs/modules/ROOT/pages/protocol-endpoints.adoc deleted file mode 100644 index 56ef25de..00000000 --- a/docs/modules/ROOT/pages/protocol-endpoints.adoc +++ /dev/null @@ -1,48 +0,0 @@ -= Protocol Endpoints - -This page is under construction. - -[[oauth2-authorization-endpoint]] -== OAuth 2.0 Authorization Endpoint - -This section is under construction. - -[[oauth2-token-endpoint]] -== OAuth 2.0 Token Endpoint - -This section is under construction. - -[[oauth2-token-introspection-endpoint]] -== OAuth 2.0 Token Introspection Endpoint - -This section is under construction. - -[[oauth2-token-revocation-endpoint]] -== OAuth 2.0 Token Revocation Endpoint - -This section is under construction. - -[[oauth2-authorization-server-metadata-endpoint]] -== OAuth 2.0 Authorization Server Metadata Endpoint - -This section is under construction. - -[[jwk-set-endpoint]] -== JWK Set Endpoint - -This section is under construction. - -[[openid-connect-provider-configuration-endpoint]] -== OpenID Connect 1.0 Provider Configuration Endpoint - -This section is under construction. - -[[openid-connect-user-info-endpoint]] -== OpenID Connect 1.0 UserInfo Endpoint - -This section is under construction. - -[[openid-connect-client-registration-endpoint]] -== OpenID Connect 1.0 Client Registration Endpoint - -This section is under construction. diff --git a/docs/modules/appendix/nav.adoc b/docs/modules/appendix/nav.adoc deleted file mode 100644 index d54f6847..00000000 --- a/docs/modules/appendix/nav.adoc +++ /dev/null @@ -1 +0,0 @@ -* xref:index.adoc[Appendices] \ No newline at end of file diff --git a/docs/modules/appendix/pages/index.adoc b/docs/modules/appendix/pages/index.adoc deleted file mode 100644 index 4e0fc5c5..00000000 --- a/docs/modules/appendix/pages/index.adoc +++ /dev/null @@ -1,3 +0,0 @@ -= Appendices - -This page is under construction. diff --git a/docs/modules/guides/nav.adoc b/docs/modules/guides/nav.adoc deleted file mode 100644 index 28559935..00000000 --- a/docs/modules/guides/nav.adoc +++ /dev/null @@ -1,2 +0,0 @@ -.xref:index.adoc["How-to" Guides] -* xref:page-1.adoc[Example 1] diff --git a/docs/modules/guides/pages/index.adoc b/docs/modules/guides/pages/index.adoc deleted file mode 100644 index 4b826592..00000000 --- a/docs/modules/guides/pages/index.adoc +++ /dev/null @@ -1,28 +0,0 @@ -= "How-to" Guides - -This page is under construction. - -== Table of contents - -** Obtain an access token using a specific grant_type: -*** `authorization_code` -*** `client_credentials` -*** `refresh_token` -** Customize form based login -** Authenticate a user with two-factor authentication -** Customize the user consent page -** Authenticate using OpenID Connect 1.0 authorization_code flow -** Customize the OpenID Connect 1.0 UserInfo response -** Authenticate using social login, e.g. Google -** Authenticate a user in a Single Page Application with PKCE -** Customize client authentication for specific authentication methods -** Handle errors and customize the OAuth 2.0 Error response -** Authorize an access token containing custom authorities, e.g. roles, groups, permissions, etc. -*** Customize the headers / claims in a JWT -** Deny access for a revoked JWT access token -*** Introspect / revoke an access token -** Provide a JWK source backed by a key rotation strategy -** Implement the core services with JPA: -*** `RegisteredClientRepository` -*** `OAuth2AuthorizationService` -*** `OAuth2AuthorizationConsentService` diff --git a/docs/modules/guides/pages/page-1.adoc b/docs/modules/guides/pages/page-1.adoc deleted file mode 100644 index cb21cff1..00000000 --- a/docs/modules/guides/pages/page-1.adoc +++ /dev/null @@ -1 +0,0 @@ -= Example 1 diff --git a/docs/package.json b/docs/package.json deleted file mode 100644 index 58af6109..00000000 --- a/docs/package.json +++ /dev/null @@ -1,6 +0,0 @@ -{ - "dependencies": { - "@antora/cli": "^3.0.0-alpha.8", - "@antora/site-generator-default": "^3.0.0-alpha.8" - } -}