docs update

This commit is contained in:
Jordan McClintock 2022-02-23 15:39:24 -06:00 committed by andrew.greene
parent 01e68de9ec
commit 8cf6160c06
2 changed files with 2 additions and 2 deletions

View File

@ -2,7 +2,7 @@
Sparkles guide is forked from Node-red, which has a LOT of functionality in addition to the nice UI we use. As such, much code is not relevant for our purpose. Sparkles guide is forked from Node-red, which has a LOT of functionality in addition to the nice UI we use. As such, much code is not relevant for our purpose.
Since this is a derivative work, using an Apache 2.0 license. We MUST add a modification copyright to any changed files not originated by us. Add `2021 Modification Copyright - Defense Unicorns` as a comment to the top of any changed file. Since this is a derivative work, using an Apache 2.0 license. We MUST add a modification copyright to any changed files not originated by us. Add `2022 Modification Copyright - Defense Unicorns` as a comment to the top of any changed file.
Finally, deleting code often has unintended consequences - you should, at a minimum, add cypress tests to confirm basic, common functionality to ensure functionality. Finally, deleting code often has unintended consequences - you should, at a minimum, add cypress tests to confirm basic, common functionality to ensure functionality.

View File

@ -11,7 +11,7 @@ At the simplest level:
## Conventions and Guidelines ## Conventions and Guidelines
- Topics within flows, build upon each other from left to right. For example, knowing containerization prior to kubernetes. - Topics within flows, build upon each other from top to bottom. 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 - 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 materials (youtube, course, SME, article, etc...) to the description of nodes.
- Add a * to materials that you found helpful - Add a * to materials that you found helpful