Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Integrate ADOPTERS.md in docs #5104

Merged
merged 3 commits into from
Oct 11, 2024

Conversation

twz123
Copy link
Member

@twz123 twz123 commented Oct 10, 2024

Description

  • Move ADOPTERS file into the docs folder, so that it becomes a part of the rendered documentation.
  • Re-add an ADOPTERS.md in the project root as a symlink to docs/adopters.md, so that it shows up in the project root, as well.
  • Add the adopters to the docs navigation

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

@twz123 twz123 added the documentation Improvements or additions to documentation label Oct 10, 2024
@twz123 twz123 requested review from a team as code owners October 10, 2024 10:55
@twz123 twz123 requested review from ncopa and jnummelin October 10, 2024 10:55
So that it becomes a part of the rendered documentation.

Signed-off-by: Tom Wieczorek <twieczorek@mirantis.com>
So that it is directly visible at the project root.

Signed-off-by: Tom Wieczorek <twieczorek@mirantis.com>
Signed-off-by: Tom Wieczorek <twieczorek@mirantis.com>
@twz123 twz123 force-pushed the integrate-adopters-in-docs branch from ceb29da to fee5f7a Compare October 10, 2024 11:07
Copy link
Member

@jnummelin jnummelin left a comment

Choose a reason for hiding this comment

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

LGTM

@twz123 twz123 merged commit 5125466 into k0sproject:main Oct 11, 2024
7 checks passed
@twz123 twz123 deleted the integrate-adopters-in-docs branch October 11, 2024 06:19
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants