Docs build cleanup (#6407)

* Fix misspell detected typos

* Fix missing newline at EOF

* Switch from 'git clone' to 'git worktree add' for higher speed

Author: evankanderson

.gitattributes

@@ -7,6 +7,8 @@
 *.ai binary
 *.pdf binary
 *.png binary
+# We are vendoring this fork of material-mkdocs typescript for now -- don't lint, etc.
+/overrides/assets/javascripts/bundle.*.min.js linguist-vendored
 
 # coverage-excluded is an attribute used to explicitly exclude a path from being
 # included in code coverage. If a path is marked as linguist-generated already,

docs/about/.nav.yml

@@ -8,4 +8,4 @@ nav:
       - Outfit7: about/case-studies/outfit7.md
       - Puppet: about/case-studies/puppet.md
       - PNC Bank: about/case-studies/pnc.md
-      - SVA: about/case-studies/sva.md
+      - SVA: about/case-studies/sva.md

docs/community/.nav.yml

@@ -2,4 +2,4 @@ nav:
   - Community:
     - How To Get Involved: community/README.md
     - Contribute to Knative: community/contributing.md
-    - Community Rules and Practices: community/governance.md
+    - Community Rules and Practices: community/governance.md

docs/versioned/reference/security/threat-model.md

@@ -146,7 +146,7 @@ Knative to handle HTTP requests when there is no current user pod available to
 handle the request. The activator works in concert with the autoscaler to manage
 the number of Pods for a particular Revision based on traffic routing decisions
 made by the ingress gateway. Not all incoming requests are handled by the
-activator -- when a particular revision has sufficent replicas to handle bursty
+activator -- when a particular revision has sufficient replicas to handle bursty
 traffic, the ingress gateway is programmed with the direct backend addresses of
 the application pods.
 
@@ -179,7 +179,7 @@ configuration of the application, and can presumably run arbitrary code and
 access all the resources which the application can.)
 
 Because not all components are involved in processing a request, we declare in
-each situation which Knative components may be targeted by an attacker to achive
+each situation which Knative components may be targeted by an attacker to achieve
 these goals. See [migitations](#threat-mitigations) for implemented defenses and
 additional cluster-specific configuration which may be considered.
 
@@ -272,7 +272,7 @@ traffic between application namespaces. Knative recommends one or more of the
 following technologies which can limit cross-namespace access:
 
 - [Knative Eventing EventPolicy](https://knative.dev/docs/eventing/features/authorization/#defining-an-eventpolicy)
-  in conjuction with
+  in conjunction with
   [Sender Identity](https://knative.dev/docs/eventing/features/sender-identity/).
 - Use of a service mesh, like Istio. This may require
   [specific configuration](https://knative.dev/docs/serving/istio-authorization/#before-you-begin)

docs/versioned/reference/security/verifying-cli.md

@@ -56,4 +56,4 @@ Authority=Apple Root CA
 Timestamp=3 Oct 2022 at 22:50:07
 ...
 TeamIdentifier=7R64489VHL
-```
+```

hack/build.sh

@@ -40,6 +40,12 @@ readonly TEMP="$(mktemp -d)"
 readonly SITE=$PWD/site
 rm -rf site/
 
+# If we're running on Netlify, update git branches
+if [ "$CI" == "true" ]; then
+  git fetch --prune origin
+fi
+
+
 mkdir "$TEMP/content"
 cp -r . "$TEMP/content/"
 
@@ -64,8 +70,8 @@ if [ "$BUILD_VERSIONS" != "no" ]; then
   sed -i 's| versioned/| development/|g' "$TEMP/content/config/redirects.yml"
 
   # Handle current release specially, as we don't include a version slug
-  # TODO: can we make one clone and reuse it, possibly with git worktrees?
-  git clone --depth 1 -b "${DOCS_BRANCHES[0]}" "https://github.com/${GIT_SLUG}" "$TEMP/current-release"
+  # Note that git worktree reuses the same git clone, so we don't need to clone 50+MB each time.
+  git worktree add --detach "$TEMP/current-release" "origin/${DOCS_BRANCHES[0]}"
   if [ -d "$TEMP/current-release/docs/versioned" ]; then
     cp -r "$TEMP/current-release/docs/versioned" "$TEMP/content/docs/docs"
     echo -e "\ndoc_base: /docs/versioned/" >> "$TEMP/content/docs/docs/.meta.yml"
@@ -99,7 +105,7 @@ if [ "$BUILD_VERSIONS" != "no" ]; then
     version=${previous[$i]}
 
     echo "Building for previous version $version"
-    git clone --depth 1 -b ${DOCS_BRANCHES[$i+1]} https://github.com/${GIT_SLUG} "$TEMP/docs-$version"
+    git worktree add --detach "$TEMP/docs-$version" "origin/${DOCS_BRANCHES[i+1]}"
     if [ -d "$TEMP/docs-$version/docs/versioned" ]; then
       cp -r "$TEMP/docs-$version/docs/versioned" "$TEMP/content/docs/v$version-docs"
       echo -e "\ndoc_base: /docs/versioned/" >> "$TEMP/content/docs/v$version-docs/.meta.yml"
@@ -159,6 +165,7 @@ cat golang/_redirects >> site/_redirects
 
 # Clean up
 # rm -rf $TEMP
+# git worktree prune
 echo "Temp dir was: $TEMP"
 
 if [ "$1" = "serve" ]; then

overrides/main.html

@@ -68,4 +68,4 @@ <h1>⚠ You are viewing an archived snapshot of the documentation for Knative ve
       "version": _.version or none
     } | tojson -}}
   </script>
-{% endblock %}
+{% endblock %}

overrides/partials/nav.html

@@ -75,4 +75,4 @@
       {{ item.render(nav_item, path, 1) }}
     {% endfor %}
   </ul>
-</nav>
+</nav>

requirements.txt

@@ -6,4 +6,4 @@ mkdocs-git-revision-date-localized-plugin>=1.2
 mkdocs-redirects>=1.0.3
 mkdocs-rss-plugin>=0.18.0
 pygithub==1.55
-semver==2.13.0
+semver==2.13.0