FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

docs: misc improvements by georglauterbach · Pull Request #3773 · docker-mailserver/docker-mailserver · GitHub

/ docker-mailserver Public

docs: misc improvements - #3773

Merged
georglauterbach merged 12 commits into
masterfrom
docs/misc-improvements
Jan 16, 2024
ConversationCommits (12)ChecksFiles changed
Merged

docs: misc improvements#3773
georglauterbach merged 12 commits into
masterfrom
docs/misc-improvements

Conversation

georglauterbach commented Jan 11, 2024 •
edited by polarathene
Loading

Copy link
Copy Markdown
Member

Description

  1. Bumped MkDocs version
  2. Unified spelling for "behaviour" -> "behavior"
  3. Added information to the Rspamd docs page as requested in tests: normalizations #3747

Review commit by commit is advised.

Type of change

  • 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 made corresponding changes to the documentation (README.md or the documentation under docs/)
  • I have added information about changes made in this PR to CHANGELOG.md

correct misc typos
7ba8767 
We also seem to be favoring `behavior` over `behaviour`.
bump MkDocs version
6cecd96
resolve errors shown when buildg docs
1aceb68
improve the Rspamd page
d79ce63
behaviour -> behavior
77c9314 
Streamline the usage of this word. The majority used behavior, so I
opted to go with this way of spelling it.
georglauterbach added kind/improvement Improve an existing feature, configuration file or the documentation area/documentation labels Jan 11, 2024
georglauterbach added this to the v14.0.0 milestone Jan 11, 2024
georglauterbach self-assigned this Jan 11, 2024

georglauterbach commented Jan 11, 2024 •
edited
Loading

Copy link
Copy Markdown
Member Author

1aceb68 could have used a more detailed message. I suggest to use MkDocs version to 9.5 and then serve the docs locally on the current master. You'll then see the issues I am referring to. Sorry for not putting this into the commit message.

polarathene requested changes Jan 12, 2024
View reviewed changes

polarathene left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Thanks for addressing all those link issues!

New docs look good, although we have different tones 😝 (yours is more personalized like a conversation, mine is more instructive/technical)

Comment thread docs/content/config/security/rspamd.md Outdated
Comment thread docs/content/config/security/rspamd.md Outdated
Comment thread docs/content/config/security/rspamd.md Outdated
Comment thread docs/mkdocs.yml
Comment thread .github/workflows/scripts/docs/build-docs.sh Outdated
Apply suggestions from code review
2a7dfcc 
Co-authored-by: Brennan Kinney <5098581+polarathene@users.noreply.github.com>

georglauterbach commented Jan 13, 2024 •
edited
Loading

Copy link
Copy Markdown
Member Author

Thanks for addressing all those link issues!

🚀

New docs look good, although we have different tones 😝 (yours is more personalized like a conversation, mine is more instructive/technical)

I like yours better :D Thank you for your suggestions! :)

NOTE: I enabled auto-merge.

georglauterbach enabled auto-merge (squash) January 13, 2024 16:22

polarathene commented Jan 14, 2024

Copy link
Copy Markdown
Member

Just to clarify, were you not wanting to address the feedback regarding IP? Am I right to assume the IP is not actually the same in all locations?

georglauterbach commented Jan 14, 2024

Copy link
Copy Markdown
Member Author

My bad, I missed that. I was on mobile and low on time - sorry! I will fix it.

georglauterbach commented Jan 15, 2024 •
edited
Loading

Copy link
Copy Markdown
Member Author

I updated the whole example in 80ad173. The IP really is the same. We should be good to go now 🚀

I also didn't know about all the reserved IP address blocks - thanks for showing me!

UPDATE: sorry for the force-push; just a minor correction of 53cbd9e (old)

polarathene approved these changes Jan 15, 2024
View reviewed changes

polarathene left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

If you have better wording for the changelog feel free to update that. Main focus of the PR was that addition to rspamd docs, so I didn't highlight the other docs maintenance touchups/fixes bundled in this PR.

polarathene modified the milestones: v14.0.0, v13.3.0 Jan 15, 2024

georglauterbach commented Jan 16, 2024

Copy link
Copy Markdown
Member Author

I'm fine with the wording :)

github-actions Bot commented Jan 16, 2024

Copy link
Copy Markdown
Contributor

Documentation preview for this PR is ready! 🎉

Built with commit: 18c2975

georglauterbach merged commit 068ceb1 into master Jan 16, 2024
georglauterbach deleted the docs/misc-improvements branch January 16, 2024 08:38
polarathene mentioned this pull request Jan 25, 2024
Closed
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
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

polarathene polarathene approved these changes

Assignees

georglauterbach

Labels

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

Projects

None yet

Milestone

v13.3.0

Development

Successfully merging this pull request may close these issues.

2 participants

Back | FazBrowse Home | New Git URL