Skip to content

Update LDAP guide#40

Merged
nscuro merged 1 commit intomainfrom
update-ldap-guide
Apr 29, 2026
Merged

Update LDAP guide#40
nscuro merged 1 commit intomainfrom
update-ldap-guide

Conversation

@nscuro
Copy link
Copy Markdown
Member

@nscuro nscuro commented Apr 29, 2026

  • Specifies all configs in property name format to better align with the rest of the docs.
  • Fixes all vale lint warnings.
  • Adds abbreviation for LDAP.

* Specifies all configs in property name format to better align with the rest of the docs.
* Fixes all vale lint warnings.
* Adds abbreviation for LDAP.

Signed-off-by: nscuro <nscuro@protonmail.com>
@nscuro nscuro added the enhancement New feature or request label Apr 29, 2026
Copilot AI review requested due to automatic review settings April 29, 2026 19:50
@nscuro nscuro merged commit 9375da5 into main Apr 29, 2026
7 checks passed
@nscuro nscuro deleted the update-ldap-guide branch April 29, 2026 19:53
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Updates the LDAP administration guide to better align configuration examples with the docs’ property-name format, while also addressing Vale linting by adding/accepting relevant terminology (including LDAP as an abbreviation).

Changes:

  • Rewrites LDAP configuration examples to use dt.* property names instead of environment variables and adds clearer explanatory callouts.
  • Updates wording, headings, and links in the LDAP guide for consistency and readability.
  • Extends docs abbreviations and Vale accepted vocabulary to include LDAP and directory-related terms used in the guide.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.

File Description
docs/includes/abbreviations.md Adds an LDAP abbreviation expansion used across the docs site.
docs/guides/administration/configuring-ldap.md Converts examples to property-name format and refines narrative, links, and headings.
.vale/styles/config/vocabularies/DependencyTrack/accept.txt Adds accepted terms (e.g., LDAP, Active Directory, ApacheDS) to satisfy Vale.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment on lines +36 to +38
!!! tip
Dependency-Track substitutes the `{0}` placeholder in `dt.ldap.auth.username.format`
with the username entered at login.
Copy link

Copilot AI Apr 29, 2026

Choose a reason for hiding this comment

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

dt.ldap.auth.username.format examples and the tip use a {0} placeholder, but the configuration reference for that property currently documents %s as the substitution variable (docs/reference/configuration/properties.md under dt.ldap.auth.username.format). Please align the placeholder syntax between this guide and the reference (either update the guide to %s or update the reference to {0}), otherwise readers may copy a format string that won't work at runtime.

Copilot uses AI. Check for mistakes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants