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

Fix link to adopters in the project README #5304

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

twz123
Copy link
Member

@twz123 twz123 commented Nov 29, 2024

Description

After moving the adopters file to the project root, the link in the project README pointed to the include file for mkdocs. Fix this by making it point to the real thing again. Since rewriting the link doesn't really work when using it as an include, duplicate this little paragraph in both READMES.

Fixes:

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update

How Has This Been Tested?

  • Manual test
  • Auto test added

Checklist:

  • My code follows the style guidelines of this project
  • My commit messages are signed-off
  • 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
  • My changes generate no new warnings
  • 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
  • Any dependent changes have been merged and published in downstream modules
  • I have checked my code and corrected any misspellings

After moving the adopters file to the project root, the link in the
project README pointed to the include file for mkdocs. Fix this by
making it point to the real thing again. Since rewriting the link
doesn't really work when using it as an include, duplicate this little
paragraph in both READMES.

Fixes: 3d57e41 ("Move adopters.md back into the project root")
Signed-off-by: Tom Wieczorek <[email protected]>
@twz123 twz123 added the documentation Improvements or additions to documentation label Nov 29, 2024
@twz123 twz123 requested review from a team as code owners November 29, 2024 13:13
@twz123 twz123 requested review from ncopa and makhov November 29, 2024 13:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant