docs: optimized examples and sdk for search (#8657)

# Which Problems Are Solved

Page title was "introduction" and the headings were missing a h2 level.
This makes it difficult to index for search, both internal and external.

# How the Problems Are Solved

* Change the page title
* Pulled all headings one level up

# Additional Changes

- Show all elements in sdk-example folder automaticalls
This commit is contained in:
mffap 2024-09-25 10:14:58 +02:00 committed by GitHub
parent aeb379e7de
commit 624fee97c0
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 12 additions and 19 deletions

View File

@ -1,6 +1,7 @@
--- ---
title: Introduction title: Examples and SDKs for ZITADEL
sidebar_label: Introduction sidebar_label: Introduction
sidebar_position: 1
--- ---
You can integrate ZITADEL quickly into your application and be up and running within minutes. You can integrate ZITADEL quickly into your application and be up and running within minutes.
@ -10,7 +11,7 @@ The SDKs and integration depend on the framework and language you are using.
import { Frameworks } from "../../src/components/frameworks"; import { Frameworks } from "../../src/components/frameworks";
### Resources ## Resources
<Frameworks /> <Frameworks />
@ -20,7 +21,7 @@ To further streamline your setup, simply visit the console in ZITADEL where you
To begin configuring login for any of these samples, start [here](https://zitadel.com/signin). To begin configuring login for any of these samples, start [here](https://zitadel.com/signin).
### OIDC Libraries ## OIDC Libraries
OIDC is a standard for authentication and most languages and frameworks do provide a OIDC library which can be easily integrated to your application. OIDC is a standard for authentication and most languages and frameworks do provide a OIDC library which can be easily integrated to your application.
If we do not provide an specific example, SDK or guide, we strongly recommend using existing authentication libraries for your If we do not provide an specific example, SDK or guide, we strongly recommend using existing authentication libraries for your
@ -34,7 +35,7 @@ You might want to check out the following links to find a good library:
- [OpenID General References](https://openid.net/developers/libraries/) - [OpenID General References](https://openid.net/developers/libraries/)
- [OpenID certified developer tools](https://openid.net/certified-open-id-developer-tools/) - [OpenID certified developer tools](https://openid.net/certified-open-id-developer-tools/)
### Other example applications ## Other example applications
- [B2B customer portal](https://github.com/zitadel/zitadel-nextjs-b2b): Showcase the use of personal access tokens in a B2B environment. Uses NextJS Framework. - [B2B customer portal](https://github.com/zitadel/zitadel-nextjs-b2b): Showcase the use of personal access tokens in a B2B environment. Uses NextJS Framework.
- [Frontend with backend API](https://github.com/zitadel/example-quote-generator-app): A simple web application using a React front-end and a Python back-end API, both secured using ZITADEL - [Frontend with backend API](https://github.com/zitadel/example-quote-generator-app): A simple web application using a React front-end and a Python back-end API, both secured using ZITADEL
@ -43,7 +44,7 @@ You might want to check out the following links to find a good library:
Search for the "example" tag in our repository to [explore all examples](https://github.com/search?q=topic%3Aexamples+org%3Azitadel&type=repositories). Search for the "example" tag in our repository to [explore all examples](https://github.com/search?q=topic%3Aexamples+org%3Azitadel&type=repositories).
### Missing SDK ## Missing SDK
Is your language/framework missing? Fear not, you can generate your gRPC API Client with ease. Is your language/framework missing? Fear not, you can generate your gRPC API Client with ease.
@ -54,7 +55,7 @@ Is your language/framework missing? Fear not, you can generate your gRPC API Cli
Let us make an example with Ruby. Any other supported language by buf will work as well. Consult Let us make an example with Ruby. Any other supported language by buf will work as well. Consult
the [buf plugin registry](https://buf.build/plugins) for more ideas. the [buf plugin registry](https://buf.build/plugins) for more ideas.
#### Example with Ruby ### Example with Ruby
With gRPC we usually need to generate the client stub and the messages/types. This is why we need two plugins. With gRPC we usually need to generate the client stub and the messages/types. This is why we need two plugins.
The plugin `grpc/ruby` generates the client stub and the plugin `protocolbuffers/ruby` takes care of the messages/types. The plugin `grpc/ruby` generates the client stub and the plugin `protocolbuffers/ruby` takes care of the messages/types.

View File

@ -54,18 +54,10 @@ module.exports = {
label: "Examples & SDKs", label: "Examples & SDKs",
link: {type: "doc", id: "sdk-examples/introduction"}, link: {type: "doc", id: "sdk-examples/introduction"},
items: [ items: [
"sdk-examples/introduction", {
"sdk-examples/angular", type: "autogenerated",
"sdk-examples/flutter", dirName: "sdk-examples"
"sdk-examples/go", },
"sdk-examples/java",
"sdk-examples/nestjs",
"sdk-examples/nextjs",
"sdk-examples/python-flask",
"sdk-examples/python-django",
"sdk-examples/react",
"sdk-examples/symfony",
"sdk-examples/vue",
{ {
type: "link", type: "link",
label: "Dart", label: "Dart",

View File

@ -8,7 +8,7 @@ export function Tile({ title, imageSource, imageSourceLight, link, external }) {
className={styles.tile} className={styles.tile}
target={external ? "_blank" : "_self"} target={external ? "_blank" : "_self"}
> >
<h4>{title}</h4> <h3>{title}</h3>
<img <img
className={imageSourceLight ? "hideonlight" : ""} className={imageSourceLight ? "hideonlight" : ""}
src={imageSource} src={imageSource}