mesos-reviews mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From GitBox <...@apache.org>
Subject [GitHub] greggomann closed pull request #178: WIP: Mesos Documentation Project Reorg Proposal
Date Mon, 27 Aug 2018 17:48:56 GMT
greggomann closed pull request #178: WIP: Mesos Documentation Project Reorg Proposal
URL: https://github.com/apache/mesos/pull/178
 
 
   

This is a PR merged from a forked repository.
As GitHub hides the original diff on merge, it is displayed below for
the sake of provenance:

As this is a foreign pull request (from a fork), the diff is supplied
below (as it won't show otherwise due to GitHub magic):

diff --git a/docs/concepts/agent-isolators.md b/docs/concepts/agent-isolators.md
new file mode 100644
index 0000000000..e0eb1a5ad1
--- /dev/null
+++ b/docs/concepts/agent-isolators.md
@@ -0,0 +1 @@
+agent-isolators.md
diff --git a/docs/concepts/agents.md b/docs/concepts/agents.md
new file mode 100644
index 0000000000..ef87c33320
--- /dev/null
+++ b/docs/concepts/agents.md
@@ -0,0 +1 @@
+agents.md
diff --git a/docs/concepts/api-concepts.md b/docs/concepts/api-concepts.md
new file mode 100644
index 0000000000..aceda302e6
--- /dev/null
+++ b/docs/concepts/api-concepts.md
@@ -0,0 +1 @@
+api-concepts
diff --git a/docs/concepts/authentication-and-authorization.md b/docs/concepts/authentication-and-authorization.md
new file mode 100644
index 0000000000..2f6e0c8edf
--- /dev/null
+++ b/docs/concepts/authentication-and-authorization.md
@@ -0,0 +1 @@
+authentication-and-authorization
diff --git a/docs/concepts/choosing-a-type-of-deployment.md b/docs/concepts/choosing-a-type-of-deployment.md
new file mode 100644
index 0000000000..89f8f2ef54
--- /dev/null
+++ b/docs/concepts/choosing-a-type-of-deployment.md
@@ -0,0 +1 @@
+choosing-a-type-of-deployment.md
diff --git a/docs/concepts/code-reviewing-guidelines.md b/docs/concepts/code-reviewing-guidelines.md
new file mode 100644
index 0000000000..83e93ed206
--- /dev/null
+++ b/docs/concepts/code-reviewing-guidelines.md
@@ -0,0 +1 @@
+code-reviewing-guidelines
diff --git a/docs/concepts/committing-guidelines.md b/docs/concepts/committing-guidelines.md
new file mode 100644
index 0000000000..0e0efd04ea
--- /dev/null
+++ b/docs/concepts/committing-guidelines.md
@@ -0,0 +1 @@
+committing-guidelines
diff --git a/docs/concepts/configure-mesos.md b/docs/concepts/configure-mesos.md
new file mode 100644
index 0000000000..a057700d8c
--- /dev/null
+++ b/docs/concepts/configure-mesos.md
@@ -0,0 +1 @@
+configure-mesos.md
diff --git a/docs/concepts/contributing-to-mesos-overview.md b/docs/concepts/contributing-to-mesos-overview.md
new file mode 100644
index 0000000000..0d2a15887f
--- /dev/null
+++ b/docs/concepts/contributing-to-mesos-overview.md
@@ -0,0 +1 @@
+contributing-to-mesos-overview.md
diff --git a/docs/concepts/cpp-style-guide.md b/docs/concepts/cpp-style-guide.md
new file mode 100644
index 0000000000..f33ab097d6
--- /dev/null
+++ b/docs/concepts/cpp-style-guide.md
@@ -0,0 +1 @@
+cpp-style-guide
diff --git a/docs/concepts/design-documents.md b/docs/concepts/design-documents.md
new file mode 100644
index 0000000000..2314fe749e
--- /dev/null
+++ b/docs/concepts/design-documents.md
@@ -0,0 +1 @@
+design-documents
diff --git a/docs/concepts/developer-community.md b/docs/concepts/developer-community.md
new file mode 100644
index 0000000000..156ddca1ed
--- /dev/null
+++ b/docs/concepts/developer-community.md
@@ -0,0 +1 @@
+developer-community
diff --git a/docs/concepts/developing-advanced-resource-types.md b/docs/concepts/developing-advanced-resource-types.md
new file mode 100644
index 0000000000..5eea7ddb87
--- /dev/null
+++ b/docs/concepts/developing-advanced-resource-types.md
@@ -0,0 +1 @@
+developing-advanced-resource-types.md
diff --git a/docs/concepts/developing-containers.md.md b/docs/concepts/developing-containers.md.md
new file mode 100644
index 0000000000..9f6ef17041
--- /dev/null
+++ b/docs/concepts/developing-containers.md.md
@@ -0,0 +1 @@
+developing-containers.md
diff --git a/docs/concepts/developing-executors.md b/docs/concepts/developing-executors.md
new file mode 100644
index 0000000000..3ee1bd0126
--- /dev/null
+++ b/docs/concepts/developing-executors.md
@@ -0,0 +1 @@
+developing-executors.md
diff --git a/docs/concepts/developing-mesos-containerizer.md b/docs/concepts/developing-mesos-containerizer.md
new file mode 100644
index 0000000000..ceb2ad7a95
--- /dev/null
+++ b/docs/concepts/developing-mesos-containerizer.md
@@ -0,0 +1 @@
+developing-mesos-containerizer.md
diff --git a/docs/concepts/developing-mesos-frameworks-overview.md b/docs/concepts/developing-mesos-frameworks-overview.md
new file mode 100644
index 0000000000..32704fe636
--- /dev/null
+++ b/docs/concepts/developing-mesos-frameworks-overview.md
@@ -0,0 +1 @@
+developing-mesos-frameworks-overview.md
diff --git a/docs/concepts/developing-resource-offers.md b/docs/concepts/developing-resource-offers.md
new file mode 100644
index 0000000000..27b8769b7c
--- /dev/null
+++ b/docs/concepts/developing-resource-offers.md
@@ -0,0 +1 @@
+developing-resource-offers.md
diff --git a/docs/concepts/developing-schedulers.md b/docs/concepts/developing-schedulers.md
new file mode 100644
index 0000000000..8ae3e2581f
--- /dev/null
+++ b/docs/concepts/developing-schedulers.md
@@ -0,0 +1 @@
+developing-schedulers.md
diff --git a/docs/concepts/development-practices.md b/docs/concepts/development-practices.md
new file mode 100644
index 0000000000..bce7ffc043
--- /dev/null
+++ b/docs/concepts/development-practices.md
@@ -0,0 +1 @@
+development-practices
diff --git a/docs/concepts/disk-resources.md b/docs/concepts/disk-resources.md
new file mode 100644
index 0000000000..faed2d1e1d
--- /dev/null
+++ b/docs/concepts/disk-resources.md
@@ -0,0 +1 @@
+disk-resources.md
diff --git a/docs/concepts/downloading-building-installing-overview.md b/docs/concepts/downloading-building-installing-overview.md
new file mode 100644
index 0000000000..60978d376c
--- /dev/null
+++ b/docs/concepts/downloading-building-installing-overview.md
@@ -0,0 +1 @@
+downloading-building-installing-overview.md
diff --git a/docs/concepts/drf.md b/docs/concepts/drf.md
new file mode 100644
index 0000000000..d42ecb5d37
--- /dev/null
+++ b/docs/concepts/drf.md
@@ -0,0 +1 @@
+drf.md
diff --git a/docs/concepts/how-to-get-involved.md b/docs/concepts/how-to-get-involved.md
new file mode 100644
index 0000000000..7672b81375
--- /dev/null
+++ b/docs/concepts/how-to-get-involved.md
@@ -0,0 +1 @@
+how-to-get-involved
diff --git a/docs/concepts/masters.md b/docs/concepts/masters.md
new file mode 100644
index 0000000000..b8c66bc617
--- /dev/null
+++ b/docs/concepts/masters.md
@@ -0,0 +1 @@
+masters.md
diff --git a/docs/concepts/mesos-apis-overview.md b/docs/concepts/mesos-apis-overview.md
new file mode 100644
index 0000000000..30786030d2
--- /dev/null
+++ b/docs/concepts/mesos-apis-overview.md
@@ -0,0 +1 @@
+mesos-apis-overview.md
diff --git a/docs/concepts/mesos-components.md b/docs/concepts/mesos-components.md
new file mode 100644
index 0000000000..7cc988e934
--- /dev/null
+++ b/docs/concepts/mesos-components.md
@@ -0,0 +1,6 @@
+mesos-components.md
+
+* [Masters and agents]
+* [Schedulers and executors]
+* [Offers]
+* [Containers and isolation]
diff --git a/docs/concepts/mesos-internals-overview.md b/docs/concepts/mesos-internals-overview.md
new file mode 100644
index 0000000000..9fd257370f
--- /dev/null
+++ b/docs/concepts/mesos-internals-overview.md
@@ -0,0 +1 @@
+mesos-internals-overview.md
diff --git a/docs/concepts/more-info-about-mesos-overview.md b/docs/concepts/more-info-about-mesos-overview.md
new file mode 100644
index 0000000000..ddd9225fc7
--- /dev/null
+++ b/docs/concepts/more-info-about-mesos-overview.md
@@ -0,0 +1 @@
+more-info-about-mesos-overview.md
diff --git a/docs/concepts/observability.md b/docs/concepts/observability.md
new file mode 100644
index 0000000000..91a6dc9922
--- /dev/null
+++ b/docs/concepts/observability.md
@@ -0,0 +1 @@
+observability.md
diff --git a/docs/concepts/operating-mesos-overview.md b/docs/concepts/operating-mesos-overview.md
new file mode 100644
index 0000000000..d057eb8ed3
--- /dev/null
+++ b/docs/concepts/operating-mesos-overview.md
@@ -0,0 +1 @@
+operating-mesos-overview.md
diff --git a/docs/concepts/persistent-external-volumes.md b/docs/concepts/persistent-external-volumes.md
new file mode 100644
index 0000000000..cad10def95
--- /dev/null
+++ b/docs/concepts/persistent-external-volumes.md
@@ -0,0 +1 @@
+persistent-external-volumes.md
diff --git a/docs/concepts/quick-start-get-mesos-up-and-running.md b/docs/concepts/quick-start-get-mesos-up-and-running.md
new file mode 100644
index 0000000000..7a49b17a8c
--- /dev/null
+++ b/docs/concepts/quick-start-get-mesos-up-and-running.md
@@ -0,0 +1 @@
+quick-start-get-mesos-up-and-running.md
diff --git a/docs/concepts/resource-mgmt-cluster-mgr-container-orchstn.md b/docs/concepts/resource-mgmt-cluster-mgr-container-orchstn.md
new file mode 100644
index 0000000000..70ef21658c
--- /dev/null
+++ b/docs/concepts/resource-mgmt-cluster-mgr-container-orchstn.md
@@ -0,0 +1 @@
+resource-management-cluster-manager-container-orchestration.md
diff --git a/docs/concepts/security-and-access-control.md b/docs/concepts/security-and-access-control.md
new file mode 100644
index 0000000000..ff8196a759
--- /dev/null
+++ b/docs/concepts/security-and-access-control.md
@@ -0,0 +1 @@
+security-and-access-control.md
diff --git a/docs/concepts/single-master.md b/docs/concepts/single-master.md
new file mode 100644
index 0000000000..40c776579b
--- /dev/null
+++ b/docs/concepts/single-master.md
@@ -0,0 +1 @@
+single-master.md
diff --git a/docs/concepts/storage.md b/docs/concepts/storage.md
new file mode 100644
index 0000000000..39136970ed
--- /dev/null
+++ b/docs/concepts/storage.md
@@ -0,0 +1 @@
+storage.md
diff --git a/docs/concepts/understanding-mesos-overview.md b/docs/concepts/understanding-mesos-overview.md
new file mode 100644
index 0000000000..38568a994d
--- /dev/null
+++ b/docs/concepts/understanding-mesos-overview.md
@@ -0,0 +1 @@
+understanding-mesos-overview.md
diff --git a/docs/concepts/using-containers-overview.md b/docs/concepts/using-containers-overview.md
new file mode 100644
index 0000000000..888effcd52
--- /dev/null
+++ b/docs/concepts/using-containers-overview.md
@@ -0,0 +1 @@
+using-containers-overview.md
diff --git a/docs/concepts/what-is-mesos.md b/docs/concepts/what-is-mesos.md
new file mode 100644
index 0000000000..5310f3d090
--- /dev/null
+++ b/docs/concepts/what-is-mesos.md
@@ -0,0 +1,9 @@
+what-is-mesos.md
+
+# What is Mesos?
+
+# How does it fit into a typical DC software stack?
+
+# How can it be used to solve typical problems faced by DC operators/users?
+
+# How does it relate to Marathon, Aurora, Cook, Kubernetes, etc.?
diff --git a/docs/home.md b/docs/home.md
index a5811480de..c3881a2ec7 100644
--- a/docs/home.md
+++ b/docs/home.md
@@ -5,102 +5,200 @@ layout: documentation
 
 # Documentation
 
-## Mesos Fundamentals
-
-* [Mesos Architecture](architecture.md) providing an overview of Mesos concepts.
-* [Video and Slides of Mesos Presentations](presentations.md)
-
-## Running Mesos
-
-* [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.
-* [HTTP Endpoints](endpoints/) for available HTTP endpoints.
-* [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 Volume Support](docker-volume.md)
-    * [CNI support](cni.md)
-  * [Docker Containerizer](docker-containerizer.md) for launching a Docker image as a Task,
or as an Executor.
-* [Roles](roles.md)
-* [Weights](weights.md)
+## Understanding Mesos
+* [Overview](./concepts/understanding-mesos-overview.md)
+* [Quick Start: Get Your Mesos Cluster Up and Running](./concepts/quick-start-get-mesos-up-and-running.md)
+  * Quickly run a cluster to help you understand Mesos. {To be written - please contribute.}
+* [What is Mesos? How does it relate to the world?](./concepts/what-is-mesos.md):
+  * How does it fit into a typical DC software stack? {To be written - please contribute.}
+  * How can it be used to solve typical problems faced by DC operators/users? {To be written
- please contribute.}
+  * How does it relate to Marathon, Aurora, Cook, Kubernetes, etc.? {To be written - please
contribute.}
+* [Concepts](architecture.md)  <To be restructured, as follows.>
+  * [What components make up “Mesos” and how do they interrelate?](mesos-components.md)
+    * Masters and agents {To be written - please contribute.}
+    * Schedulers and executors {To be written - please contribute.}
+    * Offers {To be written - please contribute.}
+    * Containers and isolation {To be written - please contribute.}
+  * [Resource Management vs Cluster Manager vs Container Orchestration](./concepts/resource-mgmt-cluster-mgr-container-orchstn.md)
+    * A comparison of these three important elements {To be written - please contribute.}
+
+## Downloading, Installing, and Building Mesos
+* [Overview](./concepts/downloading-building-installing-overview.md)
+  * Reference “Quick Start: Get Your Mesos Cluster Up and Running {To be written - please
contribute.}
+  * Role-based workflow illustration {To be written - please contribute.}
+* [Installing Mesos](getting-started.md) <To be restructured, as follows.>
+    * [CentOS 6.6](./tasks/intallation-centos-6.6.md)
+    * [CentOS 7.1](./tasks/intallation-centos-7.1.md)
+    * [Mac OS X](./tasks/intallation-mac-os-x.md)
+    * [Ubuntu 14.04 LTS](./tasks/intallation-ubuntu-14.04.md)
+    * [Ubuntu 16.04 LTS](./tasks/intallation-ubuntu-16.04.md)
+    * [Windows](./tasks/intallation-windows.md)
+    * [Posix (Building Mesos)](./tasks/intallation-posix.md)
+    * [Using Vagrant](./tasks/intallation-vagrant.md)
+    * [Using DC/OS (cloud)](./tasks/intallation-dcos.md)
+    * [Using ACS](./tasks/intallation-acs.md)(an easy way to play around with a Mesos cluster
- use for quickstart?)
+* [Intallation Tools](tools.md)
+* [Frameworks](frameworks.md): a list of apps built on top of Mesos and instructions on how
to run them.
+* [Release notes](upgrades.md)
+
+## Operating Mesos
+* [Overview](./concepts/operating-mesos-overview.md)
+  * Role-based workflow illustration. {To be written - please contribute.}
+* [Configure Mesos](./concepts/configure-mesos.md)
+  * [Operational Guide](operational-guide.md)*
+  * [Choosing a Type of Deployment](./concepts/choosing-a-type-of-deployment.md)
+  * [Tools](tools.md)
+  * [Configure Masters](./tasks/configure-masters.md)
+    * [Configuration Options](configuration.md)
+  * [Configure Agents](./tasks/configure-agents.md)
+  * [Configure Operating Systems](./tasks/configure-operating-systems.md)
+  * [Configuration Options](./references/configuration-options.md)
+    * Both {To be written - please contribute.}
+    * Master only {To be written - please contribute.}
+    * Agent only {To be written - please contribute.}
+* [Masters](./concepts/masters.md)
+  * [Single Master](./concepts/single-master.md)
+  * [Multiple High-Availability Masters](high-availability.md)
+    * [Replicated Log](replicated-log-internals.md): information on the Mesos replicated
log.
+  * [Observability](./concepts/observability.md)
+    * [Logging](logging.md)
+    * [Monitoring and Metrics](monitoring.md)
+    * [Configuration Options](configuration.md)
+  * [Framework Rate Limiting](framework-rate-limiting.md)
+* [Agents](./concepts/agents.md)
+  * [Recovery](agent-recovery.md): Do seamless agent upgrades and allow executors to survive
`mesos-agent` crashes.
+  * [Sandbox](sandbox.md) describes a useful debugging arena for most users.
+  * [Attributes](attributes-resources.md)
+  * [Resources (Discovery and Creation)](attributes-resources.md)
+    * CPU {To be written - please contribute.}
+    * Memory {To be written - please contribute.}
+    * [GPU](gpu-support.md)
+  * [Agent Isolators](./concepts/agent-isolators.md)
+  * [Configuration Options](configuration.md)
+* [Modules](modules.md): Specifying Mesos modules for master, agent and tests.
+  * tbd {To be written - please contribute.}
+* [Resource Allocation](allocation-module.md)
+  * [DRF](./concepts/drf.md)
+  * [Roles](roles.md)
+  * [Weights](weights.md)
+  * [Quotas](quota.md): how to configure Mesos to provide guaranteed resource allocations
for use by a role.
+  * [Oversubscription](oversubscription.md): how to configure Mesos to take advantage of
unused resources to launch "best-effort" tasks.
+  * [Reservations](reservation.md): how operators and frameworks can reserve resources on
individual agents for use by a role.
+  * [Disk resources](./concepts/disk-resources.md)
+* [Performing Maintenance](maintenance.md)
+  * [Upgrade](upgrades.md) a running Mesos cluster.
+* [Security and Access Control](./concepts/security-and-access-control.md)
 * [Authentication](authentication.md)
 * [Authorization](authorization.md)
-* [Framework Rate Limiting](framework-rate-limiting.md)
+  * [SSL](ssl.md)
+
+## Using Containers
+* [Overview](./concepts/using-containers-overview.md)
+  * Role-based workflow illustration <To be illustrated - please contribute.>
+* [Tools](tools.md)
+  * tbd {To be written - please contribute.}
+* [Docker Volumes](docker-volume.md)
+* [Run a container using Mesos executor](./tasks/run-a-container-using-mesos-executor.md)
+* [Containerizer](containerizer.md) overview and use cases.
+  * [Container Images](container-image.md)
+* [Fetching](fetcher.md)
+* [Provisioning](./concepts/provisioning.md)
+* [Metrics](monitoring.md)
 * [Logging](logging.md)
-* [High Availability](high-availability.md) for running multiple masters simultaneously.
-* [Operational Guide](operational-guide.md)
-* [Monitoring](monitoring.md)
-* [Agent Recovery](agent-recovery.md) for doing seamless agent upgrades and allowing executors
to survive `mesos-agent` crashes.
-* [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.
-* [Container Image](container-image.md) for supporting container images in Mesos containerizer.
-* [Windows Support](windows.md) for the state of Windows support in Mesos.
-
-## Advanced Features
-
-* [Attributes and Resources](attributes-resources.md) for how to describe the agents that
comprise a cluster.
-* [Fetcher Cache](fetcher.md) for how to configure the Mesos fetcher cache.
 * [Networking](networking.md)
   * [Container Network Interface (CNI)](cni.md)
   * [Port Mapping Isolator](port-mapping-isolator.md)
-* [Nvidia GPU Support](gpu-support.md) for how to run Mesos with Nvidia GPU support.
-* [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.
-* [Multiple Disks](multiple-disk.md) for how to to allow tasks to use multiple isolated disk
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.
-* [Replicated Log](replicated-log-internals.md) for information on the Mesos replicated log.
-* [Shared Resources](shared-resources.md) for how to share persistent volumes between tasks
managed by different executors on the same agent.
-
-## APIs
-* [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.
-* [Operator HTTP API](operator-http-api.md) describes the new HTTP API for communication
between operators and Mesos master/agent.
-* [API Client Libraries](api-client-libraries.md) lists client libraries for the HTTP APIs.
-* [Versioning](versioning.md) describes HTTP API and release versioning.
-* [Javadoc](/api/latest/java/) documents the old Java API.
-* [Doxygen](/api/latest/c++/namespacemesos.html) documents the C++ API.
-
-## Running Mesos Frameworks
-
-* [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.
+* [Storage](./concepts/storage.md)
+  * [Persistent Local Volumes](persistent-volume.md): Allow tasks to access persistent storage
resources
+  [Shared Resources](shared-resources.md): Share persistent volumes between tasks managed
by different executors on the same agent
+  * [Persistent External Volumes](./concepts/persistent-external-volumes.md)
+  * [Multiple Disks](multiple-disk.md): how to to allow tasks to use multiple isolated disk
resources
+* [GPU support](gpu-support.md) (Nvidia)
 
 ## Developing Mesos Frameworks
-
-* [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.
-* [Developer Tools](tools.md) for hacking on Mesos or writing frameworks.
-
-## Extending Mesos
-
-* [Mesos Modules](modules.md) for specifying Mesos modules for master, agent and tests.
-* [Allocation Modules](allocation-module.md) for how to write custom resource allocators.
-
-## Contributing to Mesos
-
-* [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.
-* [Reopening a Review](reopening-reviews.md) for our policy around reviving reviews on ReviewBoard.
-* [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.
-* [Working groups](working-groups.md) a listing of groups working on different components.
+* [Overview](./concepts/developing-mesos-frameworks-overview.md)
+  * Role-based workflow illustration. <To be illustrated - please contribute.>
+  * [Framework Development Guide](app-framework-development-guide.md)
+* [Schedulers](./concepts/developing-schedulers.md)
+* [Executors](./concepts/developing-executors.md)
+  * Command Executor {To be written - please contribute.}
+  * Custom Executors {To be written - please contribute.}
+* [Resource Offers](./concepts/developing-resource-offers.md)
+* [Allocation Modules](allocation-module.md): how to write custom resource allocators.
+* [Advanced Resource Types](./concepts/developing-advanced-resource-types.md)
+  * Reservations {To be written - please contribute.}
+  * Persistent Volumes {To be written - please contribute.}
+  * GPUs {To be written - please contribute.}
+* [High Availability](high-availability-framework-guide.md)
+  * [Reconciliation](reconciliation.md): Ensuring a framework's state remains eventually
consistent in the face of failures
+* [Containers](./concepts/developing-containers.md)
+  * [Mesos Containerizer](./concepts/developing-mesos-containerizer.md)
+    * [Images](container-image.md)
+    * Disks {To be written - please contribute.}
+    * Networking {To be written - please contribute.}
+  * [Containerizer](containerizer.md) overview and use cases.
+    * [Containerizer Internals](containerizer-internals.md): implementation details of containerizers.
+    * [Mesos Containerizer](mesos-containerizer.md) default containerizer, supports both
Linux and POSIX systems.
+      * [Docker Volume Support](docker-volume.md)
+      * [CNI support](cni.md)
+    * [Docker Containerizer](docker-containerizer.md): launching a Docker image as a Task,
or as an Executor.
+* [Tools](tools.md)
+
+
+## Mesos APIs
+* [Overview](./concepts/mesos-apis-overview.md)
+* [API Concepts (Architecture)](./concepts/api-concepts.md)
+* [Authentication and Authorization](./concepts/authentication-and-authorization.md)
+* [Scheduler HTTP API](scheduler-http-api.md) describes the new HTTP API: communication between
schedulers and the Mesos master.
+* [Executor HTTP API](executor-http-api.md) describes the new HTTP API: communication between
executors and the Mesos agent.
+* [Operator HTTP API](operator-http-api.md) describes the new HTTP API: communication between
operators and Mesos master/agent.
+
+* [HTTP Endpoints](endpoints/)
+* [API Client Libraries](api-client-libraries.md): the HTTP APIs
+* [Versioning](versioning.md): HTTP API and releases
+* [Javadoc](/api/latest/java/) documents the old Java API
 * [Doxygen](/api/latest/c++/) documents the internal Mesos APIs.
-* [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
+* [Doxygen](/api/latest/c++/namespacemesos.html) documents the C++ API
 
+## Contributing to Mesos
+* [Overview](./concepts/contributing-to-mesos-overview.md)
+  * Role-based workflow illustration <To be illustrated - please contribute.>
+* [Design Documents](./concepts/design-documents.md)
+* [Developer Community](./concepts/developer-community.md)
+  * [How To Get Involved](./concepts/how-to-get-involved.md)
+    * [Reporting Issues](reporting-a-bug.md)
+    * [Proposing Changes](reporting-a-bug.md)
+    * [Submitting a Patch](submitting-a-patch.md)
+    * [Reopening a Review](reopening-reviews.md)
+    * [Effective Code Reviewing](effective-code-reviewing.md) guidelines, tips, and learnings
for how to do effective code reviews.
+    * [Committing](committing.md) guidelines for committing changes.
+  * [Committers and Maintainers](committers.md) a listing of project committers and component
maintainers; useful when seeking feedback.
+  * [Working groups](working-groups.md) a listing of groups working on different components.
+* [Development Practices](./concepts/development-practices.md)
+  * [Engineering Principles](engineering-principles-and-practices.md) to serve as a shared
set of project-level values for the community.
+  * [C++ Style Guide](./concepts/cpp-style-guide.md)
+  * [Testing Patterns](testing-patterns.md): tips and tricks used in Mesos tests.
+  * [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)
+
+  * [Code Reviewing Guidelines](./concepts/code-reviewing-guidelines.md)
+  * [Committing Guidelines](./concepts/committing-guidelines.md)
+  * [Development Roadmap](roadmap.md)
+  * [Release Guide](release-guide.md)
+
+
+## Mesos Internals
+* [Overview](./concepts/mesos-internals-overview.md)
+* [Fetcher Cache Internals](fetcher-cache-internals.md)
+* [Containerizer Internals](containerizer-internals.md)
+
+
+
+## More Information about Mesos
+* [Overview](./concepts/more-info-about-mesos-overview.md)
+* [Video and Slides of Mesos Presentations](presentations.md)
 * [Powered by Mesos](powered-by-mesos.md) lists organizations and software that are powered
by Apache Mesos.
 * [Academic Papers and Project History](https://www.usenix.org/conference/nsdi11/mesos-platform-fine-grained-resource-sharing-data-center)
 * [Design docs](design-docs.md) list of design documents for various Mesos features
@@ -127,3 +225,7 @@ layout: documentation
   <p class="text-center">Mesos in Action by Roger Ignazio (Manning, 2016)
   </div>
 </div>
+
+## Dog Pound (where topics go while they’re looking for a home)
+
+* [Windows Support](windows.md): the state of Windows support in Mesos.
diff --git a/docs/references/configuration-options.md b/docs/references/configuration-options.md
new file mode 100644
index 0000000000..ad41658db3
--- /dev/null
+++ b/docs/references/configuration-options.md
@@ -0,0 +1 @@
+configuration-options.md
diff --git a/docs/tasks/configure-agents.md b/docs/tasks/configure-agents.md
new file mode 100644
index 0000000000..2fdbea5b85
--- /dev/null
+++ b/docs/tasks/configure-agents.md
@@ -0,0 +1 @@
+configure-agents.md
diff --git a/docs/tasks/configure-masters.md b/docs/tasks/configure-masters.md
new file mode 100644
index 0000000000..9d9437e5ed
--- /dev/null
+++ b/docs/tasks/configure-masters.md
@@ -0,0 +1 @@
+configure-masters.md
diff --git a/docs/tasks/configure-operating-systems.md b/docs/tasks/configure-operating-systems.md
new file mode 100644
index 0000000000..0d00a20a0b
--- /dev/null
+++ b/docs/tasks/configure-operating-systems.md
@@ -0,0 +1 @@
+configure-operating-systems.md
diff --git a/docs/tasks/intallation-acs.md b/docs/tasks/intallation-acs.md
new file mode 100644
index 0000000000..6c1d3d9b2b
--- /dev/null
+++ b/docs/tasks/intallation-acs.md
@@ -0,0 +1,10 @@
+intallation-acs.md
+
+# Install from source
+# Install from packages]
+## Download]
+## Build]
+## Install]
+## Build Options (reference)]
+## Upgrading]
+# Build Example Frameworks
diff --git a/docs/tasks/intallation-centos-6.6.md b/docs/tasks/intallation-centos-6.6.md
new file mode 100644
index 0000000000..34b6661f81
--- /dev/null
+++ b/docs/tasks/intallation-centos-6.6.md
@@ -0,0 +1,10 @@
+intallation-centos-6.6.md
+
+# Install from source
+# Install from packages]
+## Download]
+## Build]
+## Install]
+## Build Options (reference)]
+## Upgrading]
+# Build Example Frameworks
diff --git a/docs/tasks/intallation-centos-7.1.md b/docs/tasks/intallation-centos-7.1.md
new file mode 100644
index 0000000000..34b6661f81
--- /dev/null
+++ b/docs/tasks/intallation-centos-7.1.md
@@ -0,0 +1,10 @@
+intallation-centos-6.6.md
+
+# Install from source
+# Install from packages]
+## Download]
+## Build]
+## Install]
+## Build Options (reference)]
+## Upgrading]
+# Build Example Frameworks
diff --git a/docs/tasks/intallation-dcos.md b/docs/tasks/intallation-dcos.md
new file mode 100644
index 0000000000..e40027675e
--- /dev/null
+++ b/docs/tasks/intallation-dcos.md
@@ -0,0 +1,10 @@
+intallation-dcos.md
+
+# Install from source
+# Install from packages]
+## Download]
+## Build]
+## Install]
+## Build Options (reference)]
+## Upgrading]
+# Build Example Frameworks
diff --git a/docs/tasks/intallation-mac-os-x.md b/docs/tasks/intallation-mac-os-x.md
new file mode 100644
index 0000000000..bb73496dc8
--- /dev/null
+++ b/docs/tasks/intallation-mac-os-x.md
@@ -0,0 +1,10 @@
+intallation-mac-os-x.md
+
+# Install from source
+# Install from packages]
+## Download]
+## Build]
+## Install]
+## Build Options (reference)]
+## Upgrading]
+# Build Example Frameworks
diff --git a/docs/tasks/intallation-posix.md b/docs/tasks/intallation-posix.md
new file mode 100644
index 0000000000..fea460c3af
--- /dev/null
+++ b/docs/tasks/intallation-posix.md
@@ -0,0 +1,10 @@
+intallation-posix.md
+
+# Install from source
+# Install from packages]
+## Download]
+## Build]
+## Install]
+## Build Options (reference)]
+## Upgrading]
+# Build Example Frameworks
diff --git a/docs/tasks/intallation-ubuntu-14.04.md b/docs/tasks/intallation-ubuntu-14.04.md
new file mode 100644
index 0000000000..291a7c23c1
--- /dev/null
+++ b/docs/tasks/intallation-ubuntu-14.04.md
@@ -0,0 +1,10 @@
+intallation-ubuntu-14.04.md
+
+# Install from source
+# Install from packages]
+## Download]
+## Build]
+## Install]
+## Build Options (reference)]
+## Upgrading]
+# Build Example Frameworks
diff --git a/docs/tasks/intallation-ubuntu-16.04.md b/docs/tasks/intallation-ubuntu-16.04.md
new file mode 100644
index 0000000000..573460bdf7
--- /dev/null
+++ b/docs/tasks/intallation-ubuntu-16.04.md
@@ -0,0 +1,10 @@
+intallation-ubuntu-16.04.md
+
+# Install from source
+# Install from packages]
+## Download]
+## Build]
+## Install]
+## Build Options (reference)]
+## Upgrading]
+# Build Example Frameworks
diff --git a/docs/tasks/intallation-vagrant.md b/docs/tasks/intallation-vagrant.md
new file mode 100644
index 0000000000..5463afd9e0
--- /dev/null
+++ b/docs/tasks/intallation-vagrant.md
@@ -0,0 +1,10 @@
+intallation-vagrant.md
+
+# Install from source
+# Install from packages]
+## Download]
+## Build]
+## Install]
+## Build Options (reference)]
+## Upgrading]
+# Build Example Frameworks
diff --git a/docs/tasks/intallation-windows.md b/docs/tasks/intallation-windows.md
new file mode 100644
index 0000000000..12671588bd
--- /dev/null
+++ b/docs/tasks/intallation-windows.md
@@ -0,0 +1,10 @@
+intallation-windows.md
+
+# Install from source
+# Install from packages]
+## Download]
+## Build]
+## Install]
+## Build Options (reference)]
+## Upgrading]
+# Build Example Frameworks
diff --git a/docs/tasks/provisioning.md b/docs/tasks/provisioning.md
new file mode 100644
index 0000000000..1e730f95d7
--- /dev/null
+++ b/docs/tasks/provisioning.md
@@ -0,0 +1 @@
+provisioning.md
diff --git a/docs/tasks/run-a-container-using-mesos-executor.md b/docs/tasks/run-a-container-using-mesos-executor.md
new file mode 100644
index 0000000000..1f9214cae9
--- /dev/null
+++ b/docs/tasks/run-a-container-using-mesos-executor.md
@@ -0,0 +1 @@
+run-a-container-using-mesos-executor.md


 

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services

Mime
View raw message