Skip to content

Commit 750d7f6

Browse files
author
root
committed
chore(docs): fix mkdocs image paths; tidy install-testpoint fences; add scripts README and tests
1 parent 958caad commit 750d7f6

File tree

2 files changed

+9
-11
lines changed

2 files changed

+9
-11
lines changed

docs/perfsonar/install-testpoint.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -289,7 +289,6 @@ If you want the container to use a specific NIC, adjust the docker-compose.syste
289289
290290
## 6. Confirm Operation
291291
292-
293292
Check containers:
294293
295294
```bash
@@ -314,9 +313,9 @@ Test connectivity between testpoints.
314313
315314
To register your testpoint with a central config:
316315
317-
```
318-
319-
podman exec -it perfsonar-testpoint psconfig remote list podman exec -it perfsonar-testpoint psconfig remote
316+
```bash
317+
podman exec -it perfsonar-testpoint psconfig remote list
318+
podman exec -it perfsonar-testpoint psconfig remote --configure-archives add "https://psconfig.opensciencegrid.org/pub/auto/psb02-gva.cern.ch"
320319
--configure-archives add "<https://psconfig.opensciencegrid.org/pub/auto/psb02-gva.cern.ch>"
321320
322321
```bash

scripts/README.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22

33
This folder contains a set of small helper scripts used to normalize and automatically fix common Markdown errors across the repository. The scripts are intentionally conservative and are safe to run locally. They do not change the semantic content of fenced code blocks (e.g. commands and code examples).
44

5-
Usage examples
6-
--------------
5+
## Usage examples
6+
77
- Add heuristic languages to unlabeled fences in a docs tree:
88

99
```bash
@@ -28,8 +28,8 @@ python3 scripts/apply_markdownlint_fixes.py tmp/markdownlint_install-testpoint_p
2828
python3 scripts/fix_md040_from_json.py tmp/markdownlint_repo.json
2929
```
3030

31-
Testing
32-
-------
31+
## Testing
32+
3333
Simple smoke tests exist under `scripts/tests` to demonstrate how to run the scripts safely on fixtures. The smoke tests do not touch the repository's `docs` directory; they operate on a temporary fixtures copy.
3434

3535
Run the smoke tests:
@@ -38,11 +38,10 @@ Run the smoke tests:
3838
bash scripts/tests/run_tests.sh
3939
```
4040

41-
Notes and tips
42-
--------------
41+
## Notes and tips
42+
4343
- Use VENV when running these tools locally; they are Python scripts and assume a typical Linux environment.
4444
- The scripts aim to be conservative: if in doubt they default to adding `text` as a neutral fenced-code language label to avoid changing semantics.
4545
- If a script acts on files you do not want to change, run it against a single file or a fixtures directory first and use `git diff` to review changes.
4646

4747
If you need help adding additional heuristics or tests, submit an issue or open a PR describing the desired behavior.
48-

0 commit comments

Comments
 (0)