Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: README(s) markdown nits, add helper script to generate entities #111

Merged
merged 1 commit into from
Aug 11, 2023
Merged

docs: README(s) markdown nits, add helper script to generate entities #111

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
63 changes: 31 additions & 32 deletions db/README.md
View file
Open in desktop
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
Loading