README.md and Documentation Update#2389
Merged
georglauterbach merged 5 commits intomasterfrom Feb 5, 2022
Merged
Conversation
Fixes a documentation error by which a list would not be rendered correctly. This has been taken care of.
I felt the need to update the README for several reasons:
1. LDAP issues that the core maintainers team cannot really resolve
2. Cleaning up the somewhat messy structure near the end
The first point goes without explanantion. The second points includes:
2.1. The tagging convention is now easier to read and understand
2.2. Some bullut points or notes have been inlined to "stick" more to
the content that it actually belongs to
2.3. The note about the "old" `setup.sh` for DMS `10.1.0` has been
removed as it is obsolete now. We encourage users to upgrade to
`10.4.0` anyways.
2.4. The markdown code highlighting is now using `CONSOLE` instead of
`BASH` because `CONSOLE` is more appropriate.
2.5. Capitalized headings
2.6. Updated the section about `./setup.sh help` to be in one place now
instead of two
2.7. DKIM key generation does now not interfere with user account
creation.
casperklein
reviewed
Feb 2, 2022
polarathene
requested changes
Feb 2, 2022
Contributor
|
Documentation preview for this PR is ready! 🎉 Built with commit: 38747b3 |
casperklein
approved these changes
Feb 4, 2022
polarathene
approved these changes
Feb 4, 2022
Member
polarathene
left a comment
There was a problem hiding this comment.
LGTM 👍
Nice improvement to the README and thanks for fixing the docs rendering issue 😀
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Follow up on #2383 and update of the
README.md. Please refer to the commit messages for further information on the "why".Type of change
Checklist:
docs/)