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

Docs for K3s #517

Merged
merged 8 commits into from
Jun 22, 2021
Merged

Docs for K3s #517

merged 8 commits into from
Jun 22, 2021

Conversation

mortenlj
Copy link
Contributor

This adds a section for K3s in the documentation, to go with MichaIng/DietPi#4476

Replaces #516

@Joulinar Joulinar marked this pull request as draft June 16, 2021 07:26
@Joulinar Joulinar added new content New documentation pages Next DietPi release Changes related to changes made for the upcoming DietPi release. labels Jun 16, 2021
@Joulinar Joulinar added this to the v7.3 milestone Jun 16, 2021
@Joulinar
Copy link
Collaborator

Hi,

I marked the PR as draft. feel free to request a review once you are ready.

@mortenlj
Copy link
Contributor Author

I was wondering if I should add something about more advanced setups, but I think that might be overdoing it. There is enough information here to help people get started, and the rest of the information is better found in the K3s docs anyway.

@mortenlj mortenlj marked this pull request as ready for review June 17, 2021 10:01
@mortenlj mortenlj changed the title First draft of docs for K3s Docs for K3s Jun 17, 2021
@MichaIng
Copy link
Owner

LGTM 👍. You could enable GitHub actions in your repository, so syntax, build, spelling and link checks will be done (which is otherwise the case after merge).

@mortenlj
Copy link
Contributor Author

You could enable GitHub actions in your repository, so syntax, build, spelling and link checks will be done (which is otherwise the case after merge).

Enabled and fixed a few lint and spellcheck errors. Linkchecker never completes locally, so hoping for better luck on GHA.

.wordlist.txt Outdated Show resolved Hide resolved
@MichaIng
Copy link
Owner

Linkchecker never completes locally

I guess it's still liche in your case, right? I just merged the migration to lychee, which is much faster and more reliable. But also not 100%. It's >3000 links checked, and sometimes the worker machine denies/fails at an URL with a timeout then. It's however easy to scroll through the list and verify via browser that the URLs are actually valid.

Things will become again much better with: lycheeverse/lychee#262
All the internal links will be checked via file existence only (currently via locally running webserver), which also allows us to check all files in a single call (currently per-directory, to correctly resolve internal links), which means that duplicate URLs won't be checked multiple times, reducing the overall checked URLs dramatically.

@MichaIng
Copy link
Owner

Ah one last thing: It needs to be added to the overview page as well: https://github.com/MichaIng/DietPi-Docs/blob/dev/docs/software.md#system-stats--management

@mortenlj
Copy link
Contributor Author

Ah one last thing: It needs to be added to the overview page as well: https://github.com/MichaIng/DietPi-Docs/blob/dev/docs/software.md#system-stats--management

Done!

@MichaIng
Copy link
Owner

I'll merge this so we can create a final dev => master PR.

@MichaIng MichaIng merged commit ed06cf6 into MichaIng:dev Jun 22, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
new content New documentation pages Next DietPi release Changes related to changes made for the upcoming DietPi release.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants