docs(ldap): Improve LDAP documentation#1921
docs(ldap): Improve LDAP documentation#1921polarathene merged 16 commits intodocker-mailserver:masterfrom
Conversation
|
LGTM Reach back to us when this can be reviewed. |
georglauterbach
added
area/documentation
area/enhancement
kind/improvement
| ## LDAP Setup Examples | ||
|
|
||
| ### Basic Setup |
There was a problem hiding this comment.
If the intention is to just provide some config snippets here with no other content, you could drop the headings and collapse the admonitions (??? instead of ???+), then an interested user clicks it to expand the config example.
I don't mind either way.
There was a problem hiding this comment.
I purposefully expanded the basic setup example, as that's probably what most people are coming for to the documentation. Is that fine or do you think that the example is too long?
There was a problem hiding this comment.
I'm fine with it for the same reason you stated
There was a problem hiding this comment.
I agree that we should remove the headers though, or at least make the Kopano header the same level
|
What's the status here @moqmar ? |
|
I've got a lot of stuff to do for university right now, will get back to this next week probably. |
moqmar
changed the title
|
I'll try to complete those tomorrow, but can't say for sure yet. If you don't hear from me until tomorrow evening, probably don't let this be a blocker for v10.0.0. |
|
Reviewers can now view the new docs page 🎉 Might be a nice improvement if I can find a way to have the workflow link to pages changed/added directly. |
Co-authored-by: Brennan Kinney <[email protected]>
…AUTH_BIND section
|
@polarathene shouldn't we see a new comment after this new commit? EDIT: Ah I see that the bot edited the comment. Was this only bc his comment was the last one or is this the default behaviour? Just asking bc if there is a lot of discussion it would be nice if the new deployed preview is the most recent comment. We'll see with further updates here how it behaves. EDIT2: Now bot updated the comment a thrid time EDIT3: the action hast multiple input options: https://github.com/marocchino/sticky-pull-request-comment#inputs |
@wernerfred This was intentional by me. The existing comment is edited each time with the latest commit. The deployment URL is always the same (I don't think we have much reason to create a new one for each commit update to a PR?). If the action was updated to be compatible with I'll look into the recreate comment behaviour on my test repo and then provide a review for your PR. |
I already added a pr #1992 have a look
I am thinking of PRs that get a lot of discussion going on (we had a bunch with 50-100 comments+) then it is super useful to have the preview link always at the end where the latest commit was. On PRs with less comments and discussion then recreating (deleting old and adding new although the link stays the same) doesnt disturb either as one would not see a difference as the old one gets deleted. And a notification is send either way if there is only a new commit or a commit + a comment |
wernerfred
left a comment
wernerfred
left a comment
There was a problem hiding this comment.
LGTM 👍🏻
Thanks for your contribution!
|
@polarathene Feel free to merge this when you have approved it :D |
|
Documentation preview for this PR is ready! 🎉 Built with commit: d15936a |
|
Thank you very much for taking the time to put all this together @moqmar ! 😀 |
4 participants
Description
As discussed in #1902 (comment), this completely overhauls the LDAP documentation and actually explains what most of the variables do. Looking forward to feedback.
Type of change
Checklist:
I have commented my code, particularly in hard-to-understand areasI have made corresponding changes to the documentation (README.md or ENVIRONMENT.md or the documentation)If necessary I have added tests that prove my fix is effective or that my feature worksNew and existing unit tests pass locally with my changes