You are viewing a plain text version of this content. The canonical link for it is here.
Posted to reviews@aurora.apache.org by Stephan Erb <se...@apache.org> on 2016/03/28 20:12:57 UTC
Review Request 45392: Reorganize Documentation
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/45392/
-----------------------------------------------------------
Review request for Aurora, John Sirois and Bill Farner.
Repository: aurora
Description
-------
This started as a spike to structure the documentation in a way that makes it more approachable. In addition, I believe the new structure will allow us to extend and improve the documentation more easily, as the different sections have more room to grow into something useful (eg. service discovery).
The new structure was inspired by the documentation of Hubspot's Singularity scheduler. What I have done was mostly to cut & paste documentation and code examples and embedded those into the following:
* getting-started: the most basic information for all users
* features: proper explanation of our most important features. This should make it much easier for people to discover Aurora's unique selling points.
* operators: stuff only the operatos will care about
* developers: stuff only contributors and committers acare about.
* references: the details.
The diff is almost impossible review as I was not very diligent in keeping it clean. Sorry for that. If you believe this is unacceptable, we can move to a more piecewise review.
Diffs
-----
README.md e2b5632d42129d448d4fc237da9d939ca9dd564c
docs/README.md 673c854825a0443a3bc7b13c04640dd85ad147f5
docs/build-system.md 39c231dc9e222ebf409280199fe12d75449157fe
docs/client-cluster-configuration.md 88b9d772c9140178cd195875136408399e0ee52b
docs/client-commands.md 156fe4cf2462735218bcdc80655ce3ec5e9cd4f5
docs/committers.md f69a898d434abb0295e68682e290bc3f966d3654
docs/configuration-reference.md 7bcf22d6ec8266568a1e3692fdbc451a58388967
docs/configuration-tutorial.md 97664f39a5b2fce8c4829d5ba1c3ec7f4b8fc63b
docs/cron-jobs.md 0f9842529ad075c9fbd153a13c2b07c94c391052
docs/deploying-aurora-scheduler.md 03bfdbab927c924486b04c42df2ad236c0f414a0
docs/design-documents.md 4d14caa4dde1a48d8d90b6b7c9104efd629d715c
docs/design/command-hooks.md
docs/developing-aurora-client.md 27f1c97c1b7c199c1c496e11ef8995ca3b1b437c
docs/developing-aurora-scheduler.md a703871a68b51e43cb51379df0856911dbe91c8b
docs/development/thermos.md PRE-CREATION
docs/development/ui.md PRE-CREATION
docs/features/constraints.md PRE-CREATION
docs/features/containers.md PRE-CREATION
docs/features/job-updates.md PRE-CREATION
docs/features/multitenancy.md PRE-CREATION
docs/features/service-discovery.md PRE-CREATION
docs/features/services.md PRE-CREATION
docs/getting-started/overview.md PRE-CREATION
docs/hooks.md 28307ab3d45721ccc97a3d01148129c22d1f1998
docs/installing.md 5cc153ab8c7c8043efd07a7cb9fa44c84e31a7a8
docs/monitoring.md
docs/operations/configuration.md PRE-CREATION
docs/presentations.md 84756a24e258a38cebad1dac7c6e51f7d6d187bd
docs/reference/configuration-best-practices.md PRE-CREATION
docs/reference/configuration-templating.md PRE-CREATION
docs/reference/configuration-tutorial.md PRE-CREATION
docs/reference/scheduler-configuration.md PRE-CREATION
docs/resources.md 27a267828d8222623ae77e084e1d5f602075838e
docs/scheduler-configuration.md 7e3d801251262a5eedbca8890316aa9f44be8314
docs/security.md 32bea426fbceec83187e851a5db11e82df55e962
docs/sla.md a558e0098e73172801d9fad927f1f85d0476413f
docs/storage-config.md 7c6484183ce88eca6ab1a25805c86af1fcd64ee1
docs/storage.md 6ffed541d1579a8131ce642b082be602431329d3
docs/task-lifecycle.md 5d6456cb6647acb2c2c0f9024c744e37ccc55d1c
docs/test-resource-generation.md e78e742542508389e8161d00ee0e4ddb7084e72d
docs/thrift-deprecation.md 62a71bcf10704c92fd26a8fd74729a8dc51b988c
docs/tools.md 2ae550db35835ac2ebe5a95dbcc18e86d7bc4642
docs/tutorial.md 95539ef299792068de2ad9d38b39d66e162fbc21
docs/user-guide.md 656296cc84622d44d6dd43fc1496496da15b5d08
docs/vagrant.md 3bc201f17977dbc402eeac307500db5cc9d6bb27
Diff: https://reviews.apache.org/r/45392/diff/
Testing
-------
Rendered version available at: https://github.com/StephanErb/aurora/tree/userguide_docu/docs
Thanks,
Stephan Erb
Re: Review Request 45392: Reorganize Documentation
Posted by Steve Niemitz <sn...@twitter.com>.
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/45392/#review125734
-----------------------------------------------------------
Ship it!
Ship It!
- Steve Niemitz
On March 28, 2016, 6:12 p.m., Stephan Erb wrote:
>
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/45392/
> -----------------------------------------------------------
>
> (Updated March 28, 2016, 6:12 p.m.)
>
>
> Review request for Aurora, John Sirois and Bill Farner.
>
>
> Repository: aurora
>
>
> Description
> -------
>
> This started as a spike to structure the documentation in a way that makes it more approachable. In addition, I believe the new structure will allow us to extend and improve the documentation more easily, as the different sections have more room to grow into something useful (eg. service discovery).
>
> The new structure was inspired by the documentation of Hubspot's Singularity scheduler. What I have done was mostly to cut & paste documentation and code examples and embedded those into the following:
>
> * getting-started: the most basic information for all users
> * features: proper explanation of our most important features. This should make it much easier for people to discover Aurora's unique selling points.
> * operators: stuff only the operatos will care about
> * developers: stuff only contributors and committers acare about.
> * references: the details.
>
> The diff is almost impossible review as I was not very diligent in keeping it clean. Sorry for that. If you believe this is unacceptable, we can move to a more piecewise review.
>
>
> Diffs
> -----
>
> README.md e2b5632d42129d448d4fc237da9d939ca9dd564c
> docs/README.md 673c854825a0443a3bc7b13c04640dd85ad147f5
> docs/build-system.md 39c231dc9e222ebf409280199fe12d75449157fe
> docs/client-cluster-configuration.md 88b9d772c9140178cd195875136408399e0ee52b
> docs/client-commands.md 156fe4cf2462735218bcdc80655ce3ec5e9cd4f5
> docs/committers.md f69a898d434abb0295e68682e290bc3f966d3654
> docs/configuration-reference.md 7bcf22d6ec8266568a1e3692fdbc451a58388967
> docs/configuration-tutorial.md 97664f39a5b2fce8c4829d5ba1c3ec7f4b8fc63b
> docs/cron-jobs.md 0f9842529ad075c9fbd153a13c2b07c94c391052
> docs/deploying-aurora-scheduler.md 03bfdbab927c924486b04c42df2ad236c0f414a0
> docs/design-documents.md 4d14caa4dde1a48d8d90b6b7c9104efd629d715c
> docs/design/command-hooks.md
> docs/developing-aurora-client.md 27f1c97c1b7c199c1c496e11ef8995ca3b1b437c
> docs/developing-aurora-scheduler.md a703871a68b51e43cb51379df0856911dbe91c8b
> docs/development/thermos.md PRE-CREATION
> docs/development/ui.md PRE-CREATION
> docs/features/constraints.md PRE-CREATION
> docs/features/containers.md PRE-CREATION
> docs/features/job-updates.md PRE-CREATION
> docs/features/multitenancy.md PRE-CREATION
> docs/features/service-discovery.md PRE-CREATION
> docs/features/services.md PRE-CREATION
> docs/getting-started/overview.md PRE-CREATION
> docs/hooks.md 28307ab3d45721ccc97a3d01148129c22d1f1998
> docs/installing.md 5cc153ab8c7c8043efd07a7cb9fa44c84e31a7a8
> docs/monitoring.md
> docs/operations/configuration.md PRE-CREATION
> docs/presentations.md 84756a24e258a38cebad1dac7c6e51f7d6d187bd
> docs/reference/configuration-best-practices.md PRE-CREATION
> docs/reference/configuration-templating.md PRE-CREATION
> docs/reference/configuration-tutorial.md PRE-CREATION
> docs/reference/scheduler-configuration.md PRE-CREATION
> docs/resources.md 27a267828d8222623ae77e084e1d5f602075838e
> docs/scheduler-configuration.md 7e3d801251262a5eedbca8890316aa9f44be8314
> docs/security.md 32bea426fbceec83187e851a5db11e82df55e962
> docs/sla.md a558e0098e73172801d9fad927f1f85d0476413f
> docs/storage-config.md 7c6484183ce88eca6ab1a25805c86af1fcd64ee1
> docs/storage.md 6ffed541d1579a8131ce642b082be602431329d3
> docs/task-lifecycle.md 5d6456cb6647acb2c2c0f9024c744e37ccc55d1c
> docs/test-resource-generation.md e78e742542508389e8161d00ee0e4ddb7084e72d
> docs/thrift-deprecation.md 62a71bcf10704c92fd26a8fd74729a8dc51b988c
> docs/tools.md 2ae550db35835ac2ebe5a95dbcc18e86d7bc4642
> docs/tutorial.md 95539ef299792068de2ad9d38b39d66e162fbc21
> docs/user-guide.md 656296cc84622d44d6dd43fc1496496da15b5d08
> docs/vagrant.md 3bc201f17977dbc402eeac307500db5cc9d6bb27
>
> Diff: https://reviews.apache.org/r/45392/diff/
>
>
> Testing
> -------
>
> Rendered version available at: https://github.com/StephanErb/aurora/tree/userguide_docu/docs
>
>
> Thanks,
>
> Stephan Erb
>
>
Re: Review Request 45392: Reorganize Documentation
Posted by Aurora ReviewBot <wf...@apache.org>.
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/45392/#review125717
-----------------------------------------------------------
Master (0950095) is red with this patch.
./build-support/jenkins/build.sh
[1m proxy_driver = ProxyDriver()[0m
[1m with temporary_dir() as checkpoint_root:[0m
[1m te = AuroraExecutor([0m
[1m> runner_provider=make_provider(checkpoint_root),[0m
[1m sandbox_provider=DefaultTestSandboxProvider())[0m
src/test/python/apache/aurora/executor/test_thermos_executor.py:580:
_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _
src/test/python/apache/aurora/executor/test_thermos_executor.py:193: in make_provider
[1m pex_location=thermos_runner_path(),[0m
_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _
build = True
[1m def thermos_runner_path(build=True):[0m
[1m if not build:[0m
[1m return getattr(thermos_runner_path, 'value', None)[0m
[1m [0m
[1m if not hasattr(thermos_runner_path, 'value'):[0m
[1m pex_dir = safe_mkdtemp()[0m
[1m> assert subprocess.call(["./pants", "--pants-distdir=%s" % pex_dir, "binary",[0m
[1m "src/main/python/apache/thermos/runner:thermos_runner"]) == 0[0m
[1m[31mE assert 1 == 0[0m
[1m[31mE + where 1 = <function call at 0x7f30d171d938>(['./pants', '--pants-distdir=/tmp/user/10021/tmpkBRWbA', 'binary', 'src/main/python/apache/thermos/runner:thermos_runner'])[0m
[1m[31mE + where <function call at 0x7f30d171d938> = subprocess.call[0m
src/test/python/apache/aurora/executor/test_thermos_executor.py:185: AssertionError
-------------- Captured stderr call --------------
Traceback (most recent call last):
File "/home/jenkins/.cache/pants/setup/bootstrap-Linux-x86_64/0.0.75/bin/pants", line 7, in <module>
from pants.bin.pants_exe import main
ImportError: No module named pants.bin.pants_exe
generated xml file: /home/jenkins/jenkins-slave/workspace/AuroraBot/dist/test-results/415337499eb72578eab327a6487c1f5c9452b3d6.xml
[1m[31m 16 failed, 640 passed, 5 skipped, 1 warnings, 8 error in 340.94 seconds [0m
FAILURE
19:17:54 08:57 [complete][31m
FAILURE[0m
I will refresh this build result if you post a review containing "@ReviewBot retry"
- Aurora ReviewBot
On March 28, 2016, 6:12 p.m., Stephan Erb wrote:
>
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/45392/
> -----------------------------------------------------------
>
> (Updated March 28, 2016, 6:12 p.m.)
>
>
> Review request for Aurora, John Sirois and Bill Farner.
>
>
> Repository: aurora
>
>
> Description
> -------
>
> This started as a spike to structure the documentation in a way that makes it more approachable. In addition, I believe the new structure will allow us to extend and improve the documentation more easily, as the different sections have more room to grow into something useful (eg. service discovery).
>
> The new structure was inspired by the documentation of Hubspot's Singularity scheduler. What I have done was mostly to cut & paste documentation and code examples and embedded those into the following:
>
> * getting-started: the most basic information for all users
> * features: proper explanation of our most important features. This should make it much easier for people to discover Aurora's unique selling points.
> * operators: stuff only the operatos will care about
> * developers: stuff only contributors and committers acare about.
> * references: the details.
>
> The diff is almost impossible review as I was not very diligent in keeping it clean. Sorry for that. If you believe this is unacceptable, we can move to a more piecewise review.
>
>
> Diffs
> -----
>
> README.md e2b5632d42129d448d4fc237da9d939ca9dd564c
> docs/README.md 673c854825a0443a3bc7b13c04640dd85ad147f5
> docs/build-system.md 39c231dc9e222ebf409280199fe12d75449157fe
> docs/client-cluster-configuration.md 88b9d772c9140178cd195875136408399e0ee52b
> docs/client-commands.md 156fe4cf2462735218bcdc80655ce3ec5e9cd4f5
> docs/committers.md f69a898d434abb0295e68682e290bc3f966d3654
> docs/configuration-reference.md 7bcf22d6ec8266568a1e3692fdbc451a58388967
> docs/configuration-tutorial.md 97664f39a5b2fce8c4829d5ba1c3ec7f4b8fc63b
> docs/cron-jobs.md 0f9842529ad075c9fbd153a13c2b07c94c391052
> docs/deploying-aurora-scheduler.md 03bfdbab927c924486b04c42df2ad236c0f414a0
> docs/design-documents.md 4d14caa4dde1a48d8d90b6b7c9104efd629d715c
> docs/design/command-hooks.md
> docs/developing-aurora-client.md 27f1c97c1b7c199c1c496e11ef8995ca3b1b437c
> docs/developing-aurora-scheduler.md a703871a68b51e43cb51379df0856911dbe91c8b
> docs/development/thermos.md PRE-CREATION
> docs/development/ui.md PRE-CREATION
> docs/features/constraints.md PRE-CREATION
> docs/features/containers.md PRE-CREATION
> docs/features/job-updates.md PRE-CREATION
> docs/features/multitenancy.md PRE-CREATION
> docs/features/service-discovery.md PRE-CREATION
> docs/features/services.md PRE-CREATION
> docs/getting-started/overview.md PRE-CREATION
> docs/hooks.md 28307ab3d45721ccc97a3d01148129c22d1f1998
> docs/installing.md 5cc153ab8c7c8043efd07a7cb9fa44c84e31a7a8
> docs/monitoring.md
> docs/operations/configuration.md PRE-CREATION
> docs/presentations.md 84756a24e258a38cebad1dac7c6e51f7d6d187bd
> docs/reference/configuration-best-practices.md PRE-CREATION
> docs/reference/configuration-templating.md PRE-CREATION
> docs/reference/configuration-tutorial.md PRE-CREATION
> docs/reference/scheduler-configuration.md PRE-CREATION
> docs/resources.md 27a267828d8222623ae77e084e1d5f602075838e
> docs/scheduler-configuration.md 7e3d801251262a5eedbca8890316aa9f44be8314
> docs/security.md 32bea426fbceec83187e851a5db11e82df55e962
> docs/sla.md a558e0098e73172801d9fad927f1f85d0476413f
> docs/storage-config.md 7c6484183ce88eca6ab1a25805c86af1fcd64ee1
> docs/storage.md 6ffed541d1579a8131ce642b082be602431329d3
> docs/task-lifecycle.md 5d6456cb6647acb2c2c0f9024c744e37ccc55d1c
> docs/test-resource-generation.md e78e742542508389e8161d00ee0e4ddb7084e72d
> docs/thrift-deprecation.md 62a71bcf10704c92fd26a8fd74729a8dc51b988c
> docs/tools.md 2ae550db35835ac2ebe5a95dbcc18e86d7bc4642
> docs/tutorial.md 95539ef299792068de2ad9d38b39d66e162fbc21
> docs/user-guide.md 656296cc84622d44d6dd43fc1496496da15b5d08
> docs/vagrant.md 3bc201f17977dbc402eeac307500db5cc9d6bb27
>
> Diff: https://reviews.apache.org/r/45392/diff/
>
>
> Testing
> -------
>
> Rendered version available at: https://github.com/StephanErb/aurora/tree/userguide_docu/docs
>
>
> Thanks,
>
> Stephan Erb
>
>
Re: Review Request 45392: Reorganize Documentation
Posted by Stephan Erb <se...@apache.org>.
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/45392/#review125730
-----------------------------------------------------------
@ReviewBot retry
- Stephan Erb
On March 28, 2016, 8:12 p.m., Stephan Erb wrote:
>
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/45392/
> -----------------------------------------------------------
>
> (Updated March 28, 2016, 8:12 p.m.)
>
>
> Review request for Aurora, John Sirois and Bill Farner.
>
>
> Repository: aurora
>
>
> Description
> -------
>
> This started as a spike to structure the documentation in a way that makes it more approachable. In addition, I believe the new structure will allow us to extend and improve the documentation more easily, as the different sections have more room to grow into something useful (eg. service discovery).
>
> The new structure was inspired by the documentation of Hubspot's Singularity scheduler. What I have done was mostly to cut & paste documentation and code examples and embedded those into the following:
>
> * getting-started: the most basic information for all users
> * features: proper explanation of our most important features. This should make it much easier for people to discover Aurora's unique selling points.
> * operators: stuff only the operatos will care about
> * developers: stuff only contributors and committers acare about.
> * references: the details.
>
> The diff is almost impossible review as I was not very diligent in keeping it clean. Sorry for that. If you believe this is unacceptable, we can move to a more piecewise review.
>
>
> Diffs
> -----
>
> README.md e2b5632d42129d448d4fc237da9d939ca9dd564c
> docs/README.md 673c854825a0443a3bc7b13c04640dd85ad147f5
> docs/build-system.md 39c231dc9e222ebf409280199fe12d75449157fe
> docs/client-cluster-configuration.md 88b9d772c9140178cd195875136408399e0ee52b
> docs/client-commands.md 156fe4cf2462735218bcdc80655ce3ec5e9cd4f5
> docs/committers.md f69a898d434abb0295e68682e290bc3f966d3654
> docs/configuration-reference.md 7bcf22d6ec8266568a1e3692fdbc451a58388967
> docs/configuration-tutorial.md 97664f39a5b2fce8c4829d5ba1c3ec7f4b8fc63b
> docs/cron-jobs.md 0f9842529ad075c9fbd153a13c2b07c94c391052
> docs/deploying-aurora-scheduler.md 03bfdbab927c924486b04c42df2ad236c0f414a0
> docs/design-documents.md 4d14caa4dde1a48d8d90b6b7c9104efd629d715c
> docs/design/command-hooks.md
> docs/developing-aurora-client.md 27f1c97c1b7c199c1c496e11ef8995ca3b1b437c
> docs/developing-aurora-scheduler.md a703871a68b51e43cb51379df0856911dbe91c8b
> docs/development/thermos.md PRE-CREATION
> docs/development/ui.md PRE-CREATION
> docs/features/constraints.md PRE-CREATION
> docs/features/containers.md PRE-CREATION
> docs/features/job-updates.md PRE-CREATION
> docs/features/multitenancy.md PRE-CREATION
> docs/features/service-discovery.md PRE-CREATION
> docs/features/services.md PRE-CREATION
> docs/getting-started/overview.md PRE-CREATION
> docs/hooks.md 28307ab3d45721ccc97a3d01148129c22d1f1998
> docs/installing.md 5cc153ab8c7c8043efd07a7cb9fa44c84e31a7a8
> docs/monitoring.md
> docs/operations/configuration.md PRE-CREATION
> docs/presentations.md 84756a24e258a38cebad1dac7c6e51f7d6d187bd
> docs/reference/configuration-best-practices.md PRE-CREATION
> docs/reference/configuration-templating.md PRE-CREATION
> docs/reference/configuration-tutorial.md PRE-CREATION
> docs/reference/scheduler-configuration.md PRE-CREATION
> docs/resources.md 27a267828d8222623ae77e084e1d5f602075838e
> docs/scheduler-configuration.md 7e3d801251262a5eedbca8890316aa9f44be8314
> docs/security.md 32bea426fbceec83187e851a5db11e82df55e962
> docs/sla.md a558e0098e73172801d9fad927f1f85d0476413f
> docs/storage-config.md 7c6484183ce88eca6ab1a25805c86af1fcd64ee1
> docs/storage.md 6ffed541d1579a8131ce642b082be602431329d3
> docs/task-lifecycle.md 5d6456cb6647acb2c2c0f9024c744e37ccc55d1c
> docs/test-resource-generation.md e78e742542508389e8161d00ee0e4ddb7084e72d
> docs/thrift-deprecation.md 62a71bcf10704c92fd26a8fd74729a8dc51b988c
> docs/tools.md 2ae550db35835ac2ebe5a95dbcc18e86d7bc4642
> docs/tutorial.md 95539ef299792068de2ad9d38b39d66e162fbc21
> docs/user-guide.md 656296cc84622d44d6dd43fc1496496da15b5d08
> docs/vagrant.md 3bc201f17977dbc402eeac307500db5cc9d6bb27
>
> Diff: https://reviews.apache.org/r/45392/diff/
>
>
> Testing
> -------
>
> Rendered version available at: https://github.com/StephanErb/aurora/tree/userguide_docu/docs
>
>
> Thanks,
>
> Stephan Erb
>
>
Re: Review Request 45392: Reorganize Documentation
Posted by Aurora ReviewBot <wf...@apache.org>.
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/45392/#review125742
-----------------------------------------------------------
Ship it!
Master (0950095) is green with this patch.
./build-support/jenkins/build.sh
I will refresh this build result if you post a review containing "@ReviewBot retry"
- Aurora ReviewBot
On March 28, 2016, 6:12 p.m., Stephan Erb wrote:
>
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/45392/
> -----------------------------------------------------------
>
> (Updated March 28, 2016, 6:12 p.m.)
>
>
> Review request for Aurora, John Sirois and Bill Farner.
>
>
> Repository: aurora
>
>
> Description
> -------
>
> This started as a spike to structure the documentation in a way that makes it more approachable. In addition, I believe the new structure will allow us to extend and improve the documentation more easily, as the different sections have more room to grow into something useful (eg. service discovery).
>
> The new structure was inspired by the documentation of Hubspot's Singularity scheduler. What I have done was mostly to cut & paste documentation and code examples and embedded those into the following:
>
> * getting-started: the most basic information for all users
> * features: proper explanation of our most important features. This should make it much easier for people to discover Aurora's unique selling points.
> * operators: stuff only the operatos will care about
> * developers: stuff only contributors and committers acare about.
> * references: the details.
>
> The diff is almost impossible review as I was not very diligent in keeping it clean. Sorry for that. If you believe this is unacceptable, we can move to a more piecewise review.
>
>
> Diffs
> -----
>
> README.md e2b5632d42129d448d4fc237da9d939ca9dd564c
> docs/README.md 673c854825a0443a3bc7b13c04640dd85ad147f5
> docs/build-system.md 39c231dc9e222ebf409280199fe12d75449157fe
> docs/client-cluster-configuration.md 88b9d772c9140178cd195875136408399e0ee52b
> docs/client-commands.md 156fe4cf2462735218bcdc80655ce3ec5e9cd4f5
> docs/committers.md f69a898d434abb0295e68682e290bc3f966d3654
> docs/configuration-reference.md 7bcf22d6ec8266568a1e3692fdbc451a58388967
> docs/configuration-tutorial.md 97664f39a5b2fce8c4829d5ba1c3ec7f4b8fc63b
> docs/cron-jobs.md 0f9842529ad075c9fbd153a13c2b07c94c391052
> docs/deploying-aurora-scheduler.md 03bfdbab927c924486b04c42df2ad236c0f414a0
> docs/design-documents.md 4d14caa4dde1a48d8d90b6b7c9104efd629d715c
> docs/design/command-hooks.md
> docs/developing-aurora-client.md 27f1c97c1b7c199c1c496e11ef8995ca3b1b437c
> docs/developing-aurora-scheduler.md a703871a68b51e43cb51379df0856911dbe91c8b
> docs/development/thermos.md PRE-CREATION
> docs/development/ui.md PRE-CREATION
> docs/features/constraints.md PRE-CREATION
> docs/features/containers.md PRE-CREATION
> docs/features/job-updates.md PRE-CREATION
> docs/features/multitenancy.md PRE-CREATION
> docs/features/service-discovery.md PRE-CREATION
> docs/features/services.md PRE-CREATION
> docs/getting-started/overview.md PRE-CREATION
> docs/hooks.md 28307ab3d45721ccc97a3d01148129c22d1f1998
> docs/installing.md 5cc153ab8c7c8043efd07a7cb9fa44c84e31a7a8
> docs/monitoring.md
> docs/operations/configuration.md PRE-CREATION
> docs/presentations.md 84756a24e258a38cebad1dac7c6e51f7d6d187bd
> docs/reference/configuration-best-practices.md PRE-CREATION
> docs/reference/configuration-templating.md PRE-CREATION
> docs/reference/configuration-tutorial.md PRE-CREATION
> docs/reference/scheduler-configuration.md PRE-CREATION
> docs/resources.md 27a267828d8222623ae77e084e1d5f602075838e
> docs/scheduler-configuration.md 7e3d801251262a5eedbca8890316aa9f44be8314
> docs/security.md 32bea426fbceec83187e851a5db11e82df55e962
> docs/sla.md a558e0098e73172801d9fad927f1f85d0476413f
> docs/storage-config.md 7c6484183ce88eca6ab1a25805c86af1fcd64ee1
> docs/storage.md 6ffed541d1579a8131ce642b082be602431329d3
> docs/task-lifecycle.md 5d6456cb6647acb2c2c0f9024c744e37ccc55d1c
> docs/test-resource-generation.md e78e742542508389e8161d00ee0e4ddb7084e72d
> docs/thrift-deprecation.md 62a71bcf10704c92fd26a8fd74729a8dc51b988c
> docs/tools.md 2ae550db35835ac2ebe5a95dbcc18e86d7bc4642
> docs/tutorial.md 95539ef299792068de2ad9d38b39d66e162fbc21
> docs/user-guide.md 656296cc84622d44d6dd43fc1496496da15b5d08
> docs/vagrant.md 3bc201f17977dbc402eeac307500db5cc9d6bb27
>
> Diff: https://reviews.apache.org/r/45392/diff/
>
>
> Testing
> -------
>
> Rendered version available at: https://github.com/StephanErb/aurora/tree/userguide_docu/docs
>
>
> Thanks,
>
> Stephan Erb
>
>
Re: Review Request 45392: Reorganize Documentation
Posted by Stephan Erb <se...@apache.org>.
> On March 28, 2016, 10:10 p.m., Bill Farner wrote:
> > docs/installing.md, line 115
> > <https://reviews.apache.org/r/45392/diff/1/?file=1316911#file1316911line115>
> >
> > I'm not a fan of the syntax, but the trailing WS here is necessary to force a line break. Feel free to reformat (e.g. add another line break in the .md) to remove the need for the trailing WS though.
> >
> > You can see the difference here.
> > https://github.com/apache/aurora/blob/master/docs/installing.md#centos-7-1
> >
> > https://github.com/StephanErb/aurora/blob/userguide_docu/docs/operations/installation.md#centos-7
Good catch. I've added this to the list of minor glitches that need fixing. Will have that pull request ready in a day or two.
- Stephan
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/45392/#review125731
-----------------------------------------------------------
On March 28, 2016, 10:50 p.m., Stephan Erb wrote:
>
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/45392/
> -----------------------------------------------------------
>
> (Updated March 28, 2016, 10:50 p.m.)
>
>
> Review request for Aurora, Steve Niemitz and Bill Farner.
>
>
> Repository: aurora
>
>
> Description
> -------
>
> This started as a spike to structure the documentation in a way that makes it more approachable. In addition, I believe the new structure will allow us to extend and improve the documentation more easily, as the different sections have more room to grow into something useful (eg. service discovery).
>
> The new structure was inspired by the documentation of Hubspot's Singularity scheduler. What I have done was mostly to cut & paste documentation and code examples and embedded those into the following:
>
> * getting-started: the most basic information for all users
> * features: proper explanation of our most important features. This should make it much easier for people to discover Aurora's unique selling points.
> * operators: stuff only the operatos will care about
> * developers: stuff only contributors and committers acare about.
> * references: the details.
>
> The diff is almost impossible review as I was not very diligent in keeping it clean. Sorry for that. If you believe this is unacceptable, we can move to a more piecewise review.
>
>
> Diffs
> -----
>
> README.md e2b5632d42129d448d4fc237da9d939ca9dd564c
> docs/README.md 673c854825a0443a3bc7b13c04640dd85ad147f5
> docs/build-system.md 39c231dc9e222ebf409280199fe12d75449157fe
> docs/client-cluster-configuration.md 88b9d772c9140178cd195875136408399e0ee52b
> docs/client-commands.md 156fe4cf2462735218bcdc80655ce3ec5e9cd4f5
> docs/committers.md f69a898d434abb0295e68682e290bc3f966d3654
> docs/configuration-reference.md 7bcf22d6ec8266568a1e3692fdbc451a58388967
> docs/configuration-tutorial.md 97664f39a5b2fce8c4829d5ba1c3ec7f4b8fc63b
> docs/cron-jobs.md 0f9842529ad075c9fbd153a13c2b07c94c391052
> docs/deploying-aurora-scheduler.md 03bfdbab927c924486b04c42df2ad236c0f414a0
> docs/design-documents.md 4d14caa4dde1a48d8d90b6b7c9104efd629d715c
> docs/design/command-hooks.md
> docs/developing-aurora-client.md 27f1c97c1b7c199c1c496e11ef8995ca3b1b437c
> docs/developing-aurora-scheduler.md a703871a68b51e43cb51379df0856911dbe91c8b
> docs/development/thermos.md PRE-CREATION
> docs/development/ui.md PRE-CREATION
> docs/features/constraints.md PRE-CREATION
> docs/features/containers.md PRE-CREATION
> docs/features/job-updates.md PRE-CREATION
> docs/features/multitenancy.md PRE-CREATION
> docs/features/service-discovery.md PRE-CREATION
> docs/features/services.md PRE-CREATION
> docs/getting-started/overview.md PRE-CREATION
> docs/hooks.md 28307ab3d45721ccc97a3d01148129c22d1f1998
> docs/installing.md 5cc153ab8c7c8043efd07a7cb9fa44c84e31a7a8
> docs/monitoring.md
> docs/operations/configuration.md PRE-CREATION
> docs/presentations.md 84756a24e258a38cebad1dac7c6e51f7d6d187bd
> docs/reference/configuration-best-practices.md PRE-CREATION
> docs/reference/configuration-templating.md PRE-CREATION
> docs/reference/configuration-tutorial.md PRE-CREATION
> docs/reference/scheduler-configuration.md PRE-CREATION
> docs/resources.md 27a267828d8222623ae77e084e1d5f602075838e
> docs/scheduler-configuration.md 7e3d801251262a5eedbca8890316aa9f44be8314
> docs/security.md 32bea426fbceec83187e851a5db11e82df55e962
> docs/sla.md a558e0098e73172801d9fad927f1f85d0476413f
> docs/storage-config.md 7c6484183ce88eca6ab1a25805c86af1fcd64ee1
> docs/storage.md 6ffed541d1579a8131ce642b082be602431329d3
> docs/task-lifecycle.md 5d6456cb6647acb2c2c0f9024c744e37ccc55d1c
> docs/test-resource-generation.md e78e742542508389e8161d00ee0e4ddb7084e72d
> docs/thrift-deprecation.md 62a71bcf10704c92fd26a8fd74729a8dc51b988c
> docs/tools.md 2ae550db35835ac2ebe5a95dbcc18e86d7bc4642
> docs/tutorial.md 95539ef299792068de2ad9d38b39d66e162fbc21
> docs/user-guide.md 656296cc84622d44d6dd43fc1496496da15b5d08
> docs/vagrant.md 3bc201f17977dbc402eeac307500db5cc9d6bb27
>
> Diff: https://reviews.apache.org/r/45392/diff/
>
>
> Testing
> -------
>
> Rendered version available at: https://github.com/StephanErb/aurora/tree/userguide_docu/docs
>
>
> Thanks,
>
> Stephan Erb
>
>
Re: Review Request 45392: Reorganize Documentation
Posted by Bill Farner <wf...@apache.org>.
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/45392/#review125731
-----------------------------------------------------------
Ship it!
Wow! This is a huge leap in the right direction. Thank you!
docs/installing.md (line 47)
<https://reviews.apache.org/r/45392/#comment188583>
I'm not a fan of the syntax, but the trailing WS here is necessary to force a line break. Feel free to reformat (e.g. add another line break in the .md) to remove the need for the trailing WS though.
You can see the difference here.
https://github.com/apache/aurora/blob/master/docs/installing.md#centos-7-1
https://github.com/StephanErb/aurora/blob/userguide_docu/docs/operations/installation.md#centos-7
- Bill Farner
On March 28, 2016, 11:12 a.m., Stephan Erb wrote:
>
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/45392/
> -----------------------------------------------------------
>
> (Updated March 28, 2016, 11:12 a.m.)
>
>
> Review request for Aurora, John Sirois and Bill Farner.
>
>
> Repository: aurora
>
>
> Description
> -------
>
> This started as a spike to structure the documentation in a way that makes it more approachable. In addition, I believe the new structure will allow us to extend and improve the documentation more easily, as the different sections have more room to grow into something useful (eg. service discovery).
>
> The new structure was inspired by the documentation of Hubspot's Singularity scheduler. What I have done was mostly to cut & paste documentation and code examples and embedded those into the following:
>
> * getting-started: the most basic information for all users
> * features: proper explanation of our most important features. This should make it much easier for people to discover Aurora's unique selling points.
> * operators: stuff only the operatos will care about
> * developers: stuff only contributors and committers acare about.
> * references: the details.
>
> The diff is almost impossible review as I was not very diligent in keeping it clean. Sorry for that. If you believe this is unacceptable, we can move to a more piecewise review.
>
>
> Diffs
> -----
>
> README.md e2b5632d42129d448d4fc237da9d939ca9dd564c
> docs/README.md 673c854825a0443a3bc7b13c04640dd85ad147f5
> docs/build-system.md 39c231dc9e222ebf409280199fe12d75449157fe
> docs/client-cluster-configuration.md 88b9d772c9140178cd195875136408399e0ee52b
> docs/client-commands.md 156fe4cf2462735218bcdc80655ce3ec5e9cd4f5
> docs/committers.md f69a898d434abb0295e68682e290bc3f966d3654
> docs/configuration-reference.md 7bcf22d6ec8266568a1e3692fdbc451a58388967
> docs/configuration-tutorial.md 97664f39a5b2fce8c4829d5ba1c3ec7f4b8fc63b
> docs/cron-jobs.md 0f9842529ad075c9fbd153a13c2b07c94c391052
> docs/deploying-aurora-scheduler.md 03bfdbab927c924486b04c42df2ad236c0f414a0
> docs/design-documents.md 4d14caa4dde1a48d8d90b6b7c9104efd629d715c
> docs/design/command-hooks.md
> docs/developing-aurora-client.md 27f1c97c1b7c199c1c496e11ef8995ca3b1b437c
> docs/developing-aurora-scheduler.md a703871a68b51e43cb51379df0856911dbe91c8b
> docs/development/thermos.md PRE-CREATION
> docs/development/ui.md PRE-CREATION
> docs/features/constraints.md PRE-CREATION
> docs/features/containers.md PRE-CREATION
> docs/features/job-updates.md PRE-CREATION
> docs/features/multitenancy.md PRE-CREATION
> docs/features/service-discovery.md PRE-CREATION
> docs/features/services.md PRE-CREATION
> docs/getting-started/overview.md PRE-CREATION
> docs/hooks.md 28307ab3d45721ccc97a3d01148129c22d1f1998
> docs/installing.md 5cc153ab8c7c8043efd07a7cb9fa44c84e31a7a8
> docs/monitoring.md
> docs/operations/configuration.md PRE-CREATION
> docs/presentations.md 84756a24e258a38cebad1dac7c6e51f7d6d187bd
> docs/reference/configuration-best-practices.md PRE-CREATION
> docs/reference/configuration-templating.md PRE-CREATION
> docs/reference/configuration-tutorial.md PRE-CREATION
> docs/reference/scheduler-configuration.md PRE-CREATION
> docs/resources.md 27a267828d8222623ae77e084e1d5f602075838e
> docs/scheduler-configuration.md 7e3d801251262a5eedbca8890316aa9f44be8314
> docs/security.md 32bea426fbceec83187e851a5db11e82df55e962
> docs/sla.md a558e0098e73172801d9fad927f1f85d0476413f
> docs/storage-config.md 7c6484183ce88eca6ab1a25805c86af1fcd64ee1
> docs/storage.md 6ffed541d1579a8131ce642b082be602431329d3
> docs/task-lifecycle.md 5d6456cb6647acb2c2c0f9024c744e37ccc55d1c
> docs/test-resource-generation.md e78e742542508389e8161d00ee0e4ddb7084e72d
> docs/thrift-deprecation.md 62a71bcf10704c92fd26a8fd74729a8dc51b988c
> docs/tools.md 2ae550db35835ac2ebe5a95dbcc18e86d7bc4642
> docs/tutorial.md 95539ef299792068de2ad9d38b39d66e162fbc21
> docs/user-guide.md 656296cc84622d44d6dd43fc1496496da15b5d08
> docs/vagrant.md 3bc201f17977dbc402eeac307500db5cc9d6bb27
>
> Diff: https://reviews.apache.org/r/45392/diff/
>
>
> Testing
> -------
>
> Rendered version available at: https://github.com/StephanErb/aurora/tree/userguide_docu/docs
>
>
> Thanks,
>
> Stephan Erb
>
>