Skip to content

docs: document master and keycloak API branches - #608

Open
hariclerry wants to merge 1 commit into
Greenstand:keycloakfrom
hariclerry:docs/branch-authentication
Open

hariclerry wants to merge 1 commit into
Greenstand:keycloakfrom
hariclerry:docs/branch-authentication

Conversation

@hariclerry

Copy link
Copy Markdown

Description

What kind of change(s) does this PR introduce?

- Added the deployed route for each branch.
- Documented the authentication method used by each branch.
- Explained the shared PostgreSQL database implications.
- Added guidance for selecting the correct target branch.
- Noted that contributors should confirm the target branch with maintainers.
  • Enhancement
  • Bug fix
  • Refactor

Please check if the PR fulfils these requirements

  • The commit message follows our guidelines
  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)

Breaking change

Does this PR introduce a breaking change?

  • No

Other useful information

None

@hariclerry

Copy link
Copy Markdown
Author

The documentation update is ready for review. It documents the differences between the master and keycloak branches, including routes, authentication, shared database usage, and branch-targeting guidance.

Please review the content and let me know if any information is inaccurate, incomplete, or needs correction. Additional guidance is welcome before merging.

Comment thread README.md
before starting work, especially for changes affecting shared database tables or
migrations, and review compatibility with both variants.

# Keycloak and Access Key Setup

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Was something meant to be here?

Also. maybe update docker-compose to support keycloak as well, and the documentation on how to go about that, including getting tokens, so a user can just run docker compose and have everything set up locally

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants