Skip to content

docs: Fix URL#3337

Merged
casperklein merged 1 commit intomasterfrom
casperklein-patch-1
May 14, 2023
Merged

docs: Fix URL#3337
casperklein merged 1 commit intomasterfrom
casperklein-patch-1

Conversation

@casperklein
Copy link
Copy Markdown
Member

@casperklein casperklein commented May 14, 2023 •
edited
Loading

Description

See title 😎

BTW: IIRC there was in the docs a link/button, to easily change/contribute to our docs. Is that gone? This time I went to this repo and looked for usage.md, which wasn't as comfortable as before.

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 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

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 14, 2023

Documentation preview for this PR is ready! 🎉

Built with commit: 1b7bed5

@casperklein casperklein marked this pull request as ready for review May 14, 2023 12:36
@casperklein casperklein self-assigned this May 14, 2023
@casperklein casperklein added area/documentation kind/bug/fix A fix (PR) for a confirmed bug labels May 14, 2023
georglauterbach
georglauterbach approved these changes May 14, 2023
View reviewed changes
Copy link
Copy Markdown
Member

@georglauterbach georglauterbach left a comment

Choose a reason for hiding this comment

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

LGTM

About the button: I had no idea we had such a button 😂

@casperklein
Copy link
Copy Markdown
Member Author

casperklein commented May 14, 2023 •
edited
Loading

About the button: I had no idea we had such a button 😂

That makes it pretty easy to contribute to our docs 🚀

We have an edit button configured:

docker-mailserver/docs/mkdocs.yml

Lines 11 to 13 in 9fd00bd

# All docs `edit` button will go to this subpath of the `repo_url`:
# For versioned docs, this may be a little misleading for a user not viewing the `edge` docs which match the `master` branch.
edit_uri: 'edit/master/docs/content'

But doesn't seem to work anymore 🤷

Edit: #3338

@casperklein casperklein merged commit 063b1bf into master May 14, 2023
@casperklein casperklein deleted the casperklein-patch-1 branch May 14, 2023 21:09
@casperklein casperklein mentioned this pull request May 28, 2023
Closed
@casperklein casperklein mentioned this pull request Jun 14, 2023
Closed
@casperklein casperklein mentioned this pull request Jun 27, 2023
Closed
1 task
@casperklein casperklein mentioned this pull request Jul 13, 2023
Closed
1 task
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@georglauterbach georglauterbach georglauterbach approved these changes

Assignees

@casperklein casperklein

Labels

area/documentation kind/bug/fix A fix (PR) for a confirmed bug

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@casperklein @georglauterbach