Cloud-IAM

Appearance

Run ​

Start contributing on your local:

shell
yarn install
yarn docs:dev
yarn install
yarn docs:dev

Contributing ​

For clearer git diff, write one sentence per line 🙏

Keep it clear, friendly english, no fucking ChatGPT generated articles.

Adding a new article ​

Create the file in the appropriated folder:

  • deployment: related to the SaaS technical details
  • product: related to the Cloud-IAM product, billing, support, ...
  • keycloak: related to Keycloak configuration

Filename must be lower-kebab-case.

The file name must not be changed after it has been published. If needed, create a redirection in the etc/nginx/includes/redirections.conf from the previous name to the new one.

Images are stored in the images folder and must respect the same convention.

Once you are happy with the new article, add a reference in the .vitepress/config.ts file in the appropriated navigations section.

Don't forget we are all cooperating on this project, ask your colleagues for a review 👌

Formatting ​

Checkout https://vitepress.dev/guide/markdown if needed. In any case, keep it simple, no fancy things to keep it clear and readable.

If specific keywords should be added, use the following syntax on top of the article file:

---
head:
  - - meta
    - name: description
      content: hello
  - - meta
    - name: keywords
      content: super duper SEO
---
---
head:
  - - meta
    - name: description
      content: hello
  - - meta
    - name: keywords
      content: super duper SEO
---

Redirecting existing pages ​

Complete this nginx redirection list in etc/nginx/includes/redirections.conf

Diagrams ​

https://app.diagrams.net/#G18Dpm84BwMvI17LThTKrUgLhFbsquJWZN