From 5141afa3b0f8bac31cdb04dbbdc14470f9d1c7bd Mon Sep 17 00:00:00 2001 From: Claire Stirdivant <64609897+cstirdivant@users.noreply.github.com> Date: Fri, 16 Feb 2024 08:51:45 -0800 Subject: [PATCH 1/2] Update README.md Updating the original ontology path to point to the correct level of the directory --- tools/validators/ontology_validator/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/tools/validators/ontology_validator/README.md b/tools/validators/ontology_validator/README.md index 765d0dfbe..cff6ef66c 100644 --- a/tools/validators/ontology_validator/README.md +++ b/tools/validators/ontology_validator/README.md @@ -45,11 +45,11 @@ The validator is Python-based and takes the following parameters: * `--modified-ontology-types` or `-m` **[Optional]**: An absolute or relative path to the modified files of the ontology. * `--interactive` or `-i` **[Optional]**: Enables interactive mode. -The validator can be run as follows: `python3 validator.py -o=Users/foo/ontology/` or `python3 validator.py --original=Users/foo/ontology/` +The validator can be run as follows: `python3 validator.py -o=Users/foo/ontology/yaml/resources` or `python3 validator.py --original=Users/foo/ontology/yaml/resources` ### Ontology Types Extended -If you have extended the ontology by adding new types to your local ontology, run the following: `python3 validator.py --original=Users/foo/ontology/ --modified-ontology-types=path/to/modified/ontology/types/folder` +If you have extended the ontology by adding new types to your local ontology, run the following: `python3 validator.py --original=Users/foo/ontology/yaml/resources --modified-ontology-types=path/to/modified/ontology/types/folder` When using a modified ontology, ensure you follow the folder-naming convention: `digitalbuildings/ontology/yaml`. From 46223b94a90e6592ca9d19c81d248e083b0c9871 Mon Sep 17 00:00:00 2001 From: Claire Stirdivant <64609897+cstirdivant@users.noreply.github.com> Date: Fri, 16 Feb 2024 09:00:38 -0800 Subject: [PATCH 2/2] Update README.md Fix number indentation --- tools/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/tools/README.md b/tools/README.md index 7e266861a..f87b27da3 100644 --- a/tools/README.md +++ b/tools/README.md @@ -104,9 +104,9 @@ Run `python toolkit.py` and provide the following arguments: * `--timeout` or `-t` **[Optional]**: The timeout duration in seconds for the telemetry validation test. The default value is 600 seconds, or 10 minutes. If this time limit is exceeded before the validator receives a test pubsub message for each of the entities configured in the given instance config file, the test will fail with an error and report the entities that were not heard from. -6`--report-directory` or `-d` **[Optional]**: Writes instance validation(instance_validation_report.txt) and telemetry validation (telemetry_validation_report.json) reports to the specified `report-directory`. By default, writes instance validation output to the console and telemetry validation output to the current working directory. + 6. `--report-directory` or `-d` **[Optional]**: Writes instance validation(instance_validation_report.txt) and telemetry validation (telemetry_validation_report.json) reports to the specified `report-directory`. By default, writes instance validation output to the console and telemetry validation output to the current working directory. -7`--udmi` **[Optional]**: Validates entity metadata as [UDMI](https://github.com/faucetsdn/udmi/). Flag is set to `True` by default; change this parameter to `--udmi=False` when not validating against UDMI. + 7. `--udmi` **[Optional]**: Validates entity metadata as [UDMI](https://github.com/faucetsdn/udmi/). Flag is set to `True` by default; change this parameter to `--udmi=False` when not validating against UDMI. For example, the following input