From 0e8508b8533a96161834e0ed922d7cd9cb00497e Mon Sep 17 00:00:00 2001 From: "andrebriggs@users.noreply.github.com" Date: Fri, 27 Mar 2020 12:32:13 -0700 Subject: [PATCH 1/3] Adding README --- docs/commands/data.json | 4 --- technical-docs/designs/README.md | 51 ++++++++++++++++++++++++++++++++ 2 files changed, 51 insertions(+), 4 deletions(-) create mode 100644 technical-docs/designs/README.md diff --git a/docs/commands/data.json b/docs/commands/data.json index f47cf1117..07725bf42 100644 --- a/docs/commands/data.json +++ b/docs/commands/data.json @@ -191,10 +191,6 @@ "description": "Name of the resource group to create new storage account when it does not exist", "required": true }, - { - "arg": "-k, --key-vault-name ", - "description": "Name of the Azure key vault" - }, { "arg": "--service-principal-id ", "description": "Azure service principal id with `contributor` role in Azure Resource Group", diff --git a/technical-docs/designs/README.md b/technical-docs/designs/README.md new file mode 100644 index 000000000..95bc438b0 --- /dev/null +++ b/technical-docs/designs/README.md @@ -0,0 +1,51 @@ +# Bedrock CLI Design Software Design Proposals + +## Summary + +Bedrock is a Microsoft open-source project focusing on Kubernetes deployment +automation, observability, and infrastructure. This repository contains a CLI +implementation of Bedrock concepts that are under constant design and +implementation. + +When contributing a substantial design change we reccomend a design proposal. +Below is a design proposal template with suggesteed headers to include in your +design proposal to the Bedrock CLI. + +## Proposal Template + +### Design Proposal Title + +Reference: _What is this in reference to?_ + +Authors: _Names of authors_ + +| Revision | Date | Author | Remarks | +| -------: | --------------- | ------------- | ------------- | +| 0.1 | Month-Day, Year | _Author Name_ | Initial Draft | + +### Overview + +_Briefly describe what the proposed design is attempting to achieve. Think about +the job to be done. What is the goal?_ + +### Out of Scope + +_Describe what is not relevant in this design. What are the non-goals?_ + +### Design Details + +_Describe the design in detail. Consider staging the design into steps._ + +### Dependencies + +_Describe what assumptions wee are making about dependencies in ordeer for your +proposeed design to function correctly._ + +### Risks & Mitigations + +_Describe risks and how we plans to overcome or handle them in the proposed +design._ + +### Documentation + +_Describe what documentation needs to be added or modified (if any)._ From f07b21124678d68294f010f0c038666720b1cd68 Mon Sep 17 00:00:00 2001 From: Andre Briggs Date: Fri, 27 Mar 2020 12:46:28 -0700 Subject: [PATCH 2/3] Update README.md --- technical-docs/designs/README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/technical-docs/designs/README.md b/technical-docs/designs/README.md index 95bc438b0..cfb9380c6 100644 --- a/technical-docs/designs/README.md +++ b/technical-docs/designs/README.md @@ -49,3 +49,7 @@ design._ ### Documentation _Describe what documentation needs to be added or modified (if any)._ + +### Appendix + +_Reference any additional artifacts (docs, images, links) that would help give context to the proposed design._ From f41d1db7cf0427b6152b327fa1336c0e5a60c4ef Mon Sep 17 00:00:00 2001 From: Andre Briggs Date: Fri, 27 Mar 2020 12:47:18 -0700 Subject: [PATCH 3/3] Update README.md Updated title --- technical-docs/designs/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/technical-docs/designs/README.md b/technical-docs/designs/README.md index cfb9380c6..57bda0800 100644 --- a/technical-docs/designs/README.md +++ b/technical-docs/designs/README.md @@ -1,4 +1,4 @@ -# Bedrock CLI Design Software Design Proposals +# Bedrock CLI Software Design Proposals ## Summary