Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 2 additions & 1 deletion .learn_environment/ingest-requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,5 @@ gitpython
mergedeep
pandas
numpy
retrypy
retrypy
pyyaml
25 changes: 21 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,16 +90,33 @@ The ingest script is a python script and has its dependencies (separate from the
pip install -r .learn_environment/ingest-requirements.txt
```

6. The organization of the files is handled by the [`map.csv` file](https://github.com/netdata/netdata/blob/master/docs/.map/map.csv), that contains metadata for every file. That file should only be edited by members of the Netdata team.
6. The organization of the files is handled by the [`map.yaml` file](https://github.com/netdata/netdata/blob/master/docs/.map/map.yaml), that contains metadata for every file. That file should only be edited by members of the Netdata team.

7. Run the ingest process to fetch the documents you are working on from one or multiple repos.

```bash
python ingest/ingest.py --repos <owner>/<repo>:<branch>
```

for example, let's assume that you made some changes in the markdown files of `netdata/netdata` repo (branch: patch1)
and on your own fork `user1/go.d.plugin` repo (branch: user1-patch).
You can also use local paths instead of GitHub repos:

```bash
python ingest/ingest.py --repos /path/to/local/netdata
```

Or specify the repo name explicitly for a local path:

```bash
python ingest/ingest.py --repos netdata:/path/to/local/netdata
```

Examples combining GitHub and local paths:

```bash
python ingest/ingest.py --repos netdata/netdata:patch1 /path/to/local/go.d.plugin
```

Or if you have your own fork:

```bash
python ingest/ingest.py --repos netdata/netdata:patch1 user1/go.d.plugin:user1-patch
Expand Down Expand Up @@ -148,7 +165,7 @@ This action runs at 14:00 UTC every day.
If there are changes to any documentation file, the GitHub Action creates a PR that is then reviewed by a member of the Netdata team.

The action can be configured to automatically assign one or more reviewers.
To enable automatic assignments, uncomment the `# reviewers:` line at the end of [`ingest.yml`](.github/ingest.yml) and add the appropriate GitHub username(s)either space or comma-separated.
To enable automatic assignments, uncomment the `# reviewers:` line at the end of [`ingest.yml`](/.github/workflows/ingest.yml) and add the appropriate GitHub username(s)either space or comma-separated.
Copy link

Copilot AI Feb 2, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missing space after parenthesis: "username(s)either" should be "username(s) either" with a space between the closing parenthesis and "either".

Suggested change
To enable automatic assignments, uncomment the `# reviewers:` line at the end of [`ingest.yml`](/.github/workflows/ingest.yml) and add the appropriate GitHub username(s)either space or comma-separated.
To enable automatic assignments, uncomment the `# reviewers:` line at the end of [`ingest.yml`](/.github/workflows/ingest.yml) and add the appropriate GitHub username(s) either space or comma-separated.

Copilot uses AI. Check for mistakes.

## Update news on the Learn homepage

Expand Down
5 changes: 4 additions & 1 deletion ingest/autogenerateRedirects.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
import git
import json
import ast
import yaml
import autogenerateSupportedIntegrationsPage as genIntPage
import pandas as pd
import numpy as np
Expand Down Expand Up @@ -125,7 +126,9 @@ def addMovedRedirects(mapping):
# Reads one_commit_back, that is how the map was before these changes,
# and has the current mapping from the mapping variable.

one_commit_back = pd.read_csv("./ingest/one_commit_back_file-dict.tsv", sep='\t').set_index('custom_edit_url').T.to_dict('dict')
with open("./ingest/one_commit_back_file-dict.yaml", "r", encoding="utf-8") as fh:
redirect_list = yaml.safe_load(fh) or []
one_commit_back = {item['custom_edit_url']: item for item in redirect_list}

redirects = {}

Expand Down
831 changes: 0 additions & 831 deletions ingest/generated_map.tsv

This file was deleted.

Loading