-
Notifications
You must be signed in to change notification settings - Fork 66
Clarify user authentication doc on ECH #1275
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
Conversation
Make it clear that LDAP is not configurable for Elastic Cloud hosted environment.
clarify some types of user authentication are not applicable on ECH
@kunisen First, let me say that I totally understand the concern here. One new principle coming with these new docs is that we're trying to convey the applicability through metadata whenever possible rather than with callouts. While we will usually prefer to list what something is applicable to rather than not applicable to, such cases should indeed leave no ambiguity to avoid any confusion for users. To not deviate from this new principle and go along with the new standard (that hopefully users will get used to fairly rapidly), I would then propose to use tags rather than callouts. This would give something like this for the concerned pages: ![]() ![]() Let me know what you think. |
Thank you @florent-leborgne so much for the detailed explanation! Personally, I am ++ on this as I think we can try as you suggested and revisit this if we still keep getting the support cases about similar topic. I'd also let @maggieghamry share her opinion since she's also proactively helping support engineers and customers by making our docs more clear and succinct. 🙏 |
I don't mind @florent-leborgne's suggested approach personally, but I think we're not ready to use inline applies tags like this .... these are brand new and were introduced as a bandaid, meant to indicate the availability of things like settings in reference documentation. Following our current guidance, I think we'd need to do something like this instead:
Regarding the page-level applies tags, we aren't using There's also a concern about these missing serverless context if we call out non-availability explicitly, for all of these realms. |
@kunisen I had a quick chat with @shainaraskas and we agreed on the following in order to stick as much as possible to our current docs guidelines:
Let me know if that would work for you and I'll be happy to implement the changes. |
Thank you again @florent-leborgne for the detailed explanation and proactive help as always! |
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.
👍 LGTM after the changes that we discussed. I'll just also quickly replace some names with their corresponding variable and I'll merge it.
Description
Make it clear that LDAP, Active Directory and PKI is not configurable for Elastic Cloud hosted environment.
Background:
I also found Active Directory and PKI are the same that are not applicable on ECH.
So I made a quick doc PR to make these related user authentication docs clear.
After PR is merged
The orange sections will be added
Additional Notes
To doc team: Maybe we could also use
note
instead ofwarning
. I don't have strong opinion here. Would leave this to your capable hands for decision 🙏