docs(jans-cedarling): add per-language getting started examples #11205

rmarinn · 2025-04-09T14:20:20Z

Prepare

Read PR guidelines
Read license information

Description

This PR adds language-specific getting started examples to the docs.

Target issue

closes #11206

Implementation Details

Test and Document the changes

Static code analysis has been run locally and issues have been fixed
Relevant unit and integration tests have been added/updated
Relevant documentation has been updated if any (i.e. user guides, installation and configuration guides, technical design docs etc)

Please check the below before submitting your PR. The PR will not be merged if there are no commits that start with docs: to indicate documentation changes or if the below checklist is not selected.

I confirm that there is no impact on the docs due to the code changes in this PR.

Closes #11206,

…d.md Signed-off-by: rmarinn <[email protected]>

Signed-off-by: rmarinn <[email protected]>

mo-auto · 2025-04-09T14:21:06Z

Error: Hi @rmarinn, You did not reference an open issue in your PR. I attempted to create an issue for you.
Please update that issues' title and body and make sure I correctly referenced it in the above PRs body.

rmarinn · 2025-04-09T14:21:44Z

@duttarnab i am updating the docs but I am not sure if the snippets for Swift and Kotlin are correct. could you have a look?

Signed-off-by: rmarinn <[email protected]>

nynymike · 2025-04-14T16:36:00Z

docs/cedarling/cedarling-getting-started.md

+
+    ```swift
+    let cedarling = try Cedarling.loadFromJson(config: "...")
+    ```



Java should be ready for docs. Ask @uprightech . Go is just getting started, but we may want to put a placeholder in the docs for this.

added a placeholder for Go in this commit: ae04138

nynymike · 2025-04-14T16:37:00Z

docs/cedarling/getting-started/javascript.md

+  "CEDARLING_LOG_TYPE": "std_out",
+  "CEDARLING_LOG_LEVEL": "DEBUG",
+  "CEDARLING_USER_AUTHZ": "enabled",
+  "CEDARLING_WORKLOAD_AUTHZ": "disabled",


Do we need to list the disabled claims?

We don't need to set the disabled explicitly as it defaults to disabled but i thought it would be a good idea to add those for convenience (like to toggle JWT signature validation) and to hint that they exist.

Signed-off-by: rmarinn <[email protected]>

mkdocs.yml

Signed-off-by: rmarinn <[email protected]>

…atory Signed-off-by: duttarnab <[email protected]>

SafinWasi

Needs a few fixes. Are we doing the kotlin and swift pages separately from this PR?

docs/cedarling/cedarling-getting-started.md

docs/cedarling/getting-started/javascript.md

Signed-off-by: rmarinn <[email protected]>

rmarinn · 2025-05-10T06:48:09Z

Are we doing the kotlin and swift pages separately from this PR?

Yes

Signed-off-by: SafinWasi <[email protected]>

Signed-off-by: Safin Wasi <[email protected]>

…Project/jans into jans-cedarling-per-lang-examples

Signed-off-by: SafinWasi <[email protected]>

* docs(cedarling): add per-language example in cedarling-getting-started.md Signed-off-by: rmarinn <[email protected]> * docs(cedarling): add per-lang getting started in mkdocs.yml Signed-off-by: rmarinn <[email protected]> * docs: add javscript example Signed-off-by: rmarinn <[email protected]> * docs: add getting started stub for Go Signed-off-by: rmarinn <[email protected]> * docs: update python installation section Signed-off-by: rmarinn <[email protected]> * docs: add rust getting started section Signed-off-by: rmarinn <[email protected]> * fix: mkdocs.yml formatting Signed-off-by: rmarinn <[email protected]> * fix: formatting in cedarling-getting-started.md Signed-off-by: rmarinn <[email protected]> * fix: python example and docs Signed-off-by: rmarinn <[email protected]> * docs: update getting-started/python.md installation section Signed-off-by: rmarinn <[email protected]> * docs: fix typo 'precompile' to 'pre-compiled' Signed-off-by: rmarinn <[email protected]> * docs: move overview ahead of the getting started section Signed-off-by: rmarinn <[email protected]> * docs: add 'see also' sections in the getting-started docs Signed-off-by: rmarinn <[email protected]> * ci: fix sidecar path Signed-off-by: SafinWasi <[email protected]> * docs: make cedarling initialization code in kotlin, swift more explanatory Signed-off-by: duttarnab <[email protected]> * docs: fix broken links and incorrect grammar Signed-off-by: rmarinn <[email protected]> * docs(jans-cedarling): reformat stuff (#11396) Signed-off-by: SafinWasi <[email protected]> * docs(jans-cedarling): reformat stuff (#11396) Signed-off-by: Safin Wasi <[email protected]> --------- Signed-off-by: rmarinn <[email protected]> Signed-off-by: SafinWasi <[email protected]> Signed-off-by: duttarnab <[email protected]> Signed-off-by: Safin Wasi <[email protected]> Co-authored-by: SafinWasi <[email protected]> Co-authored-by: duttarnab <[email protected]>

rmarinn added 2 commits April 9, 2025 22:14

docs(cedarling): add per-language example in cedarling-getting-starte…

bde9f3a

…d.md Signed-off-by: rmarinn <[email protected]>

docs(cedarling): add per-lang getting started in mkdocs.yml

688e8da

Signed-off-by: rmarinn <[email protected]>

rmarinn requested a review from duttarnab April 9, 2025 14:20

rmarinn self-assigned this Apr 9, 2025

mo-auto mentioned this pull request Apr 9, 2025

docs(jans-cedarling): add per-language getting started examples #11206

Closed

mo-auto added area-documentation Documentation needs to change as part of issue or PR comp-docs Touching folder /docs comp-jans-cedarling Touching folder /jans-cedarling labels Apr 9, 2025

rmarinn requested review from olehbozhok and nynymike April 12, 2025 17:42

docs: add javscript example

bbc3988

Signed-off-by: rmarinn <[email protected]>

rmarinn force-pushed the jans-cedarling-per-lang-examples branch from b5cfa7b to bbc3988 Compare April 14, 2025 09:08

nynymike reviewed Apr 14, 2025

View reviewed changes

olehbozhok previously approved these changes Apr 15, 2025

View reviewed changes

rmarinn dismissed olehbozhok’s stale review via ae04138 April 21, 2025 02:21

rmarinn added 3 commits April 21, 2025 11:03

docs: add getting started stub for Go

8fd6d05

Signed-off-by: rmarinn <[email protected]>

docs: update python installation section

e43fc1d

Signed-off-by: rmarinn <[email protected]>

docs: add rust getting started section

ffbfbbd

Signed-off-by: rmarinn <[email protected]>

rmarinn force-pushed the jans-cedarling-per-lang-examples branch from 2d30a33 to ffbfbbd Compare April 21, 2025 03:03

Merge branch 'main' into jans-cedarling-per-lang-examples

61b4d55

rmarinn marked this pull request as ready for review April 21, 2025 03:04

rmarinn requested review from olehbozhok and SafinWasi April 21, 2025 03:04

rmarinn enabled auto-merge (squash) April 21, 2025 03:06

olehbozhok reviewed Apr 21, 2025

View reviewed changes

mkdocs.yml Outdated Show resolved Hide resolved

olehbozhok previously approved these changes Apr 21, 2025

View reviewed changes

fix: mkdocs.yml formatting

2a93aac

Signed-off-by: rmarinn <[email protected]>

merge: branch 'main' into jans-cedarling-per-lang-examples

a266fd1

Signed-off-by: rmarinn <[email protected]>

rmarinn dismissed SafinWasi’s stale review via a266fd1 May 1, 2025 16:12

rmarinn requested review from SafinWasi and nynymike May 1, 2025 16:12

SafinWasi previously approved these changes May 1, 2025

View reviewed changes

docs: make cedarling initialization code in kotlin, swift more explan…

4e28c43

…atory Signed-off-by: duttarnab <[email protected]>

duttarnab dismissed SafinWasi’s stale review via 4e28c43 May 7, 2025 17:12

duttarnab previously approved these changes May 8, 2025

View reviewed changes

SafinWasi requested changes May 8, 2025

View reviewed changes

docs: fix broken links and incorrect grammar

fb59934

Signed-off-by: rmarinn <[email protected]>

rmarinn dismissed duttarnab’s stale review via fb59934 May 10, 2025 06:47

rmarinn requested review from SafinWasi and duttarnab May 10, 2025 06:48

SafinWasi previously approved these changes May 12, 2025

View reviewed changes

docs(jans-cedarling): reformat stuff (#11396)

f8f02f5

Signed-off-by: SafinWasi <[email protected]>

SafinWasi dismissed their stale review via f8f02f5 May 13, 2025 19:21

SafinWasi previously approved these changes May 13, 2025

View reviewed changes

SafinWasi added 3 commits May 13, 2025 14:23

docs(jans-cedarling): reformat stuff (#11396)

7235c27

Signed-off-by: Safin Wasi <[email protected]>

Merge branch 'jans-cedarling-per-lang-examples' of github.com:Janssen…

04d7b7f

…Project/jans into jans-cedarling-per-lang-examples

chore: fix merge conflict

648053f

Signed-off-by: SafinWasi <[email protected]>

SafinWasi dismissed their stale review via 648053f May 13, 2025 19:28

nynymike approved these changes May 15, 2025

View reviewed changes

Merge branch 'main' into jans-cedarling-per-lang-examples

aad3cee

SafinWasi approved these changes May 15, 2025

View reviewed changes

moabu approved these changes May 15, 2025

View reviewed changes

moabu disabled auto-merge May 15, 2025 17:35

moabu merged commit ce27cb5 into main May 15, 2025
2 checks passed

moabu deleted the jans-cedarling-per-lang-examples branch May 15, 2025 17:35

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

docs(jans-cedarling): add per-language getting started examples #11205

docs(jans-cedarling): add per-language getting started examples #11205

Uh oh!

rmarinn commented Apr 9, 2025 •

edited

Loading

Uh oh!

mo-auto commented Apr 9, 2025

Uh oh!

rmarinn commented Apr 9, 2025

Uh oh!

nynymike Apr 14, 2025

Uh oh!

rmarinn Apr 21, 2025

Uh oh!

nynymike Apr 14, 2025

Uh oh!

rmarinn Apr 21, 2025

Uh oh!

Uh oh!

SafinWasi left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

rmarinn commented May 10, 2025 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

docs(jans-cedarling): add per-language getting started examples #11205

docs(jans-cedarling): add per-language getting started examples #11205

Uh oh!

Conversation

rmarinn commented Apr 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Prepare

Description

Target issue

Implementation Details

Test and Document the changes

Uh oh!

mo-auto commented Apr 9, 2025

Uh oh!

rmarinn commented Apr 9, 2025

Uh oh!

nynymike Apr 14, 2025

Choose a reason for hiding this comment

Uh oh!

rmarinn Apr 21, 2025

Choose a reason for hiding this comment

Uh oh!

nynymike Apr 14, 2025

Choose a reason for hiding this comment

Uh oh!

rmarinn Apr 21, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

SafinWasi left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

rmarinn commented May 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

rmarinn commented Apr 9, 2025 •

edited

Loading

rmarinn commented May 10, 2025 •

edited

Loading