docs: introduce versioned docs and migrate to fuma (#11166)

## Todos for release - [x] Configure Env in docs project on vercel - [x] Configure Root Path in the docs project on vercel - [ ] Remove old CSP https://github.com/zitadel/website/pull/1592 ## What we did This pull request migrates the project documentation from the old `docs/` directory to the new `apps/docs/` directory, introduces a new documentation system built with Next.js and Fumadocs, and updates all relevant references, configuration files, and documentation to reflect this change. It also adds new configuration and ignore files for the new documentation app, updates CI and linting to exclude the new docs from certain checks, and revises the contributing guidelines accordingly. **Documentation System Migration and New Docs App** * Migrated all documentation from `docs/` to `apps/docs/`, and updated all references in `README.md`, `CONTRIBUTING.md`, and other files to point to the new location. [[1]](diffhunk://#diff-eca12c0a30e25b4b46522ebf89465a03ba72a03f540796c979137931d8f92055L585-L640) [[2]](diffhunk://#diff-eca12c0a30e25b4b46522ebf89465a03ba72a03f540796c979137931d8f92055L660-R607) [[3]](diffhunk://#diff-eca12c0a30e25b4b46522ebf89465a03ba72a03f540796c979137931d8f92055L740-R687) [[4]](diffhunk://#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5L2-R3) [[5]](diffhunk://#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5L30-R30) * Added a new Next.js/Fumadocs-based documentation app under `apps/docs/`, including core app files, layouts, routing, search API, and a comprehensive `README.md` with development and contribution instructions. [[1]](diffhunk://#diff-5a1b07344a2c1b4d3f37b23ff1388b62cd9f57dea3c1cd23d8a0412b7602b132R1-R74) [[2]](diffhunk://#diff-462b9ad1eabbb7d1c29bb9c36e4931eb180fd7190900e6d2babf8f4d66ad1c28R1-R39) [[3]](diffhunk://#diff-e16ae25660ded787b10ac35dea96d5ecaacf895dae0afc8a9bd4382dc79a8c87R1-R7) [apps/docs/app/[[...slug]]/layout.tsxR1-R81](diffhunk://#diff-59e08acde4e805b7aeccef1dcf98f1d71dfc550777e6b9402085cee0e9fa4e0aR1-R81), [apps/docs/app/[[...slug]]/page.tsxR1-R79](diffhunk://#diff-e5df3f80d0fa01e12d63d81f29c57a9d14e846c78fd3beabb2ef768e38fd9580R1-R79), [[4]](diffhunk://#diff-389b34918e040cacaa87cd7201ffa462cc2b0b716736f537e3d3c660ac69353bR1-R7) [[5]](diffhunk://#diff-d3b03416d1c457b19f1c27b26f2db741412df841b875c26ccadc36e4522247f4R1-R29) [[6]](diffhunk://#diff-c8fb8339570a5305809be7c618e14705fd86390dc278e6ce8ba224a7bc8b0c3cR1-R25) **Configuration and Tooling Updates** * Updated `.github/workflows/codeql.yml`, `.golangci.yaml`, and `.github/dependabot.yml` to properly handle the new docs app: excluded `apps/docs` from certain checks, added npm dependency updates for the docs app, and excluded generated content. [[1]](diffhunk://#diff-12783128521e452af0cfac94b99b8d250413c516ec71fe6d97dbea666ff7ba27L8-R14) [[2]](diffhunk://#diff-9917ddc9f1c3304218f7269265b746d997c5c0615478177b5fceecd33ef47cb5R5-R6) [[3]](diffhunk://#diff-9917ddc9f1c3304218f7269265b746d997c5c0615478177b5fceecd33ef47cb5R126-R129) [[4]](diffhunk://#diff-dd4fbda47e51f1e35defb9275a9cd9c212ecde0b870cba89ddaaae65c5f3cd28R89-R106) * Updated `.devcontainer/devcontainer.json` to use the latest Go 1.25.3 version for consistency. **Licensing and Miscellaneous** * Added `apps/docs/` to the list of licensed directories in `LICENSING.md`. These changes ensure the documentation is now maintained in a modern, scalable system and all project tooling is updated to support the new structure. --------- Co-authored-by: Federico Coppede <[email protected]>
2026-10-18 05:52:51 +00:00 · 2026-01-29 08:38:36 -08:00
parent 7b6395c348
commit d8ea041c56
2826 changed files with 78739 additions and 23571 deletions
@@ -0,0 +1,85 @@
+---
+title: Log in with ZITADEL on Ping Identity through SAML 2.0
+sidebar_label: Ping Identity
+---
+
+This guide shows how to enable login with ZITADEL on Ping Identity.
+
+It covers how to:
+
+- create and configure the application in your project
+- create and configure the connection in your Ping Identity tenant
+
+Prerequisites:
+
+- existing ZITADEL Instance, if not present follow [this guide](/guides/start/quickstart)
+- existing ZITADEL Organization, if not present follow [this guide](/guides/manage/console/organizations-overview)
+- existing ZITADEL project, if not present follow the first 3 steps [here](/guides/manage/console/projects-overview)
+- existing Pingidentity environment [here](https://docs.pingidentity.com/bundle/pingone/page/wqe1564020490538.html)
+
+> We have to switch between ZITADEL and Ping Identity. If the headings begin with "ZITADEL" switch to the ZITADEL
+> Management Console and
+> if the headings start with "Ping" please switch to the PingIdentity GUI.
+
+## **Ping**: Create a new external identity provider
+
+To add an
+additional [external identity provider](https://docs.pingidentity.com/bundle/pingone/page/jvz1567784210191.html), you
+can follow the instructions [here](https://docs.pingidentity.com/bundle/pingone/page/ovy1567784211297.html)
+
+1. As described you have to create a new provider, with a unique identifier:
+   ![](../../../../public/img/saml/pingidentity/create_idp_profile.png)
+
+We recommend activating signing the auth request whenever possible:
+![](../../../../public/img/saml/pingidentity/conf_connection.png)
+
+2. Manually enter the necessary information:
+
+- SSO Endpoint, for example https://accounts.example.com/saml/SSO
+- IDP EntityID, for example https://accounts.example.com/saml/metadata
+- Binding, which is a decision which you can take yourself, we recommend HTTP POST as it has fewer restrictions
+- Import certificate, provided from the certificate endpoint
+  ![](../../../../public/img/saml/pingidentity/conf_idp_connection.png)
+
+Everything you need to know about the attribute mapping you can find
+in [Ping Identity's documentation](https://docs.pingidentity.com/bundle/pingone/page/pwv1567784207915.html)
+
+3. With this you have defined to connection to ZITADEL as an external IDP, next is the policy to use ZITADEL as an IDP
+   to
+   connect to an application. The "How to" for that can be
+   found [here](https://docs.pingidentity.com/bundle/pingone/page/zqd1616600404402.html).
+
+## **ZITADEL**: Create the application
+
+To add the connection to ZITADEL you have to build the metadata, which should minimalistic look like this, the necessary
+information can be found on the External IDPs page under "P1Connection" and "IDP Configuration" :
+
+```xml
+ENTITYID="PINGONE (SP) ENTITY ID"
+        ACSURL="ACS ENDPOINT"
+        <?xml version="1.0"?>
+<md:EntityDescriptor xmlns:md="urn:oasis:names:tc:SAML:2.0:metadata" entityID="${ENTITYID}">
+    <md:SPSSODescriptor
+            protocolSupportEnumeration="urn:oasis:names:tc:SAML:2.0:protocol urn:oasis:names:tc:SAML:1.1:protocol">
+        <md:AssertionConsumerService Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST" Location="${ACSURL}"
+                                     index="0"/>
+    </md:SPSSODescriptor>
+</md:EntityDescriptor>
+```
+
+![](../../../../public/img/saml/pingidentity/idp_p1_connection.png)
+![](../../../../public/img/saml/pingidentity/idp_idp_configuration.png)
+
+In your existing project:
+
+1. Press the "+"-button to add an application
+   ![](../../../../public/img/saml/zitadel/project.png)
+2. Fill in a name for the application and chose the SAML type, then click "Continue".
+   ![](../../../../public/img/saml/zitadel/application_saml.png)
+3. Either fill in the URL where ZITADEL can read the metadata from, or upload the metadata XML directly, then click "
+   Continue".
+   ![](../../../../public/img/saml/zitadel/application_saml_metadata.png)
+4. Check your application, if everything is correct, press "Create".
+   ![](../../../../public/img/saml/zitadel/application_saml_create.png)
+
+Everything on the side of ZITADEL is done if the application is correctly created.