docs: add new readme files

richardzilincikPantheon · Jul 4, 2023 · 1923264 · 1923264
1 parent c78eee7
commit 1923264
Show file tree

Hide file tree

Showing 7 changed files with 8 additions and 1 deletion.
diff --git 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
@@ -0,0 +1 @@
+Modules for extracting information from IETF documents.
diff --git a/figures_and_stats/README.md b/figures_and_stats/README.md
@@ -0,0 +1 @@
+Scripts for generating statistics and graphs of YANG Catalog's module database.
diff --git a/ietf_modules_extraction/README.md b/ietf_modules_extraction/README.md
@@ -0,0 +1 @@
+Orchestration for exctracting YANG modules and relevant metadata from IETF documents.
diff --git a/metadata_generators/README.md b/metadata_generators/README.md
@@ -0,0 +1 @@
+Classes for retrieving and keeping relevant metadata for different categories of modules.
diff --git a/modules_compilation/README.md 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.
diff --git a/parsers/README.md b/parsers/README.md
@@ -0,0 +1 @@
+Classes for executing the validators on a module and cleaning up the output.