Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix building of docs #75

Merged
merged 2 commits into from
Jun 21, 2023
Merged

Fix building of docs #75

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a441b00
docs: fix building of docs
marquiz Jun 21, 2023
f7a2def
github/workflows: add verification of building docs
marquiz Jun 21, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions .github/workflows/project-checks.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,3 +37,19 @@ jobs:
run: |
make verify
working-directory: src/github.com/containerd/nri-plugin-collection

- name: Build docs
run: |
make site-build
make clean-html

- name: Install gh-pages build dependencies
run: |
pip3 install --user -r docs/requirements.txt
echo "`python3 -m site --user-base`/bin" >> $GITHUB_PATH

- name: Verify update of gh-pages
run: |
git config user.name "Github"
git config user.email "[email protected]"
./scripts/build/update-gh-pages.sh
2 changes: 1 addition & 1 deletion docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -224,7 +224,7 @@ def fixLocalMDAnchors(app, doctree, docname):
for node in doctree.traverse(nodes.reference):
uri = node.get('refuri')

if isHTTPLink(uri):
if uri == None or isHTTPLink(uri):
continue

filePath = normalizePath(docname,uri)
Expand Down
15 changes: 10 additions & 5 deletions docs/resource-policy/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ here can be applied to any other plugin hosted in this repository, regardless of

Currently, there are two installation methods available.

1. [Helm](#Helm)
2. [Manual](#Manual)
1. [Helm](#installing-the-helm-chart)
2. [Manual](#manual-installation)

Regardless of the chosen installation method, the NRI plugin installation includes the
following components: DaemonSet, ConfigMap, CustomResourceDefinition, and RBAC-related objects.
Expand Down Expand Up @@ -37,15 +37,20 @@ following components: DaemonSet, ConfigMap, CustomResourceDefinition, and RBAC-r
cd nri-plugins
```

1. Install the plugin using Helm. Replace release name with the desired name for your Helm release. In this example, we named it as topology-aware. The default values for topology-aware resource policy plugin are stored in [values.yaml](TODO) file. If you wish to provide custom values to the Helm chart, refer to the [table](#Helm-parameters) below, which describes the available parameters that can be modified before installation.
1. Install the plugin using Helm. Replace release name with the desired name
for your Helm release. In this example, we named it as topology-aware. The
default values for topology-aware resource policy plugin are stored in
values.yaml file. If you wish to provide custom values to the Helm
chart, refer to the [table](#helm-parameters) below, which describes the
available parameters that can be modified before installation.

```sh
helm install topology-aware deployment/helm/resource-management-policies/topology-aware/
```

1. Verify the status of the daemonset to ensure that the plugin is running successfully

```terminal
```bash
kubectl get daemonset -n kube-system nri-resource-policy

NAME DESIRED CURRENT READY UP-TO-DATE AVAILABLE NODE SELECTOR AGE
Expand Down Expand Up @@ -120,7 +125,7 @@ For the manual installation we will be using templating tool to generate Kuberne

1. Verify the status of the DaemonSet to ensure that the plugin is running successfully

```terminal
```bash
kubectl get daemonset -n kube-system nri-resource-policy

NAME DESIRED CURRENT READY UP-TO-DATE AVAILABLE NODE SELECTOR AGE
Expand Down