mirrors/node-feature-discovery
mirrors/node-feature-discovery
1
0
Fork 0
mirror of https://github.com/kubernetes-sigs/node-feature-discovery.git synced 2025-03-05 08:17:04 +00:00
Code Activity

docs: fix broken refs

Browse source
This commit is contained in:
Markus Lehtonen 2020-11-02 14:26:00 +02:00
parent 477eb2ed7b
commit 18691ab658
4 changed files with 16 additions and 18 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
docs/advanced/index.md
View file

@ -66,7 +66,7 @@ name of the resulting container image.
| IMAGE_EXTRA_TAG_NAMES | Additional container image tag(s) to create when building image | *empty*
| K8S_NAMESPACE | nfd-master and nfd-worker namespace | kube-system
| KUBECONFIG | Kubeconfig for running e2e-tests | *empty*
| E2E_TEST_CONFIG | Parameterization file of e2e-tests (see [example](test/e2e/e2e-test-config.exapmle.yaml)) | *empty*
| E2E_TEST_CONFIG | Parameterization file of e2e-tests (see [example][e2e-config-sample]) | *empty*
For example, to use a custom registry:
@ -239,9 +239,10 @@ for up-to-date information about the required volume mounts.
## Documentation
All documentation resides under the [docs](/docs) directory in the source tree.
It is designed to be served as a html site by [GitHub
Pages](https://pages.github.com/).
All documentation resides under the
[docs](https://github.com/kubernetes-sigs/node-feature-discovery/tree/release-0.6/docs)
directory in the source tree. It is designed to be served as a html site by
[GitHub Pages](https://pages.github.com/).
Building the documentation is containerized in order to fix the build
environment. The recommended way for developing documentation is to run:
@ -264,3 +265,5 @@ make site-build
This will generate html documentation under `docs/_site/`.
<!-- Links -->
[e2e-config-sample]: https://github.com/kubernetes-sigs/node-feature-discovery/blob/release-0.6/test/e2e/e2e-test-config.exapmle.yaml

6
docs/contributing/index.md
View file

@ -22,10 +22,8 @@ You can reach us via the following channels:
This is a [SIG-node](https://github.com/kubernetes/community/blob/master/sig-node/README.md)
subproject, hosted under the
[Kubernetes SIGs](https://github.com/kubernetes-sigs) organization in
Github. The project was established in 2016 as a
[Kubernetes Incubator](https://github.com/kubernetes/community/blob/master/incubator.md)
project and migrated to Kubernetes SIGs in 2018.
[Kubernetes SIGs](https://github.com/kubernetes-sigs) organization in Github.
The project was established in 2016 and was migrated to Kubernetes SIGs in 2018.
## License

8
docs/get-started/deployment-and-usage.md
View file

@ -199,11 +199,6 @@ file must be used, i.e. JSON (or YAML). For example:
Configuration options specified from the command line will override those read
from the config file.
Currently, the only available configuration options are related to the
[CPU](#cpu-features), [PCI](#pci-features) and [Kernel](#kernel-features)
feature sources.
## Using Node Labels
Nodes with specific features can be targeted using the `nodeSelector` field. The
@ -224,7 +219,8 @@ spec:
feature.node.kubernetes.io/cpu-pstate.turbo: 'true'
```
For more details on targeting nodes, see [node selection][node-sel].
For more details on targeting nodes, see
[node selection](https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/).
<!-- Links -->
[docker-down]: https://docs.docker.com/install

9
docs/get-started/features.md
View file

@ -67,7 +67,7 @@ The (sub-)set of CPUID attributes to publish is configurable via the
If whitelist is specified, only whitelisted attributes will be published. With
blacklist, only blacklisted attributes are filtered out. `attributeWhitelist`
has priority over `attributeBlacklist`. For examples and more information
about configurability, see [Configuration Options](#configuration-options).
about configurability, see [configuration](deployment-and-usage#configuration).
By default, the following CPUID flags have been blacklisted:
BMI1, BMI2, CLMUL, CMOV, CX16, ERMS, F16C, HTT, LZCNT, MMX, MMXEXT, NX, POPCNT,
RDRAND, RDSEED, RDTSCP, SGX, SSE, SSE2, SSE3, SSE4.1, SSE4.2 and SSSE3.
@ -316,7 +316,8 @@ labels by defining them in the `nfd-worker` configuration file.
Kernel config file to use, and, the set of config options to be detected are
configurable.
See [configuration options](#configuration-options) for more information.
See [configuration](deployment-and-usage#configuration) for
more information.
### Memory Features
@ -370,8 +371,8 @@ label fields:
feature.node.kubernetes.io/usb-fe_1a6e_089a.present=true
```
See [configuration options](#configuration-options)
for more information on NFD config.
See [configuration](deployment-and-usage#configuration) for more
information on NFD config.
### Storage Features