quick org + index + readme fixes

Signed-off-by: clux <[email protected]>
kube-rs · Oct 4, 2023 · d4403ed · d4403ed
1 parent 4e0c660
commit d4403ed
Show file tree

Hide file tree

Showing 3 changed files with 51 additions and 20 deletions.
diff --git a/README.md b/README.md
@@ -1,19 +1,19 @@
 # kube-rs website
 
 [![release](https://github.com/kube-rs/website/actions/workflows/release.yml/badge.svg)](https://github.com/kube-rs/website/actions/workflows/release.yml)
-
-Markdown resources and scripts for generating the [kube.rs](https://kube.rs) website.
+Markdown documents and scripts for generating the [kube.rs](https://kube.rs) website.
 
 Hosted on [github pages](https://kube-rs.github.io/website).
 
 ## Setup
 
-This repo uses [foam](https://foambubble.github.io/foam/) + [`mkdocs`](https://www.mkdocs.org/) with [mkdocs-material](https://squidfunk.github.io/mkdocs-material/).
-
-To browse locally in `code`; [clone + install recommended extensions](https://foambubble.github.io/foam/#getting-started) to browse with [markdown links](https://marketplace.visualstudio.com/items?itemName=tchayen.markdown-links).
+This repo uses [`mkdocs`](https://www.mkdocs.org/) with [mkdocs-material](https://squidfunk.github.io/mkdocs-material/) and wiki style markdown cross-links.
 
+## Editing
 To preview the webpage install requirements in a virtualenv and run `mkdocs serve`.
 
+Wiki links work locally given something like the [marksman markdown language server](https://github.com/artempyanykh/marksman), or through [foam](https://foambubble.github.io/foam/) for vs code with the recommended extensions in this repo.
+
 ## Organisation
 
 The [mkdocs.yml](./mkdocs.yml) file's `nav` section dictates the structure of the webpage.

diff --git a/docs/index.md b/docs/index.md
@@ -2,8 +2,13 @@
 hide:
   - navigation
   - toc
+  #- path (insiders)
 ---
 
+<script>
+document.getElementsByTagName('h1')[0].remove(); // remove big Home - (hide: path is insiders)
+</script>
+
 <figure markdown>
 ![kube-rs logo](https://user-images.githubusercontent.com/639336/155115602-cb5f4c64-24a3-4921-b5e9-0e4d5a656c6b.svg#only-dark){ width="600px" } ![kube-rs logo](https://user-images.githubusercontent.com/639336/155115130-758a8ba9-e209-42de-bf6d-cde7be3ed86f.svg#only-light){ width="600px" }
 </figure>
@@ -14,6 +19,28 @@ These crates build upon Kubernetes [apimachinery](https://github.com/kubernetes/
 
 <!-- TODO: use an overrides page for home https://github.com/squidfunk/mkdocs-material/blob/9655c3a92471f261533d48b8611a8d24dbfebb13/src/overrides/home.html via https://github.com/squidfunk/mkdocs-material/blob/master/docs/index.md -->
 
-[:fontawesome-solid-book: Getting Started](getting-started){ .md-button align=left } [:fontawesome-brands-discord: Community](https://discord.gg/tokio){ .md-button align=left } [:material-language-rust: Crates](https://crates.io/crates/kube){ .md-button align=left } [:material-github: Github](https://github.com/kube-rs){ .md-button align=left }
+
+[:fontawesome-solid-book: Getting Started](getting-started){ .md-button align=left } [:fontawesome-brands-github-alt: Q&A](https://github.com/kube-rs/kube/discussions){ .md-button align=left } [:material-language-rust: Crates](https://crates.io/crates/kube){ .md-button align=left } [:material-github: Github](https://github.com/kube-rs){ .md-button align=left }  [:fontawesome-brands-discord: Community](https://discord.gg/tokio){ .md-button align=left }
+
+<style>
+  p:has(a.md-button) {
+    display: flex;
+    flex-wrap: wrap;
+    justify-content: center;
+  }
+  p > a.md-button {
+    text-align: center;
+    justify-content: center;
+    align-items: center;
+    margin: 3px;
+    flex-grow: 0;
+    flex-shrink: 0;
+  }
+  p > a.md-button:hover {
+    background: #114;
+    color: #ddd;
+    text-decoration: none;
+  }
+</style>
 
 <!-- adopters here? -->
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -7,7 +7,7 @@ repo_url: https://github.com/kube-rs/kube
 repo_name: kube
 # NB: edit uri won't work well with sync system if we don't have canonical docs in the same repo as the site
 #edit_uri: edit/main/docs
-edit_uri: ''
+edit_uri: 'https://github.com/kube-rs/website/edit/main/docs'
 theme:
   icon:
     repo: fontawesome/brands/github
@@ -39,6 +39,8 @@ theme:
     - navigation.sections
     - navigation.instant
     - navigation.tracking
+    - navigation.prune
+    - content.action.edit
 
 # NB: Maintaining the nav list is not necessary, but is needed to reorder.
 # Generated from "fd .md ." in docs/ folder.
@@ -60,19 +62,21 @@ nav:
   - upgrading.md
 
 - Controllers:
-  - controllers/intro.md
-  - controllers/object.md
-  - controllers/reconciler.md
-  - controllers/application.md
-  - controllers/observability.md
-  - controllers/relations.md
-  - controllers/gc.md
-  - controllers/schemas.md
-  - controllers/optimization.md
-  - controllers/streams.md
-  - controllers/testing.md
-  - controllers/security.md
-  - controllers/internals.md
+    Concepts:
+    - controllers/intro.md
+    - controllers/object.md
+    - controllers/reconciler.md
+    - controllers/application.md
+    - controllers/relations.md
+    - controllers/gc.md
+    - controllers/schemas.md
+    Advanced:
+    - controllers/testing.md
+    - controllers/observability.md
+    - controllers/optimization.md
+    - controllers/security.md
+    - controllers/streams.md
+    - controllers/internals.md
 
   #- comunity.md
   #- proposal-process.md