Skip to content

README.md and Documentation Update#2389

Merged
georglauterbach merged 5 commits intomasterfrom
docs/update-and-followup
Feb 5, 2022
Merged

README.md and Documentation Update#2389
georglauterbach merged 5 commits intomasterfrom
docs/update-and-followup

Conversation

@georglauterbach
Copy link
Copy Markdown
Member

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

  • Improvement (non-breaking change that does improve existing functionality)
  • This change is a documentation update

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation (README.md or the documentation under docs/)
  • If necessary I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes

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.
@georglauterbach georglauterbach added priority/medium kind/improvement Improve an existing feature, configuration file or the documentation area/documentation kind/bugfix labels Feb 1, 2022
@georglauterbach georglauterbach added this to the v10.5.0 milestone Feb 1, 2022
@georglauterbach georglauterbach self-assigned this Feb 1, 2022
wernerfred
wernerfred previously approved these changes Feb 1, 2022
Copy link
Copy Markdown
Member

@wernerfred wernerfred left a comment

Choose a reason for hiding this comment

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

LGTM

Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md
Comment thread README.md Outdated
Comment thread docs/content/config/security/ssl.md Outdated
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Feb 2, 2022

Documentation preview for this PR is ready! 🎉

Built with commit: 38747b3

Copy link
Copy Markdown
Member

@polarathene polarathene left a comment

Choose a reason for hiding this comment

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

LGTM 👍

Nice improvement to the README and thanks for fixing the docs rendering issue 😀

@georglauterbach georglauterbach merged commit 4cb617f into master Feb 5, 2022
@georglauterbach georglauterbach deleted the docs/update-and-followup branch February 5, 2022 09:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/documentation kind/improvement Improve an existing feature, configuration file or the documentation priority/medium

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants