From ce6f4292d596b2ebe27df54b64d0c786927b095a Mon Sep 17 00:00:00 2001 From: Vaibhav Goel <79974025+vaibhav2107@users.noreply.github.com> Date: Wed, 25 Aug 2021 13:02:39 +0530 Subject: [PATCH 1/4] Fix the typo in deployment-and-usage.md (#575) * Fix the typo in deployment-and-usage.md * Update in doc/get-started/deployment-and-usage.md (cherry picked from commit 87feb9610b900cd85a47d165c656c3224d47df7b) --- docs/get-started/deployment-and-usage.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/get-started/deployment-and-usage.md b/docs/get-started/deployment-and-usage.md index f46551159..1585a600f 100644 --- a/docs/get-started/deployment-and-usage.md +++ b/docs/get-started/deployment-and-usage.md @@ -285,7 +285,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 From a6910ff700b622ccc2e5434b0b4b7fb78bac37e4 Mon Sep 17 00:00:00 2001 From: Vaibhav Date: Wed, 1 Sep 2021 22:41:04 +0530 Subject: [PATCH 2/4] Fix a link in deployment-and-usage.md (cherry picked from commit ac720ef57a8e5b082b78be8120a7781ea0d1f070) --- docs/get-started/deployment-and-usage.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/get-started/deployment-and-usage.md b/docs/get-started/deployment-and-usage.md index 1585a600f..ebbb70e69 100644 --- a/docs/get-started/deployment-and-usage.md +++ b/docs/get-started/deployment-and-usage.md @@ -212,7 +212,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 | From 590d68d92de34b88d5afbabb8801f2871d77a7d6 Mon Sep 17 00:00:00 2001 From: krishna2603 <90986377+krishna2603@users.noreply.github.com> Date: Wed, 29 Sep 2021 23:58:27 +0530 Subject: [PATCH 3/4] Update developer-guide.md changed exapmle to example (cherry picked from commit dbb99c6f18c210218c8e844290f11e7ddf7149e1) --- docs/advanced/developer-guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/advanced/developer-guide.md b/docs/advanced/developer-guide.md index e028c6be7..63a441181 100644 --- a/docs/advanced/developer-guide.md +++ b/docs/advanced/developer-guide.md @@ -284,4 +284,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 From a01ad31f1443fe18536555f56885c733aa3aa047 Mon Sep 17 00:00:00 2001 From: Markus Lehtonen Date: Mon, 27 Sep 2021 15:31:49 +0300 Subject: [PATCH 4/4] docs: fix TOCs Make table of contents in the pages cleaner and more readable by dropping the main heading (H1 level) from TOCs. This was the original intention with the usage of "no_toc" kramdown magic, which was broken, however. The kramdown class magic needs to be specified on the line immediately following the headinds, otherwise it has no effect. We need to disable MD022 rule of mdlint as it does not understand this magic. (cherry picked from commit 819f333118258698a8a59a80a0ac975325138fe6) --- docs/advanced/architecture.md | 6 ++---- docs/advanced/customization-guide.md | 6 ++---- docs/advanced/developer-guide.md | 6 ++---- docs/advanced/e2e-configuration-reference.md | 6 ++---- docs/advanced/master-commandline-reference.md | 6 ++---- docs/advanced/worker-commandline-reference.md | 6 ++---- docs/advanced/worker-configuration-reference.md | 6 ++---- docs/get-started/deployment-and-usage.md | 6 ++---- docs/get-started/examples-and-demos.md | 6 ++---- docs/get-started/features.md | 6 ++---- docs/get-started/introduction.md | 6 ++---- docs/mdl-style.rb | 3 +++ 12 files changed, 25 insertions(+), 44 deletions(-) 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 63a441181..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} 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 ebbb70e69..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} 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