diff --git a/docs/advanced/architecture.md b/docs/advanced/architecture.md index ea25bbc97..194b13c20 100644 --- a/docs/advanced/architecture.md +++ b/docs/advanced/architecture.md @@ -6,12 +6,10 @@ published: false --- # Architecture - -{: .no_toc } +{: .no_toc} ## Table of contents - -{: .no_toc .text-delta } +{: .no_toc .text-delta} 1. TOC {:toc} diff --git a/docs/advanced/customization-guide.md b/docs/advanced/customization-guide.md index 59a88b3ee..f8a8a824f 100644 --- a/docs/advanced/customization-guide.md +++ b/docs/advanced/customization-guide.md @@ -6,12 +6,10 @@ published: false --- # Customization guide - -{: .no_toc } +{: .no_toc} ## Table of contents - -{: .no_toc .text-delta } +{: .no_toc .text-delta} 1. TOC {:toc} diff --git a/docs/advanced/developer-guide.md b/docs/advanced/developer-guide.md index e028c6be7..38d36c9d0 100644 --- a/docs/advanced/developer-guide.md +++ b/docs/advanced/developer-guide.md @@ -5,12 +5,10 @@ sort: 1 --- # Developer guide - -{: .no_toc } +{: .no_toc} ## Table of contents - -{: .no_toc .text-delta } +{: .no_toc .text-delta} 1. TOC {:toc} @@ -284,4 +282,4 @@ make site-build This will generate html documentation under `docs/_site/`. -[e2e-config-sample]: https://github.com/kubernetes-sigs/node-feature-discovery/blob/{{site.release}}/test/e2e/e2e-test-config.exapmle.yaml +[e2e-config-sample]: https://github.com/kubernetes-sigs/node-feature-discovery/blob/{{site.release}}/test/e2e/e2e-test-config.example.yaml diff --git a/docs/advanced/e2e-configuration-reference.md b/docs/advanced/e2e-configuration-reference.md index c7a858ad2..0244b6c45 100644 --- a/docs/advanced/e2e-configuration-reference.md +++ b/docs/advanced/e2e-configuration-reference.md @@ -6,12 +6,10 @@ published: false --- # Configuration file reference of end-to-end tests - -{: .no_toc } +{: .no_toc} ## Table of contents - -{: .no_toc .text-delta } +{: .no_toc .text-delta} 1. TOC {:toc} diff --git a/docs/advanced/master-commandline-reference.md b/docs/advanced/master-commandline-reference.md index a1aa8e876..c30cb2bb3 100644 --- a/docs/advanced/master-commandline-reference.md +++ b/docs/advanced/master-commandline-reference.md @@ -5,12 +5,10 @@ sort: 2 --- # Commandline flags of nfd-master - -{: .no_toc } +{: .no_toc} ## Table of contents - -{: .no_toc .text-delta } +{: .no_toc .text-delta} 1. TOC {:toc} diff --git a/docs/advanced/worker-commandline-reference.md b/docs/advanced/worker-commandline-reference.md index aac784e9a..1d60d4293 100644 --- a/docs/advanced/worker-commandline-reference.md +++ b/docs/advanced/worker-commandline-reference.md @@ -5,12 +5,10 @@ sort: 3 --- # Commandline flags of nfd-worker - -{: .no_toc } +{: .no_toc} ## Table of contents - -{: .no_toc .text-delta } +{: .no_toc .text-delta} 1. TOC {:toc} diff --git a/docs/advanced/worker-configuration-reference.md b/docs/advanced/worker-configuration-reference.md index 5df339e67..aa8daa52e 100644 --- a/docs/advanced/worker-configuration-reference.md +++ b/docs/advanced/worker-configuration-reference.md @@ -5,12 +5,10 @@ sort: 4 --- # Configuration file reference of nfd-worker - -{: .no_toc } +{: .no_toc} ## Table of contents - -{: .no_toc .text-delta } +{: .no_toc .text-delta} ***WORK IN PROGRESS.*** diff --git a/docs/get-started/deployment-and-usage.md b/docs/get-started/deployment-and-usage.md index f46551159..aa947c86d 100644 --- a/docs/get-started/deployment-and-usage.md +++ b/docs/get-started/deployment-and-usage.md @@ -5,12 +5,10 @@ sort: 3 --- # Deployment and usage - -{: .no_toc } +{: .no_toc} ## Table of contents - -{: .no_toc .text-delta } +{: .no_toc .text-delta} 1. TOC {:toc} @@ -212,7 +210,7 @@ We have introduced the following Chart parameters. | `image.repository` | string | `{{ site.container_image | split: ":" | first }}` | NFD image repository | | `image.tag` | string | `{{ site.release }}` | NFD image tag | | `image.pullPolicy` | string | `Always` | Image pull policy | -| `imagePullSecrets` | list | [] | ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec. If specified, these secrets will be passed to individual puller implementations for them to use. For example, in the case of docker, only DockerConfig type secrets are honored. [https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod](More info) | +| `imagePullSecrets` | list | [] | ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec. If specified, these secrets will be passed to individual puller implementations for them to use. For example, in the case of docker, only DockerConfig type secrets are honored. [More info](https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod) | | `serviceAccount.create` | bool | true | Specifies whether a service account should be created | | `serviceAccount.annotations` | dict | {} | Annotations to add to the service account | | `serviceAccount.name` | string | | The name of the service account to use. If not set and create is true, a name is generated using the fullname template | @@ -285,7 +283,7 @@ labels. The provided template will configure these for you. NFD-Worker is preferably run as a Kubernetes DaemonSet. This assures re-labeling on regular intervals capturing changes in the system configuration -and mames sure that new nodes are labeled as they are added to the cluster. +and makes sure that new nodes are labeled as they are added to the cluster. Worker connects to the nfd-master service to advertise hardware features. When run as a daemonset, nodes are re-labeled at an interval specified using diff --git a/docs/get-started/examples-and-demos.md b/docs/get-started/examples-and-demos.md index 3826f8cb6..c1e8e75f0 100644 --- a/docs/get-started/examples-and-demos.md +++ b/docs/get-started/examples-and-demos.md @@ -5,12 +5,10 @@ sort: 5 --- # Examples and demos - -{: .no_toc } +{: .no_toc} ## Table of contents - -{: .no_toc .text-delta } +{: .no_toc .text-delta} 1. TOC {:toc} diff --git a/docs/get-started/features.md b/docs/get-started/features.md index 038e9e2aa..b0bf14197 100644 --- a/docs/get-started/features.md +++ b/docs/get-started/features.md @@ -5,12 +5,10 @@ sort: 4 --- # Feature discovery - -{: .no_toc } +{: .no_toc} ## Table of contents - -{: .no_toc .text-delta } +{: .no_toc .text-delta} 1. TOC {:toc} diff --git a/docs/get-started/introduction.md b/docs/get-started/introduction.md index edbe086dc..a3bde7ab6 100644 --- a/docs/get-started/introduction.md +++ b/docs/get-started/introduction.md @@ -5,12 +5,10 @@ sort: 1 --- # Introduction - -{: .no_toc } +{: .no_toc} ## Table of contents - -{: .no_toc .text-delta } +{: .no_toc .text-delta} 1. TOC {:toc} diff --git a/docs/mdl-style.rb b/docs/mdl-style.rb index 29ff31410..11d47d3a8 100644 --- a/docs/mdl-style.rb +++ b/docs/mdl-style.rb @@ -1,4 +1,7 @@ all +# Exclude MD022 - Headers should be surrounded by blank lines. The kramdown +# "class magic" (like {: .no_toc}) needs to be directly below the heading line. +exclude_rule 'MD022' # Exclude MD041 - First line in file should be a top level header exclude_rule 'MD041' rule 'MD013', :tables => false