From b3040833656167e11bc242192158791f7ab7f696 Mon Sep 17 00:00:00 2001 From: Eric Dasmalchi Date: Fri, 9 Aug 2024 15:21:33 -0700 Subject: [PATCH 1/2] add mermaid reference, link to docs: --- docs/contribute/content_types.md | 3 ++- docs/publishing/sections/5_analytics_portfolio_site.md | 1 + 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/contribute/content_types.md b/docs/contribute/content_types.md index f531d35f8a..841ed9e9ba 100644 --- a/docs/contribute/content_types.md +++ b/docs/contribute/content_types.md @@ -27,7 +27,8 @@ Below we've provided some examples of commons types of content for quick use. To - [SQL](executing-code-sql) 3. [Non-executing Code](non-executing-code) 4. [Internal References and Cross References](internal-refs) - (executing-code)= +5. Need a node graph to illustrate a complex flow or process? Try mermaid ([documentation here](https://mermaid.js.org/intro/)). + (executing-code)= ### Executing Code diff --git a/docs/publishing/sections/5_analytics_portfolio_site.md b/docs/publishing/sections/5_analytics_portfolio_site.md index 30acf55cf3..12eacdf3cf 100644 --- a/docs/publishing/sections/5_analytics_portfolio_site.md +++ b/docs/publishing/sections/5_analytics_portfolio_site.md @@ -41,6 +41,7 @@ Create a `README.md` file in the repo where your work lies. This also forms the - `git rm portfolio/my_analysis/README_accidentally_named_something_else.md` - `rm portfolio/my_analysis/_build/html/README_accidentally_named_something.html`. We use `rm` because \_build/html folder is not checked into GitHub - `python portfolio/portfolio.py build my_report --no-execute-papermill --deploy` to rerun the portfolio to incorporate only the new changes to your `README.md` if the other pages are correct. +- Need a node graph to illustrate where your data comes from and how it's processed? Try mermaid ([documentation here](https://mermaid.js.org/intro/)). See published [GTFS Digest](https://gtfs-digest--cal-itp-data-analyses.netlify.app/readme) for a current example. ### YML From e3328502572ac1da6b0e3cf522dc016c3323f7a3 Mon Sep 17 00:00:00 2001 From: Eric Dasmalchi Date: Fri, 9 Aug 2024 22:35:22 +0000 Subject: [PATCH 2/2] format --- docs/contribute/content_types.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/contribute/content_types.md b/docs/contribute/content_types.md index 841ed9e9ba..8e72ff5250 100644 --- a/docs/contribute/content_types.md +++ b/docs/contribute/content_types.md @@ -28,7 +28,7 @@ Below we've provided some examples of commons types of content for quick use. To 3. [Non-executing Code](non-executing-code) 4. [Internal References and Cross References](internal-refs) 5. Need a node graph to illustrate a complex flow or process? Try mermaid ([documentation here](https://mermaid.js.org/intro/)). - (executing-code)= + (executing-code)= ### Executing Code