Skip to content

docs: Use a specific rather than a generic message for documenting the authentication provider#4806

Open
iansergeant42 wants to merge 11 commits into
v3.x.xfrom
reboot/specific-message-for-provider-usage
Open

docs: Use a specific rather than a generic message for documenting the authentication provider#4806
iansergeant42 wants to merge 11 commits into
v3.x.xfrom
reboot/specific-message-for-provider-usage

Conversation

@iansergeant42

Copy link
Copy Markdown
Contributor

Description

This change makes it easier to document the ZWEAM105 message by linking it specifically to documenting which authentication provider is being used rather than being a generic message.

Linked to # (issue)
Part of the # (epic)

Type of change

Please delete options that are not relevant.

  • docs: Change in a documentation
  • refactor: Refactor the code

Checklist:

  • My code follows the style guidelines of this project
  • PR title conforms to commit message guideline ## Commit Message Structure Guideline
  • I have commented my code, particularly in hard-to-understand areas. In JS I did provide JSDoc
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • The java tests in the area I was working on leverage @nested annotations
  • Any dependent changes have been merged and published in downstream modules

For more details about how should the code look like read the Contributing guideline

Signed-off-by: Ian Sergeant <ian.sergeant@broadcom.com>
@github-actions github-actions Bot added the Sensitive Sensitive change that requires peer review label Jul 13, 2026
@iansergeant42 iansergeant42 changed the title Use a specific rather than a generic message for documenting the authentication provider docs: Use a specific rather than a generic message for documenting the authentication provider Jul 13, 2026
Comment thread common-service-core/src/main/resources/core-log-messages.yml Outdated
Co-authored-by: Andrew Jandacek <andrew.jandacek@broadcom.com>
Signed-off-by: Andrew Jandacek <andrew.jandacek@broadcom.com>
Comment thread common-service-core/src/main/resources/core-log-messages.yml Outdated
Co-authored-by: Andrew Jandacek <andrew.jandacek@broadcom.com>
Signed-off-by: iansergeant42 <129340641+iansergeant42@users.noreply.github.com>
Signed-off-by: iansergeant42 <129340641+iansergeant42@users.noreply.github.com>
…/CompoundAuthProvider.java

Signed-off-by: iansergeant42 <129340641+iansergeant42@users.noreply.github.com>
…/CompoundAuthProvider.java

Signed-off-by: iansergeant42 <129340641+iansergeant42@users.noreply.github.com>
@iansergeant42 iansergeant42 marked this pull request as ready for review July 14, 2026 08:25
Comment thread common-service-core/src/main/resources/core-log-messages.yml Outdated
Signed-off-by: Ian Sergeant <ian.sergeant@broadcom.com>
@sonarqubecloud

Copy link
Copy Markdown

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

Labels

Sensitive Sensitive change that requires peer review size/S

Projects

Development

Successfully merging this pull request may close these issues.

4 participants