From a1add27285fd35cc1cd1746052c56b9903f8bc43 Mon Sep 17 00:00:00 2001 From: Jason Altekruse <jaltekruse@usgs.gov> Date: Tue, 29 Jun 2021 09:41:27 -0600 Subject: [PATCH] add link to documentation index for examples --- etc/examples/1-hazard-curve/README.md | 4 ++++ etc/examples/2-custom-config/README.md | 4 ++++ etc/examples/3-sites-file/README.md | 4 ++++ etc/examples/4-hazard-map/README.md | 4 ++++ etc/examples/5-complex-model/README.md | 4 ++++ etc/examples/6-enhanced-output/README.md | 4 ++++ etc/examples/7-deaggregation/README.md | 4 ++++ etc/examples/8-probabilities/README.md | 4 ++++ etc/examples/README.md | 4 ++++ 9 files changed, 36 insertions(+) diff --git a/etc/examples/1-hazard-curve/README.md b/etc/examples/1-hazard-curve/README.md index 0c53d3df5..ed8da9766 100644 --- a/etc/examples/1-hazard-curve/README.md +++ b/etc/examples/1-hazard-curve/README.md @@ -45,3 +45,7 @@ In the next example, we'll override the model supplied configuration with a cust <!-- markdownlint-disable MD001 --> #### Next: [Example 2 – A custom configuration](../2-custom-config/README.md) + +--- + +* [**Documentation Index**](../../../docs/README.md) diff --git a/etc/examples/2-custom-config/README.md b/etc/examples/2-custom-config/README.md index 2025aa249..33c8c381a 100644 --- a/etc/examples/2-custom-config/README.md +++ b/etc/examples/2-custom-config/README.md @@ -38,3 +38,7 @@ __Results directory structure:__ <!-- markdownlint-disable MD001 --> #### Next: [Example 3 – Using a custom sites file](../3-sites-file/README.md) + +--- + +* [**Documentation Index**](../../../docs/README.md) diff --git a/etc/examples/3-sites-file/README.md b/etc/examples/3-sites-file/README.md index 3c8b89d26..f70f356a4 100644 --- a/etc/examples/3-sites-file/README.md +++ b/etc/examples/3-sites-file/README.md @@ -39,3 +39,7 @@ __Results directory structure:__ <!-- markdownlint-disable MD001 --> #### Next: [Example 4 – A simple hazard map](../4-hazard-map/README.md) + +--- + +* [**Documentation Index**](../../../docs/README.md) diff --git a/etc/examples/4-hazard-map/README.md b/etc/examples/4-hazard-map/README.md index e2a1893c2..0c26c4102 100644 --- a/etc/examples/4-hazard-map/README.md +++ b/etc/examples/4-hazard-map/README.md @@ -28,3 +28,7 @@ __Results directory structure:__ <!-- markdownlint-disable MD001 --> #### Next: [Example 5 – A more complex model](../5-complex-model/README.md) + +--- + +* [**Documentation Index**](../../../docs/README.md) diff --git a/etc/examples/5-complex-model/README.md b/etc/examples/5-complex-model/README.md index 2fcb2903d..79f7b17b1 100644 --- a/etc/examples/5-complex-model/README.md +++ b/etc/examples/5-complex-model/README.md @@ -67,3 +67,7 @@ __Results directory structure:__ <!-- markdownlint-disable MD001 --> #### Next: [Example 6 – Enhanced output](../6-enhanced-output/README.md) + +--- + +* [**Documentation Index**](../../../docs/README.md) diff --git a/etc/examples/6-enhanced-output/README.md b/etc/examples/6-enhanced-output/README.md index 546c9dd68..61fffb7a1 100644 --- a/etc/examples/6-enhanced-output/README.md +++ b/etc/examples/6-enhanced-output/README.md @@ -53,3 +53,7 @@ __Results directory structure:__ <!-- markdownlint-disable MD001 --> #### Next: [Example 7 – Deaggregation](../7-deaggregation/README.md) + +--- + +* [**Documentation Index**](../../../docs/README.md) diff --git a/etc/examples/7-deaggregation/README.md b/etc/examples/7-deaggregation/README.md index aa1f2d378..4750f2aff 100644 --- a/etc/examples/7-deaggregation/README.md +++ b/etc/examples/7-deaggregation/README.md @@ -89,3 +89,7 @@ empty results will not be saved. <!-- markdownlint-disable MD001 --> #### Next: [Example 8 – Earthquake probabilities and rates](../8-probabilities/README.md) + +--- + +* [**Documentation Index**](../../../docs/README.md) diff --git a/etc/examples/8-probabilities/README.md b/etc/examples/8-probabilities/README.md index 4574d2c43..38f3b7a6d 100644 --- a/etc/examples/8-probabilities/README.md +++ b/etc/examples/8-probabilities/README.md @@ -47,3 +47,7 @@ __Results directory structure:__ ├─ RateCalc.log └─ probs.csv ``` + +--- + +* [**Documentation Index**](../../../docs/README.md) diff --git a/etc/examples/README.md b/etc/examples/README.md index db74aa10c..b557f3baa 100644 --- a/etc/examples/README.md +++ b/etc/examples/README.md @@ -12,3 +12,7 @@ Because each example builds on prior concepts, it is best step through all the e <!-- markdownlint-disable MD001 --> #### Start: [Example 1 – A simple hazard calculation](1-hazard-curve/README.md) + +--- + +* [**Documentation Index**](../../docs/README.md) -- GitLab