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

2.0.0 Chore: publish new mkdocs site #95

Closed
28 of 29 tasks
jessebot opened this issue Dec 1, 2023 · 4 comments · Fixed by #163
Closed
28 of 29 tasks

2.0.0 Chore: publish new mkdocs site #95

jessebot opened this issue Dec 1, 2023 · 4 comments · Fixed by #163
Assignees
Labels
DO THE THING >:( very important thing 📓documentation Improvements or additions to documentation ✨ enhancement New feature request

Comments

@jessebot
Copy link
Collaborator

jessebot commented Dec 1, 2023

Describe the feature you'd like, and why

we don't have the new docs site up D: We need it before we can release v2.0.0

App check list of pages to review before we launch v2.0.0:

  • argocd
  • cert-manager
  • cilium
  • cnpg operator
  • external secrets operator
    • bweso
  • k8up
  • kepler
  • kubevirt
  • kyverno
  • matrix
  • mastodon
  • minio
  • nextcloud
  • seaweedfs
  • vault
  • vouch
  • zitadel

Other stuff to do:

  • add video with a walk through of setting up a new cluster
  • figure out how to generate subtitles for the video
  • add video with a walk through of modifying an existing cluster
  • make sure every screen has a screenshot and alt text
    • home screen
    • distro screen
    • apps screen
    • confirmation screen
    • config screen
    • bitwarden - credentials screen
    • bitwarden - ask screen
@jessebot jessebot added the ✨ enhancement New feature request label Dec 1, 2023
@jessebot
Copy link
Collaborator Author

jessebot commented Dec 1, 2023

#98 is the main PR for updating to using mkdocs, thanks @cloudymax, but we'll need more PRs for all the other tasks on the checklist.

Working on #104 to polish more docs.

Should probably also get #101 (automated screenshot generation) working to save me the hassle.

Just merged more doc fixes here: #106

another doc and minor tui fix PR: #108

@jessebot jessebot changed the title Feature Request: publish new mkdocs site 2.0.0 Chore: publish new mkdocs site Dec 1, 2023
@jessebot jessebot pinned this issue Dec 1, 2023
@jessebot jessebot added 📓documentation Improvements or additions to documentation DO THE THING >:( very important thing labels Dec 1, 2023
@jessebot
Copy link
Collaborator Author

jessebot commented Dec 4, 2023

oh no, the mkdocs release failed:
https://github.com/small-hack/smol-k8s-lab/actions/runs/7083647334/job/19276404859#step:7:47

🤦 I will look into it. The fonts still don't work either....

Okay for the video error, I fixed it here:
f0e17b5
https://github.com/small-hack/smol-k8s-lab/actions/runs/7083745465/job/19276685711

Fonts though 🤔 I don't get it because when I run mkdocs serve locally, the fonts work fine...

Update: I think fonts are working now! I think this was the fix:

src: url("../assets/fonts/MononokiNerdFont-Regular.ttf");

@jessebot
Copy link
Collaborator Author

jessebot commented Dec 4, 2023

We have a video now 🥳
https://www.youtube.com/watch?v=UdOQM9n5hyU&t=0s

@jessebot
Copy link
Collaborator Author

ok, so this is all done sans the bitwarden ask screen, but I'm not quite sure how to do that yet so it will have to wait 🤔 In the meantime, the final screenshots will be published when this PR is merged: #163

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
DO THE THING >:( very important thing 📓documentation Improvements or additions to documentation ✨ enhancement New feature request
Projects
None yet
2 participants