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

Include adopters in docs so that ADOPTERS.md is not a symlink #5262

Merged
merged 3 commits into from
Nov 18, 2024

Conversation

twz123
Copy link
Member

@twz123 twz123 commented Nov 15, 2024

Description

This is better than the symlink approach, because it allows the file to live in its "canonical" place in the repository, while also avoiding duplication when including the adopters in the docs. In fact, this opens up more fine-grained control over how they are included, should that become necessary in the future.

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 documentation Improvements or additions to documentation chore labels Nov 15, 2024
This is better than the symlink approach, because it allows the file
to live in its "canonical" place in the repository, while also avoiding
duplication when including the adopters in the docs. In fact, this opens
up more fine-grained control over how they are included, should that
become necessary in the future.

Signed-off-by: Tom Wieczorek <[email protected]>
@twz123 twz123 marked this pull request as ready for review November 15, 2024 12:30
@twz123 twz123 requested review from a team as code owners November 15, 2024 12:30
@twz123 twz123 requested review from kke and jnummelin November 15, 2024 12:30
@twz123 twz123 merged commit f70d807 into k0sproject:main Nov 18, 2024
7 checks passed
@twz123 twz123 deleted the include-adopters branch November 18, 2024 10:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
chore documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants