-
Notifications
You must be signed in to change notification settings - Fork 25.4k
[DOCS] Standardize docs for url
setting
#41117
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
[DOCS] Standardize docs for url
setting
#41117
Conversation
Pinging @elastic/es-security |
To provide a single URL, use the `ldap` protocol: `ldap://server1:636`. To | ||
provide multiple URLs, use the `ldaps` protocol with an array syntax: | ||
`["ldaps://server1:636", "ldaps://server2:636" ]`. You can't mix the `ldap` and | ||
`ldaps` URL protocols. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is incorrect, though it's a logical interpretation of the old text (hence the need to update it)
Ignoring, for a moment, what we want the docs to say, the rules are:
- you can specific
ldap
orldaps
protocols for a single URL. - you can specific
ldap
orldaps
protocols when providing multiple URLs, but you must be consistent across all URLs. That is, they must all beldap
or must all beldaps
. - if providing multiple URLs you can either:
- use YAML array syntax
url: ["ldaps://server1:636", "ldaps://server2:636" ]
; or - use a comma separated string:
url: "ldaps://server1:636,ldaps://server2:636"
- use YAML array syntax
I struggle to find the sweet spot between documenting every possible option, and overwhelming the reader with too much information, vs just documenting a common set of option and have users get confused about why a certain behaviour is not documented.
Which is to say, I'm not sure whether it would be better to document all of the rules that I've written above, or simplify to it.
To provide a single URL, use the `ldap` protocol: `ldap://server1:389`. To | ||
provide multiple URLs, use the `ldaps` protocol with an array syntax: | ||
`["ldaps://server1:389", "ldaps://server2:389" ]`. You can't mix the `ldap` and | ||
`ldaps` URL protocols. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As per above - whatever we decide to do there should be included here.
Thanks for the feedback and corrections @tvernum. I revised the definitions with ef9d7d7. To help balance simplicity v. documenting everything, I tried to create an information hierarchy using paragraphs. All important and common information should be captured in the first paragraph. More advanced information and options are presented further on. Please let me know if this doesn't accurately reflect the rules you outlined. Also let me know if you feel this should be simplified more. |
To provide multiple URLs, use a YAML array (`["ldap://server1:636", "ldap://server2:636"]`) | ||
or comma-separated string (`"ldap://server1:636, ldap://server2:636"`). | ||
+ | ||
While both are supported, you can't mix the `ldap` and `ldaps` protocols. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The above is correct.
I do wonder whether the last sentence is too colloquial for non-native speakers, but I'll defer to the the docs team on that.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
url
Active Directory realm setting to indicate you can provide multiple URLsurl
setting in LDAP and Active Directory realmsResolves #32830