Skip to content
This repository has been archived by the owner on Oct 23, 2024. It is now read-only.

Commit

Permalink
Merge pull request #1335 from mesosphere/point-to-docs
Browse files Browse the repository at this point in the history
Add link to contribution instructions to README and tidy up text
  • Loading branch information
swartzrock committed Mar 25, 2015
2 parents 5a3ed7f + f3ee1db commit e9d83e3
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 14 deletions.
24 changes: 11 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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

Expand Down Expand Up @@ -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)
Expand Down
2 changes: 1 addition & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit e9d83e3

Please sign in to comment.