2.0.0 Chore: publish new mkdocs site #95

Closed
opened 2023-12-01 12:48:06 +00:00 by jessebot · 4 comments
jessebot commented 2023-12-01 12:48:06 +00:00 (Migrated from github.com)

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
## 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`: - [x] argocd - [x] cert-manager - [x] cilium - [x] cnpg operator - [x] external secrets operator - [x] bweso - [x] k8up - [x] kepler - [x] kubevirt - [x] kyverno - [x] matrix - [x] mastodon - [x] minio - [x] nextcloud - [x] seaweedfs - [x] vault - [x] vouch - [x] zitadel Other stuff to do: - [x] add video with a walk through of setting up a new cluster - [x] figure out how to generate subtitles for the video - [x] add video with a walk through of modifying an existing cluster - [x] make sure every screen has a screenshot and alt text - [x] home screen - [x] distro screen - [x] apps screen - [x] confirmation screen - [x] config screen - [x] bitwarden - credentials screen - [ ] bitwarden - ask screen
jessebot commented 2023-12-01 14:43:49 +00:00 (Migrated from github.com)

#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 https://github.com/small-hack/smol-k8s-lab/pull/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: https://github.com/small-hack/smol-k8s-lab/pull/106

another doc and minor tui fix PR: https://github.com/small-hack/smol-k8s-lab/pull/108

#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 https://github.com/small-hack/smol-k8s-lab/pull/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: https://github.com/small-hack/smol-k8s-lab/pull/106 another doc and minor tui fix PR: https://github.com/small-hack/smol-k8s-lab/pull/108
jessebot commented 2023-12-04 08:06:52 +00:00 (Migrated from github.com)

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:
small-hack/smol-k8s-lab@f0e17b506b
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:
small-hack/smol-k8s-lab@c8f4997086/docs/stylesheets/fonts.css (L3)

oh no, the mkdocs release failed: https://github.com/small-hack/smol-k8s-lab/actions/runs/7083647334/job/19276404859#step:7:47 :facepalm: I will look into it. The fonts still don't work either.... Okay for the video error, I fixed it here: https://github.com/small-hack/smol-k8s-lab/commit/f0e17b506b259454a53bc154d04d465f305daa9f 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: https://github.com/small-hack/smol-k8s-lab/blob/c8f4997086a79e764834c080c41308e06e08ac82/docs/stylesheets/fonts.css#L3
jessebot commented 2023-12-04 14:43:57 +00:00 (Migrated from github.com)
We have a video now 🥳 https://www.youtube.com/watch?v=UdOQM9n5hyU&t=0s
jessebot commented 2024-03-15 11:22:19 +00:00 (Migrated from github.com)

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: https://github.com/small-hack/smol-k8s-lab/pull/163

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: https://github.com/small-hack/smol-k8s-lab/pull/163
Sign in to join this conversation.
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
small-hack/smol-k8s-lab#95
No description provided.