diff --git a/README.md b/README.md index 37b833b6..dd0a761c 100644 --- a/README.md +++ b/README.md @@ -8,4 +8,4 @@ ![Main screen capture](docs/oidc.png) -To get started, refer to our [documentation](docs/oidc.md). +To get started, refer to module [documentation](docs/1-oidc.md). diff --git a/docs/oidc.md b/docs/1-oidc.md similarity index 74% rename from docs/oidc.md rename to docs/1-oidc.md index a79c425d..3bfd3c56 100644 --- a/docs/oidc.md +++ b/docs/1-oidc.md @@ -45,16 +45,16 @@ any v2.\* of SimpleSAMLphp. PHP version requirements may differ. | v3.\* | v2.0.\* | \>=7.4 | | | v2.\* | v1.19.\* | \>=7.4 | | -Upgrading? See the [upgrade guide](oidc-upgrade.md). +Upgrading? See the [upgrade guide](6-oidc-upgrade.md). ## Documentation -- Getting started: [Installation](oidc-installation.md) -- Configure and operate: [Configuration](oidc-configuration.md) -- Manage clients and UI: see [Configuration](oidc-configuration.md#relying-party-rp-administration) +- Getting started: [Installation](2-oidc-installation.md) +- Configure and operate: [Configuration](3-oidc-configuration.md) +- Manage clients and UI: see [Configuration](3-oidc-configuration.md#relying-party-rp-administration) - Endpoints and discovery: see - [Configuration](oidc-configuration.md#endpoint-locations-and-well-known-urls) -- Running with containers: [Using Docker](oidc-docker.md) -- Conformance tests: [OpenID Conformance](oidc-conformance.md) -- Upgrading between versions: [Upgrade guide](oidc-upgrade.md) -- Common questions: [FAQ](oidc-faq.md) + [Configuration](3-oidc-configuration.md#endpoint-locations-and-well-known-urls) +- Running with containers: [Using Docker](4-oidc-docker.md) +- Conformance tests: [OpenID Conformance](5-oidc-conformance.md) +- Upgrading between versions: [Upgrade guide](6-oidc-upgrade.md) +- Common questions: [FAQ](7-oidc-faq.md) diff --git a/docs/oidc-installation.md b/docs/2-oidc-installation.md similarity index 91% rename from docs/oidc-installation.md rename to docs/2-oidc-installation.md index 9ced1ff1..1efe263f 100644 --- a/docs/oidc-installation.md +++ b/docs/2-oidc-installation.md @@ -106,6 +106,6 @@ php modules/oidc/bin/install.php ## 7. Next steps - Configure caches, endpoints, and other options: - see [Configuration](oidc-configuration.md) + see [Configuration](3-oidc-configuration.md) - Administer clients from the UI: - see [Relying Party (RP) Administration](oidc-configuration.md#relying-party-rp-administration) + see [Relying Party (RP) Administration](3-oidc-configuration.md#relying-party-rp-administration) diff --git a/docs/oidc-configuration.md b/docs/3-oidc-configuration.md similarity index 100% rename from docs/oidc-configuration.md rename to docs/3-oidc-configuration.md diff --git a/docs/oidc-docker.md b/docs/4-oidc-docker.md similarity index 95% rename from docs/oidc-docker.md rename to docs/4-oidc-docker.md index 2e92d4a5..17dacca9 100644 --- a/docs/oidc-docker.md +++ b/docs/4-oidc-docker.md @@ -115,7 +115,7 @@ docker exec ssp-oidc-dev-image sqlite3 /var/simplesamlphp/data/mydb.sq3 '.dump' > docker/conformance.sql ``` -Conformance tests are easier to run locally. See [Conformance](oidc-conformance.md). +Conformance tests are easier to run locally. See [Conformance](5-oidc-conformance.md). ## Docker Compose diff --git a/docs/oidc-conformance.md b/docs/5-oidc-conformance.md similarity index 100% rename from docs/oidc-conformance.md rename to docs/5-oidc-conformance.md diff --git a/docs/oidc-upgrade.md b/docs/6-oidc-upgrade.md similarity index 100% rename from docs/oidc-upgrade.md rename to docs/6-oidc-upgrade.md diff --git a/docs/oidc-faq.md b/docs/7-oidc-faq.md similarity index 100% rename from docs/oidc-faq.md rename to docs/7-oidc-faq.md