Fix missing nav bar (#179)

## Description


Update local development to use similar versions that Netlify uses. This helps with troubleshooting/reproducing issues found in Netlify. It appears that some time in August of 2023 that Netlify updated versions of mkdocs and the material theme. This broken our nav override. I was able to fix the nav by copying from: https://github.com/squidfunk/mkdocs-material/blob/master/src/templates/partials/nav.html I don't know that much about HTML or mkdocs so i dont know if this is the proper way to fix this, but it is rendering properly in the Netlify previews.

## Why is this needed



Fixes: #

## How Has This Been Tested?





## How are existing users impacted? What migration steps/scripts do we need?





## Checklist:

I have:

- [ ] updated the documentation and/or roadmap (if required)
- [ ] added unit or e2e tests
- [ ] provided instructions on how to upgrade

docs/actions/action-architecture.md

@@ -77,7 +77,7 @@ environment:
 
 With this understanding of the basic architecture of we can start to look at what would be required to [create your own action].
 
-[create your own action]: /actions/creating-a-basic-action
+[create your own action]: creating-a-basic-action.md
 [entrypoint]: https://docs.docker.com/engine/reference/builder/#entrypoint
 [kexec]: https://wiki.archlinux.org/title/Kexec
 [linux namespace]: https://en.wikipedia.org/wiki/Linux_namespaces

docs/architecture.md

@@ -45,5 +45,5 @@ There are some very basic requirements that a Worker machine must meet in order
 There are no Disk requirements for a Worker since OSIE runs an in-memory operating system.
 Your disk requirements will be determined by the OS you are going to install and other use-case considerations.
 
-[architecture]: /images/architecture-diagram.png
-[tinkerbell stack]: /#whats-powering-tinkerbell
+[architecture]: images/architecture-diagram.png
+[tinkerbell stack]: index.md#whats-powering-tinkerbell

docs/deploying-operating-systems/the-basics.md

@@ -113,7 +113,7 @@ Finally there is plenty of tooling to create your own root file systems, a good
 [1960s ibm manual]: https://web.archive.org/web/20140701185435/http://www.demorton.com/Tech/$OSTL.pdf
 [arch]: https://archive.archlinux.org/iso/
 [debian]: https://wiki.debian.org/Debootstrap
-[diagram of a disk layout]: /images/disk-layout.png
+[diagram of a disk layout]: ../images/disk-layout.png
 [livemedia-creator]: https://weldr.io/lorax/livemedia-creator.html
 [ubuntu]: http://cdimage.ubuntu.com/ubuntu-base/releases/20.04/release/
 [unattended installations]: https://en.wikipedia.org/wiki/Installation_(computer_programs)

docs/deploying-operating-systems/the-deployment.md

@@ -222,5 +222,5 @@ Once an Operating System image **or** a filesystem + bootloader is deployed we m
 [qcow]: https://en.wikipedia.org/wiki/Qcow
 [qemu-image]: https://en.wikibooks.org/wiki/QEMU/Images#Copying_an_image_to_a_physical_device
 [rootio]: https://artifacthub.io/packages/tbaction/tinkerbell-community/rootio
-[the basics of deploying an operating system]: /deploying-operating-systems/the-basics/#filesystem-archives
+[the basics of deploying an operating system]: the-basics.md/#filesystem-archives
 [ubuntu]: https://help.ubuntu.com/lts/installation-guide/amd64/apds04.html

docs/hook.md

@@ -29,10 +29,10 @@ Its responsibility is to execute workflow tasks.
 
 [alpine linux]: https://alpinelinux.org
 [linuxkit]: https://github.com/linuxkit/linuxkit
-[screenshot from the worker]: /images/vagrant-setup-vbox-worker.png
+[screenshot from the worker]: images/vagrant-setup-vbox-worker.png
 [tink]: https://github.com/tinkerbell/tink
-[tink-server]: /services/tink-server
-[tink-worker]: /services/tink-worker
-[workflow]: /workflows/working-with-workflows
+[tink-server]: services/tink-server.md
+[tink-worker]: services/tink-worker.md
+[workflow]: workflows/working-with-workflows.md
 [hook repository]: https://github.com/tinkerbell/hook
 [custom kernel]: https://github.com/tinkerbell/hook/tree/main/kernel

docs/index.md

@@ -49,15 +49,14 @@ Need a little help getting started? We're here!
   Look for the [#tinkerbell] channel.
 - Submit an issue on [Github].
 
-
-[boots]: /services/boots
-[pbnj]: /services/pbnj
-[hook]: /hook
-[hegel]: /services/hegel
-[rufio]: /services/rufio
-[tink server]: /services/tink-server
-[tink worker]: /services/tink-worker
-[tink controller]: /services/tink-controller
+[boots]: services/boots.md
+[pbnj]: services/pbnj.md
+[hook]: hook.md
+[hegel]: services/hegel.md
+[rufio]: services/rufio.md
+[tink server]: services/tink-server.md
+[tink worker]: services/tink-worker.md
+[tink controller]: services/tink-controller.md
 
 [cncf community slack]: https://slack.cncf.io/
 [contributors' page]: https://tinkerbell.org/community/contributors/

docs/services/boots.md

@@ -48,7 +48,7 @@ There are a lot of articles and use cases for netbooting, here a few that our co
 - [RedHat Enterprise Linux: PREPARING FOR A NETWORK INSTALLATION]
 
 [first journeys with netboot and ipxe installing ubuntu]: https://gianarb.it/blog/first-journeys-with-netboot-ipxe
-[hook]: /hook
+[hook]: ../hook.md
 [redhat enterprise linux: preparing for a network installation]: https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/7/html/installation_guide/chap-installation-server-setup
 [the state of netbooting raspberry pis]: https://blog.alexellis.io/the-state-of-netbooting-raspberry-pi/
 [tinkerbell/boots]: https://github.com/tinkerbell/boots

docs/services/hegel.md

@@ -62,6 +62,6 @@ Some examples are:
 [aws: instance metadata and user data]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html
 [equinix metal: metadata]: https://metal.equinix.com/developers/docs/servers/metadata/
 [gcp: storing and retrieving instance metadata]: https://cloud.google.com/compute/docs/metadata/overview
-[hook]: /hook
+[hook]: ../hook.md
 [tinkerbell/hegel]: https://github.com/tinkerbell/hegel
 [`hardware`]: https://github.com/tinkerbell/tink/blob/main/config/crd/bases/tinkerbell.org_hardware.yaml

docs/services/tink-server.md

@@ -11,6 +11,6 @@ Tink Server uses Kubernetes custom resources to store workflow state.
 Tink Server retrieves tasks from and updates task status' on [`Workflow`][workflow] Kubernetes custom resources. Tinkerbell users submit the [`Workflow`][workflow]s to the cluster via the Kube API Server.
 
 [tinkerbell/tink]: https://github.com/tinkerbell/tink/tree/main/cmd/tink-server
-[tink worker]: /services/tink-worker
+[tink worker]: tink-worker.md
 [workflow]: https://github.com/tinkerbell/tink/blob/main/pkg/apis/core/v1alpha1/workflow_types.go
 [template]: https://github.com/tinkerbell/tink/blob/main/pkg/apis/core/v1alpha1/template_types.go

docs/services/tink-worker.md

@@ -20,8 +20,8 @@ A small program called [hook-bootkit] is launched as a serivce, reads the Kernel
 See the [LinuxKit configuration file][hook-bootkit-service] and [documentation][linuxkit] for how [hook-bootkit] is launched.
 
 [tinkerbell/tink]: https://github.com/tinkerbell/tink/tree/main/cmd/tink-worker
-[hook]: /hook
-[tink server]: /services/tink-server
+[hook]: ../hook.md
+[tink server]: tink-server.md
 [hook-bootkit]: https://github.com/tinkerbell/hook/tree/main/hook-bootkit
 [hook-bootkit-service]: https://github.com/tinkerbell/hook/blob/main/hook.yaml#L53
 [linuxkit]: https://github.com/linuxkit/linuxkit

docs/templates.md

@@ -83,4 +83,4 @@ Templates are each stored as blobs in the database; they are later parsed during
 
 `tink template --help` - Displays the available commands and their usage for `tink template`.
 
-[action]: /actions/action-architecture
+[action]: actions/action-architecture.md

docs/workflows/hello-world-workflow.md

@@ -92,4 +92,4 @@ tink workflow events $ID
 
 If you reboot the Worker at this point, it will again PXE boot, since no alternate operating system was installed as part of the `hello-world` workflow.
 
-[minimal hardware data example]: /hardware-data/#the-minimal-hardware-data
+[minimal hardware data example]: ../hardware-data.md#the-minimal-hardware-data

docs/workflows/working-with-workflows.md

@@ -107,6 +107,6 @@ The other worker may retrieve and use this data and eventually add some more:
 
 You can get the ephemeral data associated with a workflow with the `tink workflow data` tink CLI command.
 
-[architecture]: /images/workflow-diagram.png
-[hardware data]: /hardware-data
-[template]: /templates
+[architecture]: ../images/workflow-diagram.png
+[hardware data]: ../hardware-data.md
+[template]: ../templates.md

mkdocs.yml

@@ -69,9 +69,9 @@ extra:
     - icon: fontawesome/brands/twitter
       link: https://twitter.com/tinkerbell_oss
 
-google_analytics:
-  - UA-52258647-10
-  - auto
+#google_analytics:
+#  - UA-52258647-10
+#  - auto
 
 plugins:
   - search

overrides/partials/nav.html

@@ -20,8 +20,11 @@
   <div class="md-nav__source">{% include "partials/source.html" %}</div>
   {% endif %}
   <!-- Render item list -->
+  {% import "partials/nav-item.html" as item with context %}
   <ul class="md-nav__list" data-md-scrollfix>
-    {% for nav_item in nav %} {% set path = "nav-" + loop.index | string %} {%
-    set level = 1 %} {% include "partials/nav-item.html" %} {% endfor %}
+    {% for nav_item in nav %}
+      {% set path = "__nav_" ~ loop.index %}
+      {{ item.render(nav_item, path, 1) }}
+    {% endfor %}
   </ul>
 </nav>