diff --git a/README.md b/README.md index fe0b09c93b79d70ba8e7f586b6d49d94f4ec8122..ad7a9605cfd42a5279c76ef9776e6747deb51e04 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ [](https://pkg.go.dev/mod/github.com/dexidp/dex) [](https://gitpod.io/#https://github.com/dexidp/dex) - + Dex is an identity service that uses [OpenID Connect][openid-connect] to drive authentication for other apps. @@ -56,7 +56,7 @@ More docs for running dex as a Kubernetes authenticator can be found [here](http When a user logs in through dex, the user's identity is usually stored in another user-management system: a LDAP directory, a GitHub org, etc. Dex acts as a shim between a client app and the upstream identity provider. The client only needs to understand OpenID Connect to query dex, while dex implements an array of protocols for querying other user-management systems. - + A "connector" is a strategy used by dex for authenticating a user against another identity provider. Dex implements connectors that target specific platforms such as GitHub, LinkedIn, and Microsoft as well as established protocols like LDAP and SAML. diff --git a/Documentation/README.md b/docs/README.md similarity index 100% rename from Documentation/README.md rename to docs/README.md diff --git a/Documentation/img/caution.png b/docs/img/caution.png similarity index 100% rename from Documentation/img/caution.png rename to docs/img/caution.png diff --git a/Documentation/img/dex-backend-flow.png b/docs/img/dex-backend-flow.png similarity index 100% rename from Documentation/img/dex-backend-flow.png rename to docs/img/dex-backend-flow.png diff --git a/Documentation/img/dex-flow.png b/docs/img/dex-flow.png similarity index 100% rename from Documentation/img/dex-flow.png rename to docs/img/dex-flow.png diff --git a/Documentation/logos/dex-glyph-bw.png b/docs/logos/dex-glyph-bw.png similarity index 100% rename from Documentation/logos/dex-glyph-bw.png rename to docs/logos/dex-glyph-bw.png diff --git a/Documentation/logos/dex-glyph-bw.svg b/docs/logos/dex-glyph-bw.svg similarity index 100% rename from Documentation/logos/dex-glyph-bw.svg rename to docs/logos/dex-glyph-bw.svg diff --git a/Documentation/logos/dex-glyph-color.png b/docs/logos/dex-glyph-color.png similarity index 100% rename from Documentation/logos/dex-glyph-color.png rename to docs/logos/dex-glyph-color.png diff --git a/Documentation/logos/dex-glyph-color.svg b/docs/logos/dex-glyph-color.svg similarity index 100% rename from Documentation/logos/dex-glyph-color.svg rename to docs/logos/dex-glyph-color.svg diff --git a/Documentation/logos/dex-glyph-white.png b/docs/logos/dex-glyph-white.png similarity index 100% rename from Documentation/logos/dex-glyph-white.png rename to docs/logos/dex-glyph-white.png diff --git a/Documentation/logos/dex-glyph-white.svg b/docs/logos/dex-glyph-white.svg similarity index 100% rename from Documentation/logos/dex-glyph-white.svg rename to docs/logos/dex-glyph-white.svg diff --git a/Documentation/logos/dex-horizontal-color.png b/docs/logos/dex-horizontal-color.png similarity index 100% rename from Documentation/logos/dex-horizontal-color.png rename to docs/logos/dex-horizontal-color.png diff --git a/Documentation/logos/dex-horizontal-color.svg b/docs/logos/dex-horizontal-color.svg similarity index 100% rename from Documentation/logos/dex-horizontal-color.svg rename to docs/logos/dex-horizontal-color.svg diff --git a/Documentation/logos/dex-horizontal-white.png b/docs/logos/dex-horizontal-white.png similarity index 100% rename from Documentation/logos/dex-horizontal-white.png rename to docs/logos/dex-horizontal-white.png diff --git a/Documentation/logos/dex-horizontal-white.svg b/docs/logos/dex-horizontal-white.svg similarity index 100% rename from Documentation/logos/dex-horizontal-white.svg rename to docs/logos/dex-horizontal-white.svg diff --git a/examples/config-dev.yaml b/examples/config-dev.yaml index 5b054ebd79b1aa3c2287cd3623bb72f7854e754d..d894984d66505d550706eefa43b4e006c648493a 100644 --- a/examples/config-dev.yaml +++ b/examples/config-dev.yaml @@ -6,7 +6,7 @@ issuer: http://127.0.0.1:5556/dex # The storage configuration determines where dex stores its state. Supported # options include SQL flavors and Kubernetes third party resources. # -# See the storage document at Documentation/storage.md for further information. +# See the documentation (https://dexidp.io/docs/storage/) for further information. storage: type: sqlite3 config: diff --git a/examples/grpc-client/README.md b/examples/grpc-client/README.md index 460a5d1c6f381d29f6e81c5cc037a05234fbd093..59629e05900c8458396fe72c8eeee2814754816a 100644 --- a/examples/grpc-client/README.md +++ b/examples/grpc-client/README.md @@ -1,6 +1,6 @@ # Running a Dex gRPC client -Using gRPC, a client application can directly call methods on a server application as if it was a local object. The schema for Dex's gRPC API calls is defined in [`api/api.proto`][api-proto]. [`client.go`][client] is an example client program that makes a bunch of API calls to the dex server. For further details on the Dex API refer [`Documentation/api.md`][api-docs]. +Using gRPC, a client application can directly call methods on a server application as if it was a local object. The schema for Dex's gRPC API calls is defined in [`api/api.proto`][api-proto]. [`client.go`][client] is an example client program that makes a bunch of API calls to the dex server. For further details on the Dex API refer the [documentation][https://dexidp.io/docs/api/]. ## Generating Credentials @@ -60,4 +60,3 @@ Run the following command to destroy all the credentials files that were created ``` [api-proto]: ../../api/api.proto [client]: client.go -[api-docs]: ../../Documentation/api.md