Skip to content

Commit

Permalink
[docs] README(s) markdown nits, add helper script to generate entitie…
Browse files Browse the repository at this point in the history
…s (oversight)

Signed-off-by: Matt Young <[email protected]>
  • Loading branch information
Matt Young committed Aug 11, 2023
1 parent 7aec0b3 commit 5554287
Show file tree
Hide file tree
Showing 4 changed files with 105 additions and 32 deletions.
63 changes: 31 additions & 32 deletions db/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,20 +2,16 @@

## 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

![core-png](core/generated/landscape-graph-core.png)

![supergraph-10k-sketch](landscape-graph-supergraph-10k-sketch.jpg)

### Entities

**TODO: ctx->allTheThings.ToMarkdown();**

## Sub-Graph Modules (SGM)

### SGM Goals
Expand All @@ -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, ...)
Expand All @@ -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
```
Expand Down
Loading

0 comments on commit 5554287

Please sign in to comment.