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

Synchronize the repo's and docs README #5105

Merged
merged 1 commit into from
Oct 15, 2024
Merged

Conversation

twz123
Copy link
Member

@twz123 twz123 commented Oct 10, 2024

Description

They diverged a bit over time. Use the mkdocs include-markdown plugin to import the common parts from the repo's README into the docs README.

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 Oct 10, 2024
@twz123 twz123 requested review from a team as code owners October 10, 2024 11:25
@twz123 twz123 force-pushed the sync-readmes branch 2 times, most recently from c337c3b to 8dc9fa6 Compare October 11, 2024 11:35
They diverged a bit over time. Use the mkdocs include-markdown plugin
to import the common parts from the repo's README into the docs README.

Signed-off-by: Tom Wieczorek <[email protected]>
@twz123 twz123 merged commit 92ae77c into k0sproject:main Oct 15, 2024
7 checks passed
@twz123 twz123 deleted the sync-readmes branch October 15, 2024 18:49
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