Merge pull request #1 from chadtownes/patch-1

Update README.md
This commit is contained in:
pdimitratos 2017-09-07 14:59:37 -07:00 коммит произвёл GitHub
Родитель f95a6cfecd b489ecff3f
Коммит 80f61a60ce
1 изменённых файлов: 40 добавлений и 10 удалений

Просмотреть файл

@ -1,14 +1,44 @@
# SIA - SRE Incident Assistant
# Contributing
SIA is a new incident management tool that reads from event sources and recommends courses of action that help mitigate incidents quickly. SIA can read from nearly any event stream or ticketing system, and works with many live site response models.
This project welcomes contributions and suggestions. Most contributions require you to agree to a
Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
the rights to use your contribution. For details, visit https://cla.microsoft.com.
## The problem
Software systems are only as effective as they are reliable. As online services grow larger and more complex, the potential complexity of failure modes increases as well. Measures that reduce chances of catastrophic failure (such as redundancy, automated mitigation, and throttling/retry logic) are very effective at preventing simple bugs and hardware failures from causing outages, but cannot (yet) adjust to prevent types of problems that weren't anticipated when those measures were designed. As organizations automate away the need for humans to intervene in cases of simple failures, human incident responders are left to deal with the most complex and pervasive outages. Existing tools are sufficient for most incidents, but fall short in critical situations:
* [Grey failures](https://www.microsoft.com/en-us/research/wp-content/uploads/2017/06/paper-1.pdf), capacity tipping points, and other cases where multiple systems interact in unanticipated ways to produce problems without a known path to mitigation, especially when changes to code or configuration may result in more impact to users than the problem itself.
* Situations where multiple teams are simultaneously investigating outages, some (but not all) of which share a root cause.
* Long-running issues that require coordination between multiple teams and handoff between shifts within each team over the course of several days or weeks.
* Long-running issues that require coordination between multiple teams and handoff between shifts within each team over the course of several days or weeks.
* Major security issues such as [Heartbleed](https://en.wikipedia.org/wiki/Heartbleed) and [WannaCry](https://en.wikipedia.org/wiki/WannaCry_ransomware_attack) that require immediate updates across significant portions of an organization's infrastructure.
* Disasters that cause extended or permanent loss of significant physical capacity, including undersea fiber cuts and loss of data center buildings.
When you submit a pull request, a CLA-bot will automatically determine whether you need to provide
a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions
provided by the bot. You will only need to do this once across all repos using our CLA.
## The solution
The SRE Incident Assistant (SIA) is designed to facilitate coordination, communication, and mitigation activities in 'worst case scenario' outages while gathering data for use in postmortem and process improvement.
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
# Quick Start
* [Install prerequisites](https://github.com/Azure/Sia-Root/How-to-Contribute#installing-prerequisites)
* Clone the repos:
* Gateway: git clone [https://github.com/Azure/Sia-Gateway](https://github.com/Azure/Sia-Gateway)
* UI: git clone [https://github.com/Azure/sia-ui](https://github.com/Azure/sia-ui)
* Update the [configurations](https://github.com/Azure/Sia-Root/How-to-Contribute#development-workflow)
* Launch Gateway form VS2017 or VS Code
* Start UI with npm: npm start
* Open [http://localhost:3000](http://localhost:3000) in your browser, and voilà
## Contributing
If you are interested in fixing issues and contributing directly to the code base, please see the document How to Contribute, which covers the following:
* [Build and Run from Source](https://github.com/Azure/Sia-Root/How-to-Contribute##build)
* [The development workflow, including debugging and running tests](https://github.com/Azure/Sia-Root/How-to-Contribute##debugging)
* [Coding guidelines](https://github.com/Azure/Sia-Root/How-to-Contribute##work-branches)
* [Submitting pull requests](https://github.com/Azure/Sia-Root/How-to-Contribute##where-to-contribute)
Please see also our [Code of Conduct]((https://github.com/Azure/Sia-Root/Code-of-Conduct).
## Feedback
* Request a new feature on [GitHub](CONTRIBUTING.md)
* Vote for [popular feature requests](https://github.com/Azure/sia-root/issues?q=is%3Aopen+is%3Aissue+label%3Afeature-request+sort%3Areactions-%2B1-desc).
* File a bug in [GitHub Issues](https://github.com/Azure/sia-root/issues).
## License
Copyright (c) Microsoft Corporation. All rights reserved.
Licensed under the [MIT](https://github.com/Microsoft/vscode/blob/master/LICENSE.txt) License.