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

docs(podman): Fix broken links and add version hints #2429

Merged
merged 2 commits into from
Feb 21, 2022

Conversation

p-fruck
Copy link
Contributor

@p-fruck p-fruck commented Feb 21, 2022

Description

This is a follow up of #2393, where I accidentally added broken links to the podman documentation.

In addition to this fix, I've added some version hints to the changes introduced in the aforementioned PR to circumvent issues like this

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

Copy link
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.

The Version warning should afaik not be necessary as the docs are Versioned as well and released Always together with a new Container Version.
Looking at the "Edge" Docs is valid for the "Edge" build of the Container. But switching to Docs Version "10.4" (which counts for the 10.4 builds) will not contain the newest additions.

In fact we implemented the Versioned Docs for exactly that reason, to avoid updating references and Versions throughout the Docs.

If it Happens to be the Case that "newer" Docs are in a "older" Release we messed Up the Release/merge process but not the Docs (content)

@p-fruck
Copy link
Contributor Author

p-fruck commented Feb 21, 2022

Hmm, seems like I should enable JS every once in a while... Now I see the versioning dropdown 😄 I'll revert the versioning related changes from the docs. Should I also revert the change in this line in the env file?

@georglauterbach georglauterbach requested a review from a team February 21, 2022 18:18
@georglauterbach georglauterbach added area/documentation kind/improvement Improve an existing feature, configuration file or the documentation priority/low priority/medium labels Feb 21, 2022
@georglauterbach georglauterbach added this to the v10.5.0 milestone Feb 21, 2022
polarathene
polarathene previously approved these changes Feb 21, 2022
@georglauterbach
Copy link
Member

georglauterbach commented Feb 21, 2022

Should I also revert the change in this line in the env file?

Yes. The none case is not visible in the current documentation and will only appear from 10.5.0 and onwards if I'm not mistaken.

@github-actions
Copy link
Contributor

Documentation preview for this PR is ready! 🎉

Built with commit: 1d0b909

@p-fruck
Copy link
Contributor Author

p-fruck commented Feb 21, 2022

Alright, I've reverted all changes except for the typo and the broken links 👍

Copy link
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.

Thanks

@polarathene polarathene merged commit 83231da into docker-mailserver:master Feb 21, 2022
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/low priority/medium
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants