You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@mesos.apache.org by ti...@apache.org on 2016/01/25 15:25:43 UTC
[1/2] mesos git commit: Improved rakefile to allow for external .md
file links.
Repository: mesos
Updated Branches:
refs/heads/master 363b0b059 -> f0f4c3440
Improved rakefile to allow for external .md file links.
In addition also links with anchors like e.g.
`scheduler-http-api.md#recordio-response-format`, will now
function properly.
Review: https://reviews.apache.org/r/42457/
Project: http://git-wip-us.apache.org/repos/asf/mesos/repo
Commit: http://git-wip-us.apache.org/repos/asf/mesos/commit/f986b21f
Tree: http://git-wip-us.apache.org/repos/asf/mesos/tree/f986b21f
Diff: http://git-wip-us.apache.org/repos/asf/mesos/diff/f986b21f
Branch: refs/heads/master
Commit: f986b21fabf222e0cd61c789a63a01339de77a6e
Parents: 363b0b0
Author: Joerg Schad <jo...@mesosphere.io>
Authored: Mon Jan 25 15:09:19 2016 +0100
Committer: Till Toenshoff <to...@me.com>
Committed: Mon Jan 25 15:23:03 2016 +0100
----------------------------------------------------------------------
site/Rakefile | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/mesos/blob/f986b21f/site/Rakefile
----------------------------------------------------------------------
diff --git a/site/Rakefile b/site/Rakefile
index 9483348..0ce4b79 100644
--- a/site/Rakefile
+++ b/site/Rakefile
@@ -33,7 +33,7 @@ task :update_docs do
puts "working on: #{doc}"
IO.write(doc, File.open(doc) { |f|
f.read
- .gsub(/\(([^(]+)(\.md)\)/, '(/documentation/latest/\1/)')
+ .gsub(/\(([^(\/]+)\.md(\#.+?)?\)/, '(/documentation/latest/\1/\2)')
.gsub(/\(images\/(.*)\)/, '(/assets/img/documentation/\1)')
})
}
[2/2] mesos git commit: Made links to .md files consistent across
documentation.
Posted by ti...@apache.org.
Made links to .md files consistent across documentation.
Review: https://reviews.apache.org/r/42458/
Project: http://git-wip-us.apache.org/repos/asf/mesos/repo
Commit: http://git-wip-us.apache.org/repos/asf/mesos/commit/f0f4c344
Tree: http://git-wip-us.apache.org/repos/asf/mesos/tree/f0f4c344
Diff: http://git-wip-us.apache.org/repos/asf/mesos/diff/f0f4c344
Branch: refs/heads/master
Commit: f0f4c3440cc9aab8651f80823db80fbdbc83fb70
Parents: f986b21
Author: Joerg Schad <jo...@mesosphere.io>
Authored: Mon Jan 25 15:09:30 2016 +0100
Committer: Till Toenshoff <to...@me.com>
Committed: Mon Jan 25 15:24:57 2016 +0100
----------------------------------------------------------------------
docs/allocation-module.md | 2 +-
docs/app-framework-development-guide.md | 2 +-
docs/authentication.md | 2 +-
docs/c++-style-guide.md | 2 +-
docs/clang-format.md | 2 +-
docs/committers.md | 2 +-
docs/containerizer-internals.md | 6 +-
docs/containerizer.md | 6 +-
docs/deploy-scripts.md | 2 +-
docs/documentation-guide.md | 4 +-
docs/effective-code-reviewing.md | 2 +-
docs/fetcher-cache-internals.md | 2 +-
docs/fetcher.md | 6 +-
docs/high-availability.md | 6 +-
docs/home.md | 112 +++++++++++++--------------
docs/operational-guide.md | 2 +-
docs/sandbox.md | 8 +-
docs/tools.md | 2 +-
docs/versioning.md | 2 +-
19 files changed, 86 insertions(+), 86 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/mesos/blob/f0f4c344/docs/allocation-module.md
----------------------------------------------------------------------
diff --git a/docs/allocation-module.md b/docs/allocation-module.md
index 1dc1aba..3bbb904 100644
--- a/docs/allocation-module.md
+++ b/docs/allocation-module.md
@@ -65,4 +65,4 @@ mesos::modules::Module<Allocator> ExternalAllocatorModule(
createExternalAllocator);
~~~
-Refer to the [Mesos Modules documentation](/documentation/latest/modules/) for instructions on how to compile and load a module in Mesos master.
+Refer to the [Mesos Modules documentation](modules.md) for instructions on how to compile and load a module in Mesos master.
http://git-wip-us.apache.org/repos/asf/mesos/blob/f0f4c344/docs/app-framework-development-guide.md
----------------------------------------------------------------------
diff --git a/docs/app-framework-development-guide.md b/docs/app-framework-development-guide.md
index e094f32..e0f40ad 100644
--- a/docs/app-framework-development-guide.md
+++ b/docs/app-framework-development-guide.md
@@ -233,7 +233,7 @@ virtual void error(ExecutorDriver* driver, const std::string& message) = 0;
After creating your custom executor, you need to make it available to all slaves in the cluster.
-One way to distribute your framework executor is to let the [Mesos fetcher](/documentation/latest/fetcher/) download it on-demand when your scheduler launches tasks on that slave. `ExecutorInfo` is a Protocol Buffer Message class (defined in `include/mesos/mesos.proto`), and it contains a field of type `CommandInfo`. `CommandInfo` allows schedulers to specify, among other things, a number of resources as URIs. These resources are fetched to a sandbox directory on the slave before attempting to execute the `ExecutorInfo` command. Several URI schemes are supported, including HTTP, FTP, HDFS, and S3 (e.g. see src/examples/java/TestFramework.java for an example of this).
+One way to distribute your framework executor is to let the [Mesos fetcher](fetcher.md) download it on-demand when your scheduler launches tasks on that slave. `ExecutorInfo` is a Protocol Buffer Message class (defined in `include/mesos/mesos.proto`), and it contains a field of type `CommandInfo`. `CommandInfo` allows schedulers to specify, among other things, a number of resources as URIs. These resources are fetched to a sandbox directory on the slave before attempting to execute the `ExecutorInfo` command. Several URI schemes are supported, including HTTP, FTP, HDFS, and S3 (e.g. see src/examples/java/TestFramework.java for an example of this).
Alternatively, you can pass the `frameworks_home` configuration option (defaults to: `MESOS_HOME/frameworks`) to your `mesos-slave` daemons when you launch them to specify where your framework executors are stored (e.g. on an NFS mount that is available to all slaves), then use a relative path in `CommandInfo.uris`, and the slave will prepend the value of `frameworks_home` to the relative path provided.
http://git-wip-us.apache.org/repos/asf/mesos/blob/f0f4c344/docs/authentication.md
----------------------------------------------------------------------
diff --git a/docs/authentication.md b/docs/authentication.md
index 5f13181..b40b09e 100644
--- a/docs/authentication.md
+++ b/docs/authentication.md
@@ -18,7 +18,7 @@ Mesos uses the [Cyrus SASL library](http://asg.web.cmu.edu/sasl/) to implement a
## Configuration
-The [configuration options](/documentation/latest/configuration/) that are used by the authentication mechanism are as follows:
+The [configuration options](configuration.md) that are used by the authentication mechanism are as follows:
### Masters
http://git-wip-us.apache.org/repos/asf/mesos/blob/f0f4c344/docs/c++-style-guide.md
----------------------------------------------------------------------
diff --git a/docs/c++-style-guide.md b/docs/c++-style-guide.md
index c045a8d..5e2d88d 100644
--- a/docs/c++-style-guide.md
+++ b/docs/c++-style-guide.md
@@ -4,7 +4,7 @@ layout: documentation
# Mesos C++ Style Guide
-The Mesos codebase follows the [Google C++ Style Guide](http://google-styleguide.googlecode.com/svn/trunk/cppguide.xml) with some notable differences, as described below. Note that the [clang-format](/documentation/latest/clang-format/) tool can be helpful to ensure that some of the mechanical style rules are obeyed.
+The Mesos codebase follows the [Google C++ Style Guide](http://google-styleguide.googlecode.com/svn/trunk/cppguide.xml) with some notable differences, as described below. Note that the [clang-format](clang-format.md) tool can be helpful to ensure that some of the mechanical style rules are obeyed.
## Scoping
http://git-wip-us.apache.org/repos/asf/mesos/blob/f0f4c344/docs/clang-format.md
----------------------------------------------------------------------
diff --git a/docs/clang-format.md b/docs/clang-format.md
index 206bc2c..5e720e0 100644
--- a/docs/clang-format.md
+++ b/docs/clang-format.md
@@ -6,7 +6,7 @@ layout: documentation
[ClangFormat](http://llvm.org/releases/3.5.1/tools/clang/docs/ClangFormat.html) is an automatic source code formatting tool which helps us focus on the code rather than the formatting.
-> The provided configurations try to honor the [Mesos C++ Style Guide](/documentation/latest/c++-style-guide/) as much as possible, but there are some limitations which require manual attention. Even with these limitations however, ClangFormat will be extremely useful for your workflow!
+> The provided configurations try to honor the [Mesos C++ Style Guide](c++-style-guide.md) as much as possible, but there are some limitations which require manual attention. Even with these limitations however, ClangFormat will be extremely useful for your workflow!
## Setup
http://git-wip-us.apache.org/repos/asf/mesos/blob/f0f4c344/docs/committers.md
----------------------------------------------------------------------
diff --git a/docs/committers.md b/docs/committers.md
index c1ae257..94ee9a6 100644
--- a/docs/committers.md
+++ b/docs/committers.md
@@ -8,7 +8,7 @@ An Apache Mesos committer is a contributor who has been given write access to th
## Becoming a committer
-Every new committer has to be proposed by a current committer and then voted in by the members of the Mesos PMC. For details about this process and for candidate requirements see the general [Apache guidelines for assessing new candidates for committership](https://community.apache.org/newcommitter.html). Candidates prepare for their nomination as committer by contributing to the Mesos project and its community, by acting according to the [Apache Way](http://theapacheway.com), and by generally following the path [from contributor to committer](https://community.apache.org/contributors/) for Apache projects. Specifically for the Mesos project, you can make use of the [Apache Mesos Committer Candidate Checklist](/documentation/latest/committer-candidate-checklist/) for suggestions of what kind of contributions and demonstrated behaviors can be instrumental, and to keep track of your progress.
+Every new committer has to be proposed by a current committer and then voted in by the members of the Mesos PMC. For details about this process and for candidate requirements see the general [Apache guidelines for assessing new candidates for committership](https://community.apache.org/newcommitter.html). Candidates prepare for their nomination as committer by contributing to the Mesos project and its community, by acting according to the [Apache Way](http://theapacheway.com), and by generally following the path [from contributor to committer](https://community.apache.org/contributors/) for Apache projects. Specifically for the Mesos project, you can make use of the [Apache Mesos Committer Candidate Checklist](committer-candidate-checklist.md) for suggestions of what kind of contributions and demonstrated behaviors can be instrumental, and to keep track of your progress.
## Current Committers
http://git-wip-us.apache.org/repos/asf/mesos/blob/f0f4c344/docs/containerizer-internals.md
----------------------------------------------------------------------
diff --git a/docs/containerizer-internals.md b/docs/containerizer-internals.md
index 14c4c6c..20bf2d1 100644
--- a/docs/containerizer-internals.md
+++ b/docs/containerizer-internals.md
@@ -30,9 +30,9 @@ events (e.g., statistics).
Mesos currently supports the following containerizers:
* Composing
-* [Docker](/documentation/latest/docker-containerizer/)
-* [Mesos](/documentation/latest/containerizer/)
-* [External](/documentation/latest/external-containerizer/) (deprecated)
+* [Docker](docker-containerizer.md)
+* [Mesos](containerizer.md)
+* [External](external-containerizer.md) (deprecated)
#### Composing Containerizer
http://git-wip-us.apache.org/repos/asf/mesos/blob/f0f4c344/docs/containerizer.md
----------------------------------------------------------------------
diff --git a/docs/containerizer.md b/docs/containerizer.md
index a694de9..cd23cf9 100644
--- a/docs/containerizer.md
+++ b/docs/containerizer.md
@@ -64,7 +64,7 @@ Use cases:
* If Mesos agent is running inside a docker container.
For more details, see
-[Docker Containerizer](/documentation/latest/docker-containerizer/).
+[Docker Containerizer](docker-containerizer.md).
<a name="Mesos"></a>
### Mesos containerizer
@@ -85,10 +85,10 @@ Use cases:
* Want to add custom isolation for tasks.
For more details, see
-[Mesos Containerizer](/documentation/latest/mesos-containerizer/).
+[Mesos Containerizer](mesos-containerizer.md).
## References
-* [Containerizer Internals](/documentation/latest/containerizer-internals) for
+* [Containerizer Internals](containerizer-internals.md) for
implementation details of containerizers.
http://git-wip-us.apache.org/repos/asf/mesos/blob/f0f4c344/docs/deploy-scripts.md
----------------------------------------------------------------------
diff --git a/docs/deploy-scripts.md b/docs/deploy-scripts.md
index 0dce7d8..87f8eb6 100644
--- a/docs/deploy-scripts.md
+++ b/docs/deploy-scripts.md
@@ -13,7 +13,7 @@ You can then start a cluster with `[install-prefix]/sbin/mesos-start-cluster.sh`
It is also possible to set environment variables, ulimits, etc that will affect the master and slave by editing `[install-prefix]/var/mesos/deploy/mesos-deploy-env.sh`. One particularly useful setting is `LIBPROCESS_IP`, which tells the master and slave binaries which IP address to bind to; in some installations, the default interface that the hostname resolves to is not the machine's external IP address, so you can set the right IP through this variable. Besides the common environment variables of master and slave configured in `[install-prefix/var/mesos/deploy/mesos-deploy-env.sh`, it is also possible to set master specific environment variables in `[install-prefix]/var/mesos/deploy/mesos-master-env.sh`, slave specific environment variables in `[install-prefix]/var/mesos/deploy/mesos-slave-env.sh`.
-Finally, the deploy scripts do not use ZooKeeper by default. If you want to configure Mesos to use ZooKeeper to coordinate multiple master nodes, please see the [High Availability](/documentation/latest/high-availability/) documentation for details.
+Finally, the deploy scripts do not use ZooKeeper by default. If you want to configure Mesos to use ZooKeeper to coordinate multiple master nodes, please see the [High Availability](high-availability.md) documentation for details.
## Notes
http://git-wip-us.apache.org/repos/asf/mesos/blob/f0f4c344/docs/documentation-guide.md
----------------------------------------------------------------------
diff --git a/docs/documentation-guide.md b/docs/documentation-guide.md
index 9548bca..b7e8614 100644
--- a/docs/documentation-guide.md
+++ b/docs/documentation-guide.md
@@ -5,14 +5,14 @@ Documentation is an integral part of every good feature. It describes the intend
We have three different kinds of documentation:
-1. [MarkDown User Guides](/documentation/latest/markdown-style-guide/)
+1. [MarkDown User Guides](markdown-style-guide.md)
User guides and non-code technical documentation are stored in markdown files in the `docs/` folder. These files get rendered for the [online documentation](http://mesos.apache.org/documentation/latest/).
We will accept small documentation changes on [Github via a pull request](https://github.com/apache/mesos), larger documentation changes should go through the (reviewboard)[https://reviews.apache.org/groups/mesos/]
-2. [Doxygen API Documentation and Developer Guides as part of source code](/documentation/latest/doxygen-style-guide/)
+2. [Doxygen API Documentation and Developer Guides as part of source code](doxygen-style-guide.md)
Doxygen API documentation needs only to be applied to source code parts that
constitute an interface for which we want to generate Mesos API documentation
http://git-wip-us.apache.org/repos/asf/mesos/blob/f0f4c344/docs/effective-code-reviewing.md
----------------------------------------------------------------------
diff --git a/docs/effective-code-reviewing.md b/docs/effective-code-reviewing.md
index fdfafc7..5a633bc 100644
--- a/docs/effective-code-reviewing.md
+++ b/docs/effective-code-reviewing.md
@@ -22,7 +22,7 @@ to consider before sending review requests:
change clear in the review request, so the reviewer is not left
guessing. It is highly recommended to attach a JIRA issue with your
review for additional context.
-4. **Follow the [style guide](/documentation/latest/c++-style-guide/)
+4. **Follow the [style guide](c++-style-guide.md)
and the style of code around you**.
5. **Do a self-review of your changes before publishing**: Approach it
from the perspective of a reviewer with no context. Is it easy to figure
http://git-wip-us.apache.org/repos/asf/mesos/blob/f0f4c344/docs/fetcher-cache-internals.md
----------------------------------------------------------------------
diff --git a/docs/fetcher-cache-internals.md b/docs/fetcher-cache-internals.md
index b71d225..1ccb1c2 100644
--- a/docs/fetcher-cache-internals.md
+++ b/docs/fetcher-cache-internals.md
@@ -4,7 +4,7 @@ layout: documentation
# Mesos Fetcher Cache Internals
-It assumed that readers of this document are familiar with the contents of the [Mesos fetcher user guide](/documentation/latest/fetcher/). The present document makes direct references to notions defined in the former.
+It assumed that readers of this document are familiar with the contents of the [Mesos fetcher user guide](fetcher.md). The present document makes direct references to notions defined in the former.
## Design goals for the initial fetcher cache prototype:
http://git-wip-us.apache.org/repos/asf/mesos/blob/f0f4c344/docs/fetcher.md
----------------------------------------------------------------------
diff --git a/docs/fetcher.md b/docs/fetcher.md
index 3cf8875..cb4f3c3 100644
--- a/docs/fetcher.md
+++ b/docs/fetcher.md
@@ -12,7 +12,7 @@ from local file systems.
## What is the Mesos fetcher?
The Mesos fetcher is a mechanism to download resources into the [sandbox
-directory](/documentation/latest/sandbox/) of a task in preparation of running
+directory](sandbox.md) of a task in preparation of running
the task. As part of a TaskInfo message, the framework ordering the task's
execution provides a list of `CommandInfo::URI` protobuf values, which becomes
the input to the Mesos fetcher.
@@ -21,7 +21,7 @@ The Mesos fetcher can copy files from a local filesytem and it also natively
supports the HTTP, HTTPS, FTP and FTPS protocols. If the requested URI is based
on some other protocol, then the fetcher tries to utilise a local Hadoop client
and hence supports any protocol supported by the Hadoop client, e.g., HDFS, S3.
-See the slave [configuration documentation](/documentation/latest/configuration/)
+See the slave [configuration documentation](configuration.md)
for how to configure the slave with a path to the Hadoop client.
By default, each requested URI is downloaded directly into the sandbox directory
@@ -299,4 +299,4 @@ The following features would be relatively easy to implement additionally.
running the present task, right after fetching its own resources.
## Implementation Details
-The [Mesos Fetcher Cache Internals](/documentation/latest/fetcher-cache-internals/) describes how the fetcher cache is implemented.
+The [Mesos Fetcher Cache Internals](fetcher-cache-internals.md) describes how the fetcher cache is implemented.
http://git-wip-us.apache.org/repos/asf/mesos/blob/f0f4c344/docs/high-availability.md
----------------------------------------------------------------------
diff --git a/docs/high-availability.md b/docs/high-availability.md
index 02ac7c7..3e9802b 100644
--- a/docs/high-availability.md
+++ b/docs/high-availability.md
@@ -21,11 +21,11 @@ To put Mesos into high-availability mode:
* Start the mesos-slave binaries with `--master=zk://host1:port1,host2:port2,.../path`
- * Start any framework schedulers using the same `zk` path as in the last two steps. The SchedulerDriver must be constructed with this path, as shown in the [Framework Development Guide](/documentation/latest/app-framework-development-guide/).
+ * Start any framework schedulers using the same `zk` path as in the last two steps. The SchedulerDriver must be constructed with this path, as shown in the [Framework Development Guide](app-framework-development-guide.md).
From now on, the Mesos masters and slaves all communicate with ZooKeeper to find out which master is the current leading master. This is in addition to the usual communication between the leading master and the slaves.
-Refer to the [Scheduler API](/documentation/latest/app-framework-development-guide/) for how to deal with leadership changes.
+Refer to the [Scheduler API](app-framework-development-guide.md) for how to deal with leadership changes.
## Component Disconnection Handling
When a network partition disconnects a component (master, slave, or scheduler driver) from ZooKeeper, the component's Master Detector induces a timeout event. This notifies the component that it has no leading master. Depending on the component, the following happens. (Note that while a component is disconnected from ZooKeeper, a master may still be in communication with slaves or schedulers and vice versa.)
@@ -45,7 +45,7 @@ When a network partition disconnects a slave from the leader:
* The slave fails health checks from the leader.
-* The leader marks the slave as deactivated and sends its tasks to the LOST state. The [Framework Development Guide](/documentation/latest/app-framework-development-guide/) describes these various task states.
+* The leader marks the slave as deactivated and sends its tasks to the LOST state. The [Framework Development Guide](app-framework-development-guide.md) describes these various task states.
* Deactivated slaves may not re-register with the leader and are told to shut down upon any post-deactivation communication.
http://git-wip-us.apache.org/repos/asf/mesos/blob/f0f4c344/docs/home.md
----------------------------------------------------------------------
diff --git a/docs/home.md b/docs/home.md
index fa9c19c..dea6ec2 100644
--- a/docs/home.md
+++ b/docs/home.md
@@ -6,84 +6,84 @@ layout: documentation
## Mesos Fundamentals
-* [Mesos Architecture](/documentation/latest/architecture/) providing an overview of Mesos concepts.
-* [Video and Slides of Mesos Presentations](/documentation/latest/presentations/)
+* [Mesos Architecture](architecture.md) providing an overview of Mesos concepts.
+* [Video and Slides of Mesos Presentations](presentations.md)
## Running Mesos
-* [Getting Started](/documentation/latest/getting-started/) for basic instructions on compiling and installing Mesos.
-* [Upgrades](/documentation/latest/upgrades/) for upgrading a Mesos cluster.
-* [Configuration](/documentation/latest/configuration/) for command-line arguments.
-* [Containerizer](/documentation/latest/containerizer/) for containerizer overview and use cases.
- * [Containerizer Internals](/documentation/latest/containerizer-internals) for implementation details of containerizers.
- * [Mesos Containerizer](/documentation/latest/mesos-containerizer/) default containerizer, supports both Linux and POSIX systems.
- * [Docker Containerizer](/documentation/latest/docker-containerizer/) for launching a Docker image as a Task, or as an Executor.
- * [External Containerizer](/documentation/latest/external-containerizer/) for custom containerization implementations (deprecated).
-* [Roles](/documentation/latest/roles/)
-* [Framework Authentication](/documentation/latest/authentication/)
-* [Framework Authorization](/documentation/latest/authorization/)
-* [Framework Rate Limiting](/documentation/latest/framework-rate-limiting/)
-* [Logging](/documentation/latest/logging/)
-* [High Availability](/documentation/latest/high-availability/) for running multiple masters simultaneously.
-* [Operational Guide](/documentation/latest/operational-guide/)
-* [Monitoring](/documentation/latest/monitoring/)
-* [Network Monitoring and Isolation](/documentation/latest/network-monitoring/)
-* [Slave Recovery](/documentation/latest/slave-recovery/) for doing seamless upgrades.
-* [Maintenance](/documentation/latest/maintenance/) for performing maintenance on a Mesos cluster.
-* [Tools](/documentation/latest/tools/) for setting up and running a Mesos cluster.
-* [SSL](/documentation/latest/ssl/) for enabling and enforcing SSL communication.
-* [Mesos Image Provisioner](/documentation/latest/mesos-provisioner/) for provisioning container filesystems from different image formats.
+* [Getting Started](getting-started.md) for basic instructions on compiling and installing Mesos.
+* [Upgrades](upgrades.md) for upgrading a Mesos cluster.
+* [Configuration](configuration.md) for command-line arguments.
+* [Containerizer](containerizer.md) for containerizer overview and use cases.
+ * [Containerizer Internals](containerizer-internals.md) for implementation details of containerizers.
+ * [Mesos Containerizer](mesos-containerizer.md) default containerizer, supports both Linux and POSIX systems.
+ * [Docker Containerizer](docker-containerizer.md) for launching a Docker image as a Task, or as an Executor.
+ * [External Containerizer](external-containerizer.md) for custom containerization implementations (deprecated).
+* [Roles](roles.md)
+* [Framework Authentication](authentication.md)
+* [Framework Authorization](authorization.md)
+* [Framework Rate Limiting](framework-rate-limiting.md)
+* [Logging](logging.md)
+* [High Availability](high-availability.md) for running multiple masters simultaneously.
+* [Operational Guide](operational-guide.md)
+* [Monitoring](monitoring.md)
+* [Network Monitoring and Isolation](network-monitoring.md)
+* [Slave Recovery](slave-recovery.md) for doing seamless upgrades.
+* [Maintenance](maintenance.md) for performing maintenance on a Mesos cluster.
+* [Tools](tools.md) for setting up and running a Mesos cluster.
+* [SSL](ssl.md) for enabling and enforcing SSL communication.
+* [Mesos Image Provisioner](mesos-provisioner.md) for provisioning container filesystems from different image formats.
## Advanced Features
-* [Attributes and Resources](/documentation/attributes-resources/) for how to describe the slaves that comprise a cluster.
-* [Fetcher Cache](/documentation/latest/fetcher/) for how to configure the Mesos fetcher cache.
-* [Networking for Mesos-managed Containers](/documentation/latest/networking-for-mesos-managed-containers/)
-* [Oversubscription](/documentation/latest/oversubscription/) for how to configure Mesos to take advantage of unused resources to launch "best-effort" tasks.
-* [Persistent Volume](/documentation/latest/persistent-volume/) for how to allow tasks to access persistent storage resources.
-* [Quota](/documentation/latest/quota/) for how to configure Mesos to provide guaranteed resource allocations for use by a role.
-* [Reservation](/documentation/latest/reservation/) for how operators and frameworks can reserve resources on individual agents for use by a role.
+* [Attributes and Resources](attributes-resources.md) for how to describe the slaves that comprise a cluster.
+* [Fetcher Cache](fetcher.md) for how to configure the Mesos fetcher cache.
+* [Networking for Mesos-managed Containers](networking-for-mesos-managed-containers.md)
+* [Oversubscription](oversubscription.md) for how to configure Mesos to take advantage of unused resources to launch "best-effort" tasks.
+* [Persistent Volume](persistent-volume.md) for how to allow tasks to access persistent storage resources.
+* [Quota](quota.md) for how to configure Mesos to provide guaranteed resource allocations for use by a role.
+* [Reservation](reservation.md) for how operators and frameworks can reserve resources on individual agents for use by a role.
## Running Mesos Frameworks
-* [Mesos frameworks](/documentation/latest/frameworks/) for a list of apps built on top of Mesos and instructions on how to run them.
-* [Sandbox](/documentation/latest/sandbox/) describes a useful debugging arena for most users.
+* [Mesos frameworks](frameworks.md) for a list of apps built on top of Mesos and instructions on how to run them.
+* [Sandbox](sandbox.md) describes a useful debugging arena for most users.
## Developing Mesos Frameworks
-* [Framework Development Guide](/documentation/latest/app-framework-development-guide/) describes how to build applications on top of Mesos.
-* [Designing Highly Available Mesos Frameworks](/documentation/latest/high-availability-framework-guide/)
-* [Reconciliation](/documentation/latest/reconciliation/) for ensuring a framework's state remains eventually consistent in the face of failures.
-* [Scheduler HTTP API](/documentation/latest/scheduler-http-api/) describes the new HTTP API for communication between schedulers and the Mesos master.
-* [Executor HTTP API](/documentation/latest/executor-http-api/) describes the new HTTP API for communication between executors and the Mesos agent.
+* [Framework Development Guide](app-framework-development-guide.md) describes how to build applications on top of Mesos.
+* [Designing Highly Available Mesos Frameworks](high-availability-framework-guide.md)
+* [Reconciliation](reconciliation.md) for ensuring a framework's state remains eventually consistent in the face of failures.
+* [Scheduler HTTP API](scheduler-http-api.md) describes the new HTTP API for communication between schedulers and the Mesos master.
+* [Executor HTTP API](executor-http-api.md) describes the new HTTP API for communication between executors and the Mesos agent.
* [Javadoc](/api/latest/java/) documents the Mesos Java API.
* [Doxygen](/api/latest/c++/namespacemesos.html) documents the Mesos C++ API.
-* [Developer Tools](/documentation/latest/tools/) for hacking on Mesos or writing frameworks.
-* [Versioning](/documentation/latest/versioning/) describes how Mesos does API and release versioning.
+* [Developer Tools](tools.md) for hacking on Mesos or writing frameworks.
+* [Versioning](versioning.md) describes how Mesos does API and release versioning.
## Extending Mesos
-* [Mesos Modules](/documentation/latest/modules/) for specifying Mesos modules for master, slave and tests.
-* [Allocation Modules](/documentation/latest/allocation-module/) for how to write custom resource allocators.
+* [Mesos Modules](modules.md) for specifying Mesos modules for master, slave and tests.
+* [Allocation Modules](allocation-module.md) for how to write custom resource allocators.
## Contributing to Mesos
-* [Reporting an Issue, Improvement, or Feature](/documentation/latest/reporting-a-bug/) for getting started with JIRA.
-* [Submitting a Patch](/documentation/latest/submitting-a-patch/) for getting started with ReviewBoard and our tooling around it.
-* [Testing Patterns](/documentation/latest/testing-patterns/) for tips and tricks used in Mesos tests.
-* [Effective Code Reviewing](/documentation/latest/effective-code-reviewing/) guidelines, tips, and learnings for how to do effective code reviews.
-* [Engineering Principles and Practices](/documentation/latest/engineering-principles-and-practices/) to serve as a shared set of project-level values for the community.
-* [Committing](/documentation/latest/committing/) guidelines for committing changes.
-* [Committers and Maintainers](/documentation/latest/committers/) a listing of project committers and component maintainers; useful when seeking feedback.
+* [Reporting an Issue, Improvement, or Feature](reporting-a-bug.md) for getting started with JIRA.
+* [Submitting a Patch](submitting-a-patch.md) for getting started with ReviewBoard and our tooling around it.
+* [Testing Patterns](testing-patterns.md) for tips and tricks used in Mesos tests.
+* [Effective Code Reviewing](effective-code-reviewing.md) guidelines, tips, and learnings for how to do effective code reviews.
+* [Engineering Principles and Practices](engineering-principles-and-practices.md) to serve as a shared set of project-level values for the community.
+* [Committing](committing.md) guidelines for committing changes.
+* [Committers and Maintainers](committers.md) a listing of project committers and component maintainers; useful when seeking feedback.
* [Doxygen](/api/latest/c++/) documents the internal Mesos APIs.
-* [Documentation Guide](/documentation/latest/documentation-guide/)
- * [C++ Style Guide](/documentation/latest/c++-style-guide/)
- * [Doxygen Style Guide](/documentation/latest/doxygen-style-guide/)
- * [Markdown Style Guide](/documentation/latest/markdown-style-guide/)
-* [Development Roadmap](/documentation/latest/roadmap/)
-* [Release Guide](/documentation/latest/release-guide/)
+* [Documentation Guide](documentation-guide.md)
+ * [C++ Style Guide](c++-style-guide.md)
+ * [Doxygen Style Guide](doxygen-style-guide.md)
+ * [Markdown Style Guide](markdown-style-guide.md)
+* [Development Roadmap](roadmap.md)
+* [Release Guide](release-guide.md)
## More Info about Mesos
-* [Powered by Mesos](/documentation/latest/powered-by-mesos/) lists organizations and software that are powered by Apache Mesos.
+* [Powered by Mesos](powered-by-mesos.md) lists organizations and software that are powered by Apache Mesos.
* Academic Papers and Project History
http://git-wip-us.apache.org/repos/asf/mesos/blob/f0f4c344/docs/operational-guide.md
----------------------------------------------------------------------
diff --git a/docs/operational-guide.md b/docs/operational-guide.md
index 811cfc4..4680ee3 100644
--- a/docs/operational-guide.md
+++ b/docs/operational-guide.md
@@ -1,7 +1,7 @@
# Operational Guide
## Using a process supervisor
-Mesos uses a "[fail-fast](https://en.wikipedia.org/wiki/Fail-fast)" approach to error handling: if a serious error occurs, Mesos will typically exit rather than trying to continue running in a possibly erroneous state. For example, when Mesos is configured for [high availability](/documentation/latest/high-availability), the leading master will abort itself when it discovers it has been partitioned away from the Zookeeper quorum. This is a safety precaution to ensure the previous leader doesn't continue communicating in an unsafe state.
+Mesos uses a "[fail-fast](https://en.wikipedia.org/wiki/Fail-fast)" approach to error handling: if a serious error occurs, Mesos will typically exit rather than trying to continue running in a possibly erroneous state. For example, when Mesos is configured for [high availability](high-availability.md), the leading master will abort itself when it discovers it has been partitioned away from the Zookeeper quorum. This is a safety precaution to ensure the previous leader doesn't continue communicating in an unsafe state.
To ensure that such failures are handled appropriately, production deployments of Mesos typically use a _process supervisor_ (such as systemd or supervisord) to detect when Mesos processes exit. The supervisor can be configured to restart the failed process automatically and/or to notify the cluster operator to investigate the situation.
http://git-wip-us.apache.org/repos/asf/mesos/blob/f0f4c344/docs/sandbox.md
----------------------------------------------------------------------
diff --git a/docs/sandbox.md b/docs/sandbox.md
index a2ad226..276e112 100644
--- a/docs/sandbox.md
+++ b/docs/sandbox.md
@@ -12,13 +12,13 @@ own sandbox and the executor's working directory is set to the sandbox.
The sandbox holds:
-* Files [fetched by Mesos](/documentation/latest/fetcher/), prior to starting
+* Files [fetched by Mesos](fetcher.md), prior to starting
the executor's tasks.
* The output of the executor and tasks (as files "stdout" and "stderr").
* Files created by the executor and tasks, with some exceptions.
> **NOTE:** With the introduction of
-> [persistent volumes](/documentation/latest/persistent-volume/), executors
+> [persistent volumes](persistent-volume.md), executors
> and tasks should never create files outside of the sandbox. However,
> some containerizers do not enforce this sandboxing.
@@ -149,7 +149,7 @@ executor and isolators :
* Docker containerizer - As of Docker `1.9.1`, the Docker containerizer
does not enforce nor support a disk quota. See the
[Docker issue](https://github.com/docker/docker/issues/3804).
-* [External containerizer](/documentation/latest/external-containerizer/).
+* [External containerizer](external-containerizer.md).
## Sandbox lifecycle
@@ -169,4 +169,4 @@ After the delay, the files are deleted.
Additionally, according to the `--disk_watch_interval` agent flag, files
scheduled for garbage collection are pruned based on the available disk and
the `--gc_disk_headroom` agent flag.
-See [the formula here](/documentation/latest/configuration/#gc_disk_headroom).
+See [the formula here](configuration.md#gc_disk_headroom).
http://git-wip-us.apache.org/repos/asf/mesos/blob/f0f4c344/docs/tools.md
----------------------------------------------------------------------
diff --git a/docs/tools.md b/docs/tools.md
index 3e5f4d7..6234e38 100644
--- a/docs/tools.md
+++ b/docs/tools.md
@@ -20,7 +20,7 @@ These tools make it easy to set up and run a Mesos cluster.
If you want to hack on Mesos or write a new framework, these tools will help.
-* [clang-format](/documentation/latest/clang-format/) to automatically apply some of the style rules dictated by the [Mesos C++ Style Guide](/documentation/latest/c++-style-guide/).
+* [clang-format](clang-format.md) to automatically apply some of the style rules dictated by the [Mesos C++ Style Guide](c++-style-guide.md).
* [Go Bindings and Examples](https://github.com/mesosphere/mesos-go) Write a Mesos framework in Go! Comes with an example scheduler and executor.
* [Mesos Framework giter8 Template](https://github.com/mesosphere/scala-sbt-mesos-framework.g8) This is a giter8 template. The result of applying this template is a bare-bones Apache Mesos framework in Scala using SBT for builds and Vagrant for testing on a singleton cluster.
* [Scala Hello World](https://gist.github.com/guenter/7471695) A simple Mesos "Hello World": downloads and starts a web server on every node in the cluster.
http://git-wip-us.apache.org/repos/asf/mesos/blob/f0f4c344/docs/versioning.md
----------------------------------------------------------------------
diff --git a/docs/versioning.md b/docs/versioning.md
index 7af6581..cc31fd5 100644
--- a/docs/versioning.md
+++ b/docs/versioning.md
@@ -67,7 +67,7 @@ The following are considered backwards incompatible changes for Scheduler API:
* In rare cases, we might require the master and agent to go through a specific minor version for upgrades.
* For example, we might require that a 1.1.0 master (and/or agent) be upgraded to 1.8.0 before it can be upgraded to 1.9.0 or later versions.
-The detailed information about upgrading to a particular Mesos version would be posted [here](/documentation/latest/upgrades/).
+The detailed information about upgrading to a particular Mesos version would be posted [here](upgrades.md).
### Implementation Details