From f3ee1db9d72f222241f6710e240bc37f0eaacc82 Mon Sep 17 00:00:00 2001 From: Sunil Shah Date: Wed, 25 Mar 2015 13:49:59 -0700 Subject: [PATCH] Add link to contribution instructions to README and tidy up text a little. --- README.md | 24 +++++++++++------------- docs/README.md | 2 +- 2 files changed, 12 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 577875a3140..e25f9771bcd 100644 --- a/README.md +++ b/README.md @@ -23,7 +23,7 @@ can even start other Marathon instances via Marathon. Using Marathon versions 0.7.0+ and Mesos 0.20.0+, you can [deploy, run and scale Docker containers](https://mesosphere.github.io/marathon/docs/native-docker.html) with ease. -Documentation for installing and configuring the full Mesosphere stack with Mesos + Marathon is +Documentation for installing and configuring the full Mesosphere stack including Mesos and Marathon is available on the [Mesosphere website](http://mesosphere.com/docs/). ## Features @@ -46,21 +46,11 @@ available on the [Mesosphere website](http://mesosphere.com/docs/). #### Install Mesos -Marathon requires Mesos installed on the same machine in order to use a shared library. -One easy way is via your system's package manager. -Current builds for major Linux distributions are available -from on the Mesosphere [downloads page](http://mesosphere.com/downloads/) -or from Mesosphere's [repositories](http://mesosphere.com/2014/07/17/mesosphere-package-repositories/). - -If building from source, see the -Mesos [Getting Started](http://mesos.apache.org/gettingstarted/) page or the -[Mesosphere tutorial](http://mesosphere.com/2013/08/01/distributed-fault-tolerant-framework-apache-mesos/) -for details. Running `make install` will install Mesos in `/usr/local` in -the same way as these packages do. +Marathon requires Mesos installed on the same machine in order to use a shared library. Instructions on how to install prepackaged releases of Mesos are available [in the Marathon docs](https://mesosphere.github.io/marathon/docs/). #### Install Marathon -Full instructions on how to install prepackaged releases are available [in the Marathon docs](https://mesosphere.github.io/marathon/docs/). Alternatively, you can build Marathon from source. +Instructions on how to install prepackaged releases are available [in the Marathon docs](https://mesosphere.github.io/marathon/docs/). Alternatively, you can build Marathon from source. ##### Building from Source @@ -108,6 +98,14 @@ If you want to inspect the contents of the Docker: docker run -i -t --entrypoint=/bin/bash marathon-tip -s +## Documentation + +Marathon documentation is available on the [Marathon GitHub pages site](http://mesosphere.github.io/marathon/). + +### Contributing + +We heartily welcome external contributions to Marathon's documentation. Documentation should be committed to the `master` branch and published to our GitHub pages site using the instructions in [docs/README.md](https://github.com/mesosphere/marathon/tree/master/docs). + ## Marathon Clients * [Ruby gem and command line client](https://rubygems.org/gems/marathon-api) diff --git a/docs/README.md b/docs/README.md index 8a2aa99a533..c168686dde7 100644 --- a/docs/README.md +++ b/docs/README.md @@ -2,7 +2,7 @@ ## Run it locally -Ensure you have installed everything listed in the dependencies setction before +Ensure you have installed everything listed in the dependencies section before following the instructions. ### Dependencies