From 975c740a74c7e3a7692308ba65252126e0baa18f Mon Sep 17 00:00:00 2001 From: "andrew.greene" Date: Fri, 10 Dec 2021 14:33:05 -0700 Subject: [PATCH] Add Sparkles Guide contribution guidelines --- README.md | 4 +++- docs/sparkles-guides-contribution.md | 33 ++++++++++++++++++++++++++++ 2 files changed, 36 insertions(+), 1 deletion(-) create mode 100644 docs/sparkles-guides-contribution.md diff --git a/README.md b/README.md index f88b95abd..9a591bb39 100644 --- a/README.md +++ b/README.md @@ -17,9 +17,11 @@ Docker ## Contributing +Submit an [issue](https://github.com/defenseunicorns/Sparkles-Guide/issues/new) if unsure. + ### To Sparkle Guides ->coming soon... +See [this](docs/sparkles-guides-contribution.md) guide, if you are looking to contribute to the guides and flows. ### To Code diff --git a/docs/sparkles-guides-contribution.md b/docs/sparkles-guides-contribution.md new file mode 100644 index 000000000..a8a656cc8 --- /dev/null +++ b/docs/sparkles-guides-contribution.md @@ -0,0 +1,33 @@ +# Sparkles Guides Contribution Guidelines + +The Guides are crowd sourced and contributions should be made with the overarching audience in mind. + +At the simplest level: + +1. Run Sparkles Guide +2. Make an update in the UI (i.e. new flow, new topic, new material, etc...) +3. Save the flow (by clicking the "Deploy" button, until issue #5 is resolved) +4. commit and push your changes (which are saved in data/flows.json) + +## Conventions and Guidelines + +- Topics within flows, build upon each other from left to right. For example, knowing containerization prior to kubernetes. +- Use subflows when a common topic exists. Ex. Zarf requires golang, which is a learning topic itself, or BigBang requires kubernetes +- Add materials (youtube, course, SME, article, etc...) to the description of nodes. +- Add a * to materials that you found helpful + +## Elements +### Nodes + +Nodes are the basic element that can be added to flows, by drag drop. We use nodes to indicate a topic and the properties of a node have descriptions and materials for learning the topic. + +### Flows + +Flows are the connection of nodes to capture the guide on a larger topic. Flows flow from left to right building nodes up sequentially as a guide. Flow can also include sub-flows, when needing to dive into a deeper topic. + +### Subflows + +Sub flows can be created for more fundamental guides, such as, kubernetes and inserted into flows/guides as a topic or node. Subflows can only be created with the hamburger menu in the top right of the app. Once created show up as a node on the left panel. + + +