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

Improve keycloak configuration docs #10238

Merged
merged 3 commits into from
Oct 2, 2023
Merged

Conversation

forus
Copy link
Contributor

@forus forus commented Jun 21, 2023

  • document url to download IDP SSO descriptor xml file.
  • add complete logback xml file example to turn on DEBUG level
  • document how to bind mount the logback xml file to docker container
  • document what role name stands for when filter_groups_by_appname=false/true

Checks

  • Runs on heroku
  • Has tests or has a separate issue that describes the types of test that should be created. If no test is included it should explicitly be mentioned in the PR why there is no test.
  • The commit log is comprehensible. It follows 7 rules of great commit messages. For most PRs a single commit should suffice, in some cases multiple topical commits can be useful. During review it is ok to see tiny commits (e.g. Fix reviewer comments), but right before the code gets merged to master or rc branch, any such commits should be squashed since they are useless to the other developers. Definitely avoid merge commits, use rebase instead.
  • Is this PR adding logic based on one or more clinical attributes? If yes, please make sure validation for this attribute is also present in the data validation / data loading layers (in backend repo) and documented in File-Formats Clinical data section!

Any screenshots or GIFs?

If this is a new visual feature please add a before/after screenshot or gif
here with e.g. Giphy CAPTURE or Peek

Notify reviewers

Read our Pull request merging
policy
. It can help to figure out who worked on the
file before you. Please use git blame <filename> to determine that
and notify them either through slack or by assigning them as a reviewer on the PR

- document url to download IDP SSO descriptor xml file.
- add complete logback xml file example to turn on DEBUG level
- document how to bind mount the logback xml file to docker container
- document what role name stands for when filter_groups_by_appname=false/true
Copy link
Member

@pieterlukasse pieterlukasse left a comment

Choose a reason for hiding this comment

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

Thanks @forus , this is a great improvement 👍

@forus forus requested a review from pieterlukasse June 23, 2023 14:40
@sonarqubecloud
Copy link

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information

@pieterlukasse pieterlukasse requested review from n1zea144 and removed request for n1zea144 June 23, 2023 20:51
@dippindots
Copy link
Member

@n1zea144 @jagnathan This seems a good improvement to our current keycloak documentation, could we get your review?

@inodb inodb requested a review from pvannierop September 28, 2023 15:01
Copy link
Member

@inodb inodb left a comment

Choose a reason for hiding this comment

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

LGTM

@inodb inodb merged commit a9036d2 into cBioPortal:master Oct 2, 2023
jagnathan pushed a commit to pughlab/cbioportal that referenced this pull request Nov 8, 2023
* Improve keycloak configuration docs

- document url to download IDP SSO descriptor xml file.
- add complete logback xml file example to turn on DEBUG level
- document how to bind mount the logback xml file to docker container
- document what role name stands for when filter_groups_by_appname=false/true

Co-authored-by: Ruslan Forostianov <[email protected]>
Co-authored-by: pieterlukasse <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants