chore(cleanup): remove unused files & update readme (#127)

armory · Jan 12, 2021 · da11bed · da11bed
1 parent 94084b6
commit da11bed
Show file tree

Hide file tree

Showing 9 changed files with 25 additions and 116 deletions.
diff --git a/.gitignore b/.gitignore
@@ -50,3 +50,4 @@ tags
 .vim
 
 # End of https://www.gitignore.io/api/vim
+dinghy
diff --git a/LICENSE b/LICENSE
@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright [yyyy] [name of copyright owner]
+   Copyright 2021 Armory, Inc.
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

diff --git a/README.md b/README.md
@@ -2,32 +2,39 @@
 
 # dinghy
 
-_A little boat to take you to the big boat_ - Miker
+Dinghy allows you to create and maintain Spinnaker pipeline templates in source
+control.
 
-## Yo, but what do it do?
+Read more in our
+[documentation](https://docs.armory.io/docs/armory-admin/dinghy-enable/).
 
-Users should be able to specify a pipeline in code in their GitHub repo. Dinghy should keep the pipeline in Spinnaker in sync with what is in the GitHub repo. Also, users should be able to make a pipeline by composing other pipelines, stages, or tasks and templating certain values.
-
-### Deets
+### How It Works
 
 There are two primitives:
-- Stage/Task templates: These are all kept in a single GitHub repo. They are json files with replacable values in them.
-- Pipeline definitions: These define a pipeline for an application. You can compose stage/task templates to make a full definition.
+- Stage/Task templates: These are all kept in a single GitHub repo. They are
+  json files with replacable values in them.
+- Pipeline definitions: These define a pipeline for an application. You can
+  compose stage/task templates to make a full definition.
 
 How it works:
-- GitHub webhooks are sent off when either the templates or the definitions are modified.
+- GitHub webhooks are sent off when either the templates or the definitions are
+  modified.
 - Templates should be versioned by hash when they are used.
-- Dinghy will keep a dependency graph of downstream templates. When a dependency is modified, the pipeline definition will be rebuilt and re-posted to Spinnaker. (sound familiar? haha)
-
-<!-- made using ./bin/makeDiagrams.sh -->
-![](diagrams/workflow.mmd.svg)
+- Dinghy will keep a dependency graph of downstream templates. When a
+  dependency is modified, the pipeline definition will be rebuilt and re-posted
+  to Spinnaker. (sound familiar? haha)
 
-### Testing manually.
+### Testing Manually
 
-curl -X POST -H "Content-Type: application/json" -d "@example/github_payload.json" http://localhost:8089/webhooks/git/github
+```shell
+curl -X POST \
+  -H "Content-Type: application/json" \
+  -d "@example/github_payload.json" \
+  http://localhost:8089/webhooks/git/github
+```
 
 (The github_payload.json file in the example directory is a minimal set for
 testing the git webhook, as an example)
 
-
-
+Dinghy is also embedded in the [arm cli](https://github.com/armory-io/arm) tool
+for local validation of pipelines.
diff --git a/diagrams/workflow.mmd b/diagrams/workflow.mmd
diff --git a/diagrams/workflow.mmd.svg b/diagrams/workflow.mmd.svg
diff --git a/dinghy_test.go b/dinghy_test.go
diff --git a/dinghy_version b/dinghy_version
diff --git a/dinghyfile b/dinghyfile
diff --git a/package.json b/package.json
Original file line number	Diff line number	Diff line change
Expand Up		@@ -50,3 +50,4 @@ tags
		.vim

		# End of https://www.gitignore.io/api/vim
		dinghy