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

Improve k0s-in-docker docs #5117

Merged
merged 1 commit into from
Oct 14, 2024
Merged

Conversation

bnallapeta
Copy link
Contributor

Description

This PR improves the Docker setup documentation for k0s. It includes improved instructions for accessing the cluster locally, with guidance on configuring the kubeconfig file to work with localhost.

Fixes # (issue)

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

@bnallapeta bnallapeta requested review from a team as code owners October 14, 2024 08:55
docs/k0s-in-docker.md Outdated Show resolved Hide resolved
@jnummelin
Copy link
Member

@bnallapeta DCO bot is not happy to see the first commit being not signed off properly. So pls rebase/squash the commits together, or edit the first one to have signoff and drop the last one.

Linter is not happy either:

Error: docs/k0s-in-docker.md:80:1 MD029/ol-prefix Ordered list item prefix [Expected: 1; Actual: 2; Style: 1/1/1]
Error: docs/k0s-in-docker.md:90:1 MD029/ol-prefix Ordered list item prefix [Expected: 1; Actual: 3; Style: 1/1/1]
Error: docs/k0s-in-docker.md:96:1 MD029/ol-prefix Ordered list item prefix [Expected: 1; Actual: 4; Style: 1/1/1]

Signed-off-by: bnallapeta <[email protected]>
@jnummelin jnummelin merged commit c15ffc8 into k0sproject:main Oct 14, 2024
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants