فهرست منبع

Revert "Add docs outline with Antora skeleton"

This reverts commit edd7cf2434a5fa88f81b85274dd96e25d4e7f93d.
Joe Grandja 3 سال پیش
والد
کامیت
209248d96d

+ 0 - 2
docs/.gitignore

@@ -1,2 +0,0 @@
-package-lock.json
-node_modules

+ 0 - 11
docs/antora.yml

@@ -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

+ 0 - 16
docs/local-antora-playbook.yml

@@ -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

+ 0 - 7
docs/modules/ROOT/nav.adoc

@@ -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]

+ 0 - 18
docs/modules/ROOT/pages/configuration-model.adoc

@@ -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.

+ 0 - 28
docs/modules/ROOT/pages/core-components.adoc

@@ -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.

+ 0 - 3
docs/modules/ROOT/pages/getting-help.adoc

@@ -1,3 +0,0 @@
-= Getting Help
-
-This page is under construction.

+ 0 - 18
docs/modules/ROOT/pages/getting-started.adoc

@@ -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.

+ 0 - 3
docs/modules/ROOT/pages/index.adoc

@@ -1,3 +0,0 @@
-= Reference Manual
-
-This page is under construction.

+ 0 - 13
docs/modules/ROOT/pages/overview.adoc

@@ -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.

+ 0 - 48
docs/modules/ROOT/pages/protocol-endpoints.adoc

@@ -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.

+ 0 - 1
docs/modules/appendix/nav.adoc

@@ -1 +0,0 @@
-* xref:index.adoc[Appendices]

+ 0 - 3
docs/modules/appendix/pages/index.adoc

@@ -1,3 +0,0 @@
-= Appendices
-
-This page is under construction.

+ 0 - 2
docs/modules/guides/nav.adoc

@@ -1,2 +0,0 @@
-.xref:index.adoc["How-to" Guides]
-* xref:page-1.adoc[Example 1]

+ 0 - 28
docs/modules/guides/pages/index.adoc

@@ -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`

+ 0 - 1
docs/modules/guides/pages/page-1.adoc

@@ -1 +0,0 @@
-= Example 1

+ 0 - 6
docs/package.json

@@ -1,6 +0,0 @@
-{
-  "dependencies": {
-    "@antora/cli": "^3.0.0-alpha.8",
-    "@antora/site-generator-default": "^3.0.0-alpha.8"
-  }
-}