Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update documentation #1417

Merged
merged 3 commits into from
Feb 8, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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)
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion installer/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# VIC Unified Installer
# VIC Appliance

This directory will host all the code for the VIC Appliance.

Expand Down
22 changes: 5 additions & 17 deletions installer/docs/DESIGN.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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
Expand All @@ -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
Expand Down