docs: remove embedded content from rendered site (#5183)

* docs: remove embedded content from rendered site

* integrations applications

* Apply suggestions from code review

Co-authored-by: Fabi <38692350+hifabienne@users.noreply.github.com>

---------

Co-authored-by: Fabi <38692350+hifabienne@users.noreply.github.com>

CONTRIBUTING.md

@@ -280,8 +280,16 @@ docker compose down
 ## Contribute Docs
 
 Project documentation is made with docusaurus and is located under [./docs](./docs).
+
+### Local Testing
 Please refer to the [README](./docs/README.md) for more information and local testing.
 
+### Style Guide
+
+- **Code with variables**: Make sure that code snippets can be used by setting environment variables, instead of manually replacing a placeholder.
+- **Embedded files**: When embedding mdx files, make sure the template ist prefixed by "_" (lowdash). The content will be rendered inside the parent page, but is not accessible individually (eg, by search).
+
+### Docs Pull Request
 When making a pull request use `docs(<scope>): <short summary>` as title for the semantic release.
 Scope can be left empty (omit the brackets) or refer to the top navigation sections.
 

docs/docs/guides/integrate/_authmethods.mdx

@@ -1,11 +1,10 @@
 import TabItem from "@theme/TabItem";
 import Tabs from "@theme/Tabs";
-import PKCE from "./authmethods/pkce.mdx";
-
-import Basic from "./authmethods/basic.mdx";
-import Implicit from "./authmethods/implicit.mdx";
-import PKCENative from "./authmethods/pkcenative.mdx";
-import JWTPrivateKey from "./authmethods/jwtpk.mdx";
+import PKCE from "./authmethods/_pkce.mdx";
+import Basic from "./authmethods/_basic.mdx";
+import Implicit from "./authmethods/_implicit.mdx";
+import PKCENative from "./authmethods/_pkcenative.mdx";
+import JWTPrivateKey from "./authmethods/_jwtpk.mdx";
 
 export default function AuthMethods(props) {
   return props.selected == "web" ? (

docs/docs/guides/integrate/application/_application.mdx

@@ -1,8 +1,8 @@
 import ThemedImage from "@theme/ThemedImage";
-import AuthType from "./auth-type.mdx";
-import RedirectURIs from "./redirect-uris.mdx";
-import GenerateKey from "./generate-key.mdx";
-import ReviewConfig from "./review-config.mdx";
+import AuthType from "./_auth-type.mdx";
+import RedirectURIs from "./_redirect-uris.mdx";
+import GenerateKey from "./_generate-key.mdx";
+import ReviewConfig from "./_review-config.mdx";
 
 export default function CreateApp(props) {
   return (

docs/docs/guides/integrate/auth0-oidc.mdx

@@ -2,6 +2,8 @@
 title: Connect with Auth0 through OIDC
 ---
 
+import CreateApp from "./application/_application.mdx";
+
 This guide shows how to enable login with ZITADEL on Auth0.
 
 It covers how to:
@@ -38,8 +40,6 @@ Next we have to switch to the ZITADEL console.
 
 First of all we create the application in your project.
 
-import CreateApp from "./application/application.mdx";
-
 <CreateApp appType="web" authType="code" appName="Auth0" redirectURI="https://<TENANT>.<REGION>.auth0.com/login/callback"/>
 
 ## **Auth0**: Connect ZITADEL

docs/docs/guides/integrate/gitlab-self-hosted.mdx

@@ -2,6 +2,9 @@
 title: Gitlab OmniAuth Provider
 ---
 
+import CreateApp from "./application/_application.mdx";
+
+
 This guide shows how to enable login with ZITADEL on self-hosted Gitlab instances.
 
 It covers how to:
@@ -16,8 +19,6 @@ Prerequisites:
 - existing ZITADEL project, if not present follow the first 3 steps [here](../../guides/manage/console/projects)
 - running Gitlab instance see [installation guide](https://docs.gitlab.com/ee/install/)
 
-import CreateApp from "./application/application.mdx";
-
 <CreateApp appType="web" authType="code" appName="Gitlab" redirectURI="https://<your_gitlab_url>/users/auth/openid_connect/callback"/>
 
 ## Gitlab configuration

docs/docs/guides/integrate/login-users.mdx

@@ -4,7 +4,7 @@ title: Login Users into your Application
 
 import Tabs from "@theme/Tabs";
 import TabItem from "@theme/TabItem";
-import AuthMethods from "./authmethods.mdx";
+import AuthMethods from "./_authmethods.mdx";
 
 ## Overview
 

docs/docs/guides/manage/console/applications.mdx

@@ -4,10 +4,8 @@ title: Applications
 
 import ThemedImage from "@theme/ThemedImage";
 
-import AuthType from "../../integrate/application/auth-type.mdx";
-import RedirectURIs from "../../integrate/application/redirect-uris.mdx";
-import GenerateKey from "../../integrate/application/generate-key.mdx";
-import ReviewConfig from "../../integrate/application/review-config.mdx";
+import AuthType from "../../integrate/application/_auth-type.mdx";
+import ReviewConfig from "../../integrate/application/_review-config.mdx";
 
 # What is an application?