From 192326440e59fc8863cc683206235e827947e8b9 Mon Sep 17 00:00:00 2001 From: richardzilincikPantheon Date: Tue, 4 Jul 2023 12:38:25 +0200 Subject: [PATCH] docs: add new readme files --- README.md | 2 +- extractors/README.md | 1 + figures_and_stats/README.md | 1 + ietf_modules_extraction/README.md | 1 + metadata_generators/README.md | 1 + modules_compilation/README.md | 2 ++ parsers/README.md | 1 + 7 files changed, 8 insertions(+), 1 deletion(-) create mode 100644 extractors/README.md create mode 100644 figures_and_stats/README.md create mode 100644 ietf_modules_extraction/README.md create mode 100644 metadata_generators/README.md create mode 100644 modules_compilation/README.md create mode 100644 parsers/README.md diff --git a/README.md b/README.md index 3a12d76..2e81295 100644 --- a/README.md +++ b/README.md @@ -21,7 +21,7 @@ When extracting data from IETF documents, the document's metadata is added to th --- -Most of the code is in the `bin/` directory and uses `bash` and Python3 scripts. +The code consists of `bash` and Python3 scripts. Some configuration files are in the `conf/` directory including `paths.sh` which defines all paths used by the scripts. This script merely reads the global configuration file `/etc/yangcatalog/yangcatalog.conf` and creates the required environement variables required by the shell scripts. diff --git a/extractors/README.md b/extractors/README.md new file mode 100644 index 0000000..a5a384d --- /dev/null +++ b/extractors/README.md @@ -0,0 +1 @@ +Modules for extracting information from IETF documents. \ No newline at end of file diff --git a/figures_and_stats/README.md b/figures_and_stats/README.md new file mode 100644 index 0000000..afa18a1 --- /dev/null +++ b/figures_and_stats/README.md @@ -0,0 +1 @@ +Scripts for generating statistics and graphs of YANG Catalog's module database. \ No newline at end of file diff --git a/ietf_modules_extraction/README.md b/ietf_modules_extraction/README.md new file mode 100644 index 0000000..fc9dab0 --- /dev/null +++ b/ietf_modules_extraction/README.md @@ -0,0 +1 @@ +Orchestration for exctracting YANG modules and relevant metadata from IETF documents. \ No newline at end of file diff --git a/metadata_generators/README.md b/metadata_generators/README.md new file mode 100644 index 0000000..6b433ca --- /dev/null +++ b/metadata_generators/README.md @@ -0,0 +1 @@ +Classes for retrieving and keeping relevant metadata for different categories of modules. \ No newline at end of file diff --git a/modules_compilation/README.md b/modules_compilation/README.md new file mode 100644 index 0000000..aedb66e --- /dev/null +++ b/modules_compilation/README.md @@ -0,0 +1,2 @@ +The main part of the daily cronjob which runs the validators on YANG modules and outputs the results to Redis and +JSON + HTML files. \ No newline at end of file diff --git a/parsers/README.md b/parsers/README.md new file mode 100644 index 0000000..85797e3 --- /dev/null +++ b/parsers/README.md @@ -0,0 +1 @@ +Classes for executing the validators on a module and cleaning up the output. \ No newline at end of file