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

New command **document** to document current state #15

Open
sdorheim opened this issue Mar 28, 2022 · 2 comments
Open

New command **document** to document current state #15

sdorheim opened this issue Mar 28, 2022 · 2 comments
Labels
backlog issues which we have to look in later new-feature

Comments

@sdorheim
Copy link
Contributor

Add new command document that outputs the current setup in markdown + mermaid and highlights what was created with the bootstrap tool and what was manually created
spex66 added a commit that referenced this issue Apr 6, 2022
@spex66
Merge pull request #19 from cognitedata/doc-as-mermaid
d86bcc4 
"Doc as mermaid" which is one step towards a "documentation" feature (see issue #15 )

option 1: copy mermaid output to (Windows) `clip.exe` and copy it into `https://mermaid.live` for review
```
➟  poetry run bootstrap-cli diagram .local/config-deploy-bootstrap.yml | clip.exe
```
option 2: add a markdown wrapper and pipe it into a `graph.md` document, where you can use VSCode with mermaid extension as output or for review
```
➟  poetry run bootstrap-cli diagram --markdown-yes .local/config-deploy-bootstrap.yml > graph.md
```
@spex66
Copy link
Collaborator

spex66 commented Apr 6, 2022

documentation could cover more, but PR #19 implemented now a diagram command to generate mermaid (diagram as code) output, which can be

  • embedded into VSCode or Github markdown for documentation (which has markdown + mermaid support)
  • copy the mermaid code into https://mermaid.live for preview or image exports (PNG, SVG, ..)

@spex66 spex66 added the backlog issues which we have to look in later label Sep 15, 2022
@spex66
Copy link
Collaborator

spex66 commented Apr 19, 2023

As diagram -- as is today -- gets veeery confusing with complex configurations, this is up on my radar after #63 is done.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
backlog issues which we have to look in later new-feature
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@spex66 @sdorheim