Skip to content
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

Better incorporate the new, great documentation #1878

Merged
merged 6 commits into from Apr 1, 2021
Merged

Better incorporate the new, great documentation #1878

merged 6 commits into from Apr 1, 2021

Conversation

georglauterbach
Copy link
Member

Description

The new documentation is fabulous. We should include it better. I have made adjustments to the README and added a docs page. Many links to the docs were added in the hope of having more people reading this documentation.

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Improvement (non-breaking change that does improve existing functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires 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 ENVIRONMENT.md or the documentation)
  • 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

@georglauterbach georglauterbach added pr/needs review priority/medium kind/improvement Improve an existing feature, configuration file or the documentation area/documentation labels Mar 31, 2021
@georglauterbach georglauterbach self-assigned this Mar 31, 2021
casperklein
casperklein previously approved these changes Mar 31, 2021
Copy link
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.

This looks great, thanks! 😃

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
docs/mkdocs.yml Outdated Show resolved Hide resolved
docs/content/index.md Show resolved Hide resolved
docs/content/config/advanced/user-patches.md Outdated Show resolved Hide resolved
docs/mkdocs.yml Show resolved Hide resolved
@georglauterbach georglauterbach enabled auto-merge (squash) April 1, 2021 13:56
@georglauterbach georglauterbach merged commit 65622c5 into docker-mailserver:master Apr 1, 2021
@georglauterbach georglauterbach deleted the doc-upgrade branch April 1, 2021 21:14
@wernerfred wernerfred mentioned this pull request May 31, 2021
9 tasks
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.

None yet

3 participants