Update documentation (#1417)

CONTRIBUTING.md

@@ -136,7 +136,6 @@ For issues relating to individual components, please use the component specific
 If you are unsure which component your issue relates to, submit it here and we will triage it.
 Thank you for contributing to VIC Product!
 
-
 ## Repository structure
 
 The layout in the repo is as follows:
@@ -146,6 +145,10 @@ The layout in the repo is as follows:
 * tests - VIC Appliance tests
 * tutorials - Tutorials
 
+## VIC Appliance
+
+View the [VIC Appliance Readme](installer/README.md)
+
 ## Troubleshooting
 
-* If you're building the project in a VM, ensure that it has at least 4GB memory to avoid issues while running the build.
+View the [VIC Appliance Troubleshooting Guide](installer/docs/SUPPORT.md)

README.md

@@ -19,7 +19,7 @@ Please refer to the [documentation](https://vmware.github.io/vic-product/#docume
 
 ## Support and Troubleshooting
 
-View the [VIC Appliance Troubleshooting Guide](installer/SUPPORT.md)
+View the [VIC Appliance Troubleshooting Guide](installer/docs/SUPPORT.md)
 
 ## Contributing to vSphere Integrated Containers
 

installer/README.md

@@ -1,4 +1,4 @@
-# VIC Unified Installer
+# VIC Appliance
 
 This directory will host all the code for the VIC Appliance.
 

installer/docs/DESIGN.md

@@ -208,10 +208,9 @@ time of the build.
 
   This document defines the interface between the VIC appliance and the component.
 
-- A component MUST maintain component specific integration tests in the `vic-product` repo
-
-- The component team MUST monitor each triggered `vic-product` downstream build for failures and
-  triage them according to the [Triage Process](#triage-process)
+- The component team MUST monitor each triggered `vic-product` downstream build for failures. If the
+  build failure is suspected to be caused by changes to the component, triage the failure according
+  to the [Triage Process](#triage-process)
 
 ### Requirements
 
@@ -231,17 +230,9 @@ time of the build.
   tests locally before triggering the `vic-product` downstream build
 
 - The component MUST have a release version tagging and artifact upload workflow. Released versions
-  MUST be retained.
-
-- In the case of a failing build, the component team that triggered the failing appliance build MUST
-  take leadership of returning the build to a normal state and assign that effort a high priority
+  MUST be retained so that builds can be rebuilt using previously released versions.
 
-- In the case of a failing build, the component team in charge MUST alert the appliance team and
-  other stakeholders through Slack that work to fix the build is in progress. If an extended
-  breakage is expected, the team MUST give regular progress updates to stakeholders (at least once
-  per day).
-
-- The component team MUST document and provide the appliance team with acceptance tests for features
+- The component team SHOULD document and provide the appliance team with acceptance tests for features
   that need to be tested
 
   The appliance team performs automated and manual testing for release acceptance. The component
@@ -257,9 +248,6 @@ time of the build.
 
 ### Triage Process
 
-When a `vic-product` CI build fails, it is the responsibility of the component team that triggered
-the build to triage the failure.
-
 - Message `#vic-product-standup` channel to say that triage is in progress
 - Download build logs from the failed build
 - Examine logs and identify failure