1
0
Fork 0
mirror of https://github.com/kubernetes-sigs/node-feature-discovery.git synced 2025-03-31 04:04:51 +00:00

docs: fix broken refs

This commit is contained in:
Markus Lehtonen 2020-11-02 10:48:17 +02:00
parent ef5239778d
commit 18ffd2a06d
4 changed files with 15 additions and 15 deletions

View file

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

View file

@ -103,7 +103,7 @@ node(s) will run extra job instance(s) to satisfy the request.
If you want to use the latest development version (master branch) you need to If you want to use the latest development version (master branch) you need to
build your own custom image. build your own custom image.
See the [Developer Guide](/advanced/developer-guide) for instructions how to See the [Developer Guide](../advanced/developer-guide) for instructions how to
build images and deploy them on your cluster. build images and deploy them on your cluster.
## Usage ## Usage
@ -219,10 +219,6 @@ file must be used, i.e. JSON (or YAML). For example:
Configuration options specified from the command line will override those read Configuration options specified from the command line will override those read
from the config file. 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 ## Using Node Labels
Nodes with specific features can be targeted using the `nodeSelector` field. The Nodes with specific features can be targeted using the `nodeSelector` field. The
@ -244,7 +240,7 @@ spec:
``` ```
For more details on targeting nodes, see For more details on targeting nodes, see
[node selection](https://kubernetes.io/docs/tasks/tools/install-kubectl). [node selection](https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/).
## Uninstallation ## Uninstallation

View file

@ -72,7 +72,7 @@ The (sub-)set of CPUID attributes to publish is configurable via the
If whitelist is specified, only whitelisted attributes will be published. With If whitelist is specified, only whitelisted attributes will be published. With
blacklist, only blacklisted attributes are filtered out. `attributeWhitelist` blacklist, only blacklisted attributes are filtered out. `attributeWhitelist`
has priority over `attributeBlacklist`. For examples and more information 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: By default, the following CPUID flags have been blacklisted:
BMI1, BMI2, CLMUL, CMOV, CX16, ERMS, F16C, HTT, LZCNT, MMX, MMXEXT, NX, POPCNT, 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. RDRAND, RDSEED, RDTSCP, SGX, SSE, SSE2, SSE3, SSE4.1, SSE4.2 and SSSE3.
@ -385,7 +385,8 @@ The **kernel** feature source supports the following labels:
Kernel config file to use, and, the set of config options to be detected are Kernel config file to use, and, the set of config options to be detected are
configurable. configurable.
See [configuration options](#configuration-options) for more information. See [configuration](deployment-and-usage#configuration) for
more information.
### Memory ### Memory
@ -445,7 +446,7 @@ example label using the default label fields:
feature.node.kubernetes.io/usb-fe_1a6e_089a.present=true feature.node.kubernetes.io/usb-fe_1a6e_089a.present=true
``` ```
See [configuration options](#configuration-options) for more information on NFD See [configuration](deployment-and-usage#configuration) for more information on NFD
config. config.
### Storage ### Storage

View file

@ -11,10 +11,10 @@ features and system configuration!
Continue to: Continue to:
- **[Introduction](get-started/introduction.md)** for more details on the - **[Introduction](introduction.md)** for more details on the
project. project.
- **[Quick start](get-started/quick-start.md)** for quick step-by-step - **[Quick start](quick-start.md)** for quick step-by-step
instructions on how to get NFD running on your cluster. instructions on how to get NFD running on your cluster.
## Quick-start -- the short-short version ## Quick-start -- the short-short version