Index: appengine/findit_mock/README.md |
diff --git a/appengine/findit_mock/README.md b/appengine/findit_mock/README.md |
new file mode 100644 |
index 0000000000000000000000000000000000000000..9a73b2c3d0166826cfafddefa67151b075b3ebdc |
--- /dev/null |
+++ b/appengine/findit_mock/README.md |
@@ -0,0 +1,37 @@ |
+# Findit |
+ |
+[go/findit-site](https://sites.google.com/a/chromium.org/cr-culprit-finder/findit) |
+ |
+Findit is a culprit finder for compile/test/flake failures on Chromium Waterfall |
+and also flaky tests on Chromium Commit Queue. Now it supports: |
+* Identify culprits for reliable test/compile failures on Waterfall |
+* Distinguish flaky tests from reliable tests on Waterfall |
+* Identify regression ranges for flaky gtests on both Waterfall and Commit Queue |
+ |
+Findit has two separate entry points to run an analysis: |
+* Waterfall failures: [go/findit-for-me](https://findit-for-me.appspot.com/) |
+* Flaky tests: [go/findit-flake-checker](https://findit-for-me.appspot.com/waterfall/flake) |
+ |
+Findit has two dashboards for the analysis results: |
+* [Waterfall failures](https://findit-for-me.appspot.com/waterfall/list-analyses) |
+* [Flaky tests](https://findit-for-me.appspot.com/waterfall/list-flakes) |
+ |
+# Integration with other systems |
+* Findit is integrated with [Sheriff-o-Matic](https://sheriff-o-matic.appspot.com) to analyze Waterfall failures, and surface analysis results to SoM for Chromium sheriffs. For detected flaky tests on Waterfall, further analysis is run automatically but asynchronously. Once a culprit is identified with high confidence, Findit also update the codereview of the culprit on [Rietveld](https://codereview.chromium.org/). |
+ |
+* Findit is integrated with [Chromium Trybot Flakes](https://chromium-try-flakes.appspot.com/) to analyze flaky tests on Commit Queue, and update the corresponding Monorail bugs with any findings for the flakes. |
+ |
+# Code structure |
+ |
+* [libs](libs/README.md): shared, AppEngine-independent, but AppEngine-compatible APIs. |
+* [gae\_libs](gae_libs/README.md): shared but AppEngine-dependent APIs. |
+* [infra\_clients](infra_clients/README.md): AppEngine-dependent clients to |
+ interact with various Chrome Infra services. |
+* [analysis](analysis): Core of analysis for failures and flakes. |
+* \*\_app: The App Engine modules to provide core services of Findit. |
+* [scripts](scripts): Utility scripts to run locally on developer's workstation. |
+* [third\_party](third_party): Third-party libraries that Findit depends on. |
+ |
+# Contributions |
+ |
+We welcome all contributions! Please refer to [DEV.md](DEV.md) for more info. |