From 555428797eb312d3f1a6144cdfe7553ec6b20894 Mon Sep 17 00:00:00 2001 From: Matt Young Date: Fri, 11 Aug 2023 13:19:22 -0400 Subject: [PATCH] [docs] README(s) markdown nits, add helper script to generate entities (oversight) Signed-off-by: Matt Young --- db/README.md | 63 +++++++++++++++++------------------ db/graphql-cypherdb.svg | 61 +++++++++++++++++++++++++++++++++ db/social/sgm-email/README.md | 1 + generate-entities.sh | 12 +++++++ 4 files changed, 105 insertions(+), 32 deletions(-) create mode 100644 db/graphql-cypherdb.svg create mode 100644 db/social/sgm-email/README.md create mode 100755 generate-entities.sh diff --git a/db/README.md b/db/README.md index cd2d0e2..0c3ee8a 100644 --- a/db/README.md +++ b/db/README.md @@ -2,9 +2,9 @@ ## How this works -![diag-neo4j-graphql-library](diag-neo4j-graphql-library.svg) +![diagram-graphql-cypher](graphql-cypherdb.svg) -(source: https://neo4j.com/developer/graphql/#_the_neo4j_graphql_library) +[source](https://neo4j.com/developer/graphql/#_the_neo4j_graphql_library) ## Core Data Model @@ -12,10 +12,6 @@ ![supergraph-10k-sketch](landscape-graph-supergraph-10k-sketch.jpg) -### Entities - -**TODO: ctx->allTheThings.ToMarkdown();** - ## Sub-Graph Modules (SGM) ### SGM Goals @@ -40,14 +36,14 @@ Each of these is an Interface, acting as a base class with shared properties. | [cncf](cncf) | Member, Project, License, TAG, EUG, TOC, Organizations, ... | [core](core) | Core Data Model | | [corp](corp) | crunchbase, yahoofinance | -| [email](email) | cncf project lists, k8s lists | | [packages](packages) | brew, choco, crate, deb, deno, go, maven, npm, pip, rpm | | [rtc](rtc) | slack, discord, gitter | | [scm](scm) | git, gharchive | -| [social](social) | twitter, linkedin | +| [social](social) | email lists, twitter, linkedin | | [threats](threats) | nist | | [videos](videos) | youtube | + Each module will have the following: * base metadata (name, version, ...) @@ -59,39 +55,42 @@ Each module will have the following: ```shell . +├── A +├── B ├── blogs -│ └── sgm-blogcncf +│   └── sgm-blogcncf ├── boards -│ ├── sgm-ghdiscuss -│ └── sgm-stackoverflow +│   ├── sgm-ghdiscuss +│   └── sgm-stackoverflow +├── cncf ├── core -│ └── generated +│   └── generated ├── corp -│ ├── sgm-crunchbase -│ └── sgm-yahoofinance -├── email +│   ├── sgm-crunchbase +│   └── sgm-yahoofinance ├── packages -│ ├── sgm-brew -│ ├── sgm-choco -│ ├── sgm-crate -│ ├── sgm-deb -│ ├── sgm-deno -│ ├── sgm-go -│ ├── sgm-maven -│ ├── sgm-npm -│ ├── sgm-pip -│ └── sgm-rpm +│   ├── sgm-brew +│   ├── sgm-choco +│   ├── sgm-crate +│   ├── sgm-deb +│   ├── sgm-deno +│   ├── sgm-go +│   ├── sgm-maven +│   ├── sgm-npm +│   ├── sgm-pip +│   └── sgm-rpm ├── rtc -│ ├── sgm-discord -│ └── sgm-slack +│   ├── sgm-discord +│   └── sgm-slack ├── scm -│ ├── sgm-git -│ └── sgm-gharchive +│   ├── sgm-git +│   └── sgm-github +├── sgm-template ├── social -│ ├── sgm-linkedin -│ └── sgm-twitter +│   ├── sgm-linkedin +│   └── sgm-twitter ├── threats -│ └── sgm-nist +│   └── sgm-nist └── videos └── sgm-youtube ``` diff --git a/db/graphql-cypherdb.svg b/db/graphql-cypherdb.svg new file mode 100644 index 0000000..578325c --- /dev/null +++ b/db/graphql-cypherdb.svg @@ -0,0 +1,61 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/db/social/sgm-email/README.md b/db/social/sgm-email/README.md new file mode 100644 index 0000000..244c17d --- /dev/null +++ b/db/social/sgm-email/README.md @@ -0,0 +1 @@ +# sgm-email diff --git a/generate-entities.sh b/generate-entities.sh new file mode 100755 index 0000000..078c66a --- /dev/null +++ b/generate-entities.sh @@ -0,0 +1,12 @@ +#!/usr/bin/env bash + +JP="jp -f landscape-items-clean.json" + +jp -f landscape-items-clean.json "[?relation].{ id: id, \ + flatName: flatName, \ + name: name, \ + relation: relation, \ + oss: oss, \ + license: license, \ + description: description \ + repos: repos }" \ No newline at end of file