You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@aurora.apache.org by wf...@apache.org on 2016/01/03 18:36:42 UTC

aurora git commit: Add a list of Aurora design documents

Repository: aurora
Updated Branches:
  refs/heads/master 4a9f2ff5f -> 297ebc157


Add a list of Aurora design documents

Even though documents can become outdated after a couple of months or even years,
they are an important resource for future committers.

Reviewed at https://reviews.apache.org/r/41846/


Project: http://git-wip-us.apache.org/repos/asf/aurora/repo
Commit: http://git-wip-us.apache.org/repos/asf/aurora/commit/297ebc15
Tree: http://git-wip-us.apache.org/repos/asf/aurora/tree/297ebc15
Diff: http://git-wip-us.apache.org/repos/asf/aurora/diff/297ebc15

Branch: refs/heads/master
Commit: 297ebc157f81c6719fdb74967cc4af59a08cc6ea
Parents: 4a9f2ff
Author: Stephan Erb <st...@dev.static-void.de>
Authored: Sun Jan 3 09:36:36 2016 -0800
Committer: Bill Farner <wf...@apache.org>
Committed: Sun Jan 3 09:36:36 2016 -0800

----------------------------------------------------------------------
 docs/README.md           |  1 +
 docs/design-documents.md | 17 +++++++++++++++++
 2 files changed, 18 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/aurora/blob/297ebc15/docs/README.md
----------------------------------------------------------------------
diff --git a/docs/README.md b/docs/README.md
index 1312d70..55dc4db 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -34,6 +34,7 @@ We encourage you to ask questions on the [Aurora developer list](http://aurora.a
  * [Developing the Aurora Scheduler](developing-aurora-scheduler.md)
  * [Developing the Aurora Client](developing-aurora-client.md)
  * [Committers Guide](committers.md)
+ * [Design Documents](design-documents.md)
  * [Deprecation Guide](thrift-deprecation.md)
  * [Build System](build-system.md)
  * [Generating test resources](test-resource-generation.md)

http://git-wip-us.apache.org/repos/asf/aurora/blob/297ebc15/docs/design-documents.md
----------------------------------------------------------------------
diff --git a/docs/design-documents.md b/docs/design-documents.md
new file mode 100644
index 0000000..71d6c4c
--- /dev/null
+++ b/docs/design-documents.md
@@ -0,0 +1,17 @@
+# Design Documents
+
+Since its inception as an Apache project, larger feature additions to the
+Aurora code base are discussed in form of design documents. Design documents
+are living documents until a consensus has been reached to implement a feature
+in the proposed form.
+
+Current and past documents:
+
+* [Command Hooks for the Aurora Client](design/command-hooks.md)
+* [Health Checks for Updates](https://docs.google.com/document/d/1ZdgW8S4xMhvKW7iQUX99xZm10NXSxEWR0a-21FP5d94/edit)
+* [JobUpdateDiff thrift API](https://docs.google.com/document/d/1Fc_YhhV7fc4D9Xv6gJzpfooxbK4YWZcvzw6Bd3qVTL8/edit)
+* [REST API RFC](https://docs.google.com/document/d/11_lAsYIRlD5ETRzF2eSd3oa8LXAHYFD8rSetspYXaf4/edit)
+* [Revocable Mesos offers in Aurora](https://docs.google.com/document/d/1r1WCHgmPJp5wbrqSZLsgtxPNj3sULfHrSFmxp2GyPTo/edit)
+* [Ubiquitous Jobs](https://docs.google.com/document/d/12hr6GnUZU3mc7xsWRzMi3nQILGB-3vyUxvbG-6YmvdE/edit)
+
+Design documents can be found in the Aurora issue tracker via the query [`project = AURORA AND text ~ "docs.google.com" ORDER BY created`](https://issues.apache.org/jira/browse/AURORA-1528?jql=project%20%3D%20AURORA%20AND%20text%20~%20%22docs.google.com%22%20ORDER%20BY%20created).