Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create a workflow diagram #81

Open
nabuskey opened this issue Nov 14, 2023 · 4 comments
Open

Create a workflow diagram #81

nabuskey opened this issue Nov 14, 2023 · 4 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed

Comments

@nabuskey
Copy link
Collaborator

We need to create a workflow diagram for this project to make it easy for us and new contributors to understand how everything works.

@nabuskey nabuskey added documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed labels Nov 14, 2023
@Bnjoroge1
Copy link

Would love to take this!

@Bnjoroge1
Copy link

@nabuskey just to clarify - by a workflow diagram, do you mean. a flowchart for how the various commands work e.g create and the -p package-dir flag? or high level arch diagram of idpbuilder?

@nimakaviani
Copy link
Contributor

Thank you @Bnjoroge1 for taking this on.

I believe @nabuskey 's intention is to develop something similar to what we have for the AWS reference implementation here.

The installation workflows should show how the core packages are configured, how keycloak is set up, and how the pulling of local and remote packages is taken care of. The flow should help the new contributors follow the execution path and gain better understanding of how the different pieces in the idpbuilder could work together.

@Bnjoroge1
Copy link

Hey Nima - thanks for the comment and apologies for taking too long to get a PR up, but I just did. Would love a review/feedback on anything I should include in the diagram. Here's the PR: #347

cc @nabuskey @nimakaviani

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

3 participants