Re: Mesos Documentation Project

[James Peach]

> On Nov 9, 2016, at 4:29 PM, James Neiman  wrote:
> 
> Dear Mesos Users, Operators, Developers, and Contributors:
> 
> My name is James Neiman. I have been working with Benjamin Hindman, Artem
> Harutyunyan, Neil Conway, and Joseph Wu on improving the Mesos
> documentation. We now have a proposal for the community to critique.
> 
> Our goal is to satisfy the needs of Operators, Developers, and Contributors
> by:
> 
>   - Revising, restructuring, and expanding existing topics.
>   - Authoring new topics, such as *Quick Start* and *What is Mesos?*.
>   - Reorganizing the table of contents.
>   - Providing role-specific views of the table of contents.
> 
>   *Please note that versioning of the documentation will be addressed in a
> separate project.*
> 
> This will be an iterative process. Your feedback and contributions are very
> important to making this project a success!
> 
> I will follow up very soon with a request for your comments on proposed
> changes. I look forward to your feedback.

Is the proposal github PR that Joseph linked, or is there more? Is there a 
rendered version of the PR available anywhere?

Are the “intallation-$platform.md” named intentionally, or the result of a 
typo? A lot of the headings on these pages have a trailing ‘]’. Is that markup 
or typo?

Did you consider switching to a more full-featured docs toolchain (I have had 
good experiences with sphinx) that can generate man pages, indices, TOC, 
cross-references, search, etc?

thanks,
James

Re: 答复: Mesos Documentation Project

[tommy xiao]

it's all good way for mesos community.  thanks a lot.

2016-11-10 9:32 GMT+08:00 Joseph Wu <jos...@mesosphere.io>:

> Because of the heavy amount of markdown changes, this proposal will live
> in a Github PR [1], which is presumably reachable.  We may also consider,
> as part of this project, migrating design documents for existing features
> off GoogleDocs and into markdown, so that they can live in the
> documentation too.
>
> That being said, you can usually use a VPN to bypass the "network
> limitations" ;)
>
> [1] https://github.com/apache/mesos/pull/178
>
>
> On Wed, Nov 9, 2016 at 5:03 PM, pangbingqiang <pangbingqi...@huawei.com>
> wrote:
>
>> It is really cool, but now mesos desigin doc on googledoc, china users
>> can not enter in to download because of network limitations.
>>
>> -邮件原件-
>> 发件人: James Neiman [mailto:jneima...@mesosphere.io]
>> 发送时间: 2016年11月10日 8:30
>> 收件人: dev@mesos.apache.org
>> 主题: Mesos Documentation Project
>>
>> Dear Mesos Users, Operators, Developers, and Contributors:
>>
>> My name is James Neiman. I have been working with Benjamin Hindman, Artem
>> Harutyunyan, Neil Conway, and Joseph Wu on improving the Mesos
>> documentation. We now have a proposal for the community to critique.
>>
>> Our goal is to satisfy the needs of Operators, Developers, and
>> Contributors
>> by:
>>
>>- Revising, restructuring, and expanding existing topics.
>>- Authoring new topics, such as *Quick Start* and *What is Mesos?*.
>>- Reorganizing the table of contents.
>>- Providing role-specific views of the table of contents.
>>
>>*Please note that versioning of the documentation will be addressed in
>> a separate project.*
>>
>> This will be an iterative process. Your feedback and contributions are
>> very important to making this project a success!
>>
>> I will follow up very soon with a request for your comments on proposed
>> changes. I look forward to your feedback.
>>
>> Sincerely,
>>
>>
>> James Neiman
>>
>> Technical Writing Consultant, Mesosphere
>>
>> jneima...@mesosphere.io
>>
>
>


-- 
Deshi Xiao
Twitter: xds2000
E-mail: xiaods(AT)gmail.com

Re: 答复: Mesos Documentation Project

[Joseph Wu]

Because of the heavy amount of markdown changes, this proposal will live in
a Github PR [1], which is presumably reachable.  We may also consider, as
part of this project, migrating design documents for existing features off
GoogleDocs and into markdown, so that they can live in the documentation
too.

That being said, you can usually use a VPN to bypass the "network
limitations" ;)

[1] https://github.com/apache/mesos/pull/178

On Wed, Nov 9, 2016 at 5:03 PM, pangbingqiang <pangbingqi...@huawei.com>
wrote:

> It is really cool, but now mesos desigin doc on googledoc, china users can
> not enter in to download because of network limitations.
>
> -邮件原件-
> 发件人: James Neiman [mailto:jneima...@mesosphere.io]
> 发送时间: 2016年11月10日 8:30
> 收件人: dev@mesos.apache.org
> 主题: Mesos Documentation Project
>
> Dear Mesos Users, Operators, Developers, and Contributors:
>
> My name is James Neiman. I have been working with Benjamin Hindman, Artem
> Harutyunyan, Neil Conway, and Joseph Wu on improving the Mesos
> documentation. We now have a proposal for the community to critique.
>
> Our goal is to satisfy the needs of Operators, Developers, and Contributors
> by:
>
>- Revising, restructuring, and expanding existing topics.
>- Authoring new topics, such as *Quick Start* and *What is Mesos?*.
>- Reorganizing the table of contents.
>- Providing role-specific views of the table of contents.
>
>*Please note that versioning of the documentation will be addressed in
> a separate project.*
>
> This will be an iterative process. Your feedback and contributions are
> very important to making this project a success!
>
> I will follow up very soon with a request for your comments on proposed
> changes. I look forward to your feedback.
>
> Sincerely,
>
>
> James Neiman
>
> Technical Writing Consultant, Mesosphere
>
> jneima...@mesosphere.io
>

答复: Mesos Documentation Project

[pangbingqiang]

It is really cool, but now mesos desigin doc on googledoc, china users can not 
enter in to download because of network limitations.

-邮件原件-
发件人: James Neiman [mailto:jneima...@mesosphere.io] 
发送时间: 2016年11月10日 8:30
收件人: dev@mesos.apache.org
主题: Mesos Documentation Project

Dear Mesos Users, Operators, Developers, and Contributors:

My name is James Neiman. I have been working with Benjamin Hindman, Artem 
Harutyunyan, Neil Conway, and Joseph Wu on improving the Mesos documentation. 
We now have a proposal for the community to critique.

Our goal is to satisfy the needs of Operators, Developers, and Contributors
by:

   - Revising, restructuring, and expanding existing topics.
   - Authoring new topics, such as *Quick Start* and *What is Mesos?*.
   - Reorganizing the table of contents.
   - Providing role-specific views of the table of contents.

   *Please note that versioning of the documentation will be addressed in a 
separate project.*

This will be an iterative process. Your feedback and contributions are very 
important to making this project a success!

I will follow up very soon with a request for your comments on proposed 
changes. I look forward to your feedback.

Sincerely,


James Neiman

Technical Writing Consultant, Mesosphere

jneima...@mesosphere.io

[GitHub] mesos pull request #178: WIP: Mesos Documentation Project Reorg Proposal

[jneimanmesos]

GitHub user jneimanmesos opened a pull request:

https://github.com/apache/mesos/pull/178

WIP: Mesos Documentation Project Reorg Proposal

This is an initial proposal for reorganizing the Mesos Documentation. 

Our goal is to satisfy the needs of Operators, Developers, and Contributors 
by:

  - Revising, restructuring, and expanding existing topics.
  - Authoring new topics, such as _Quick Start_ and _What is Mesos?_.
  - Reorganizing the table of contents.
  - Providing role-specific views of the table of contents.





You can merge this pull request into a Git repository by running:

$ git pull https://github.com/jneimanmesos/mesos master

Alternatively you can review and apply these changes as the patch at:

https://github.com/apache/mesos/pull/178.patch

To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:

This closes #178


commit cde169aaf4ececdf5d9138ed3807f4824d3d8806
Author: jneimanmesos <jneima...@mesosphere.com>
Date:   2016-11-10T00:55:30Z

    Mesos Documentation Project Reorg Proposal




---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---

Mesos Documentation Project

[James Neiman]

Dear Mesos Users, Operators, Developers, and Contributors:

My name is James Neiman. I have been working with Benjamin Hindman, Artem
Harutyunyan, Neil Conway, and Joseph Wu on improving the Mesos
documentation. We now have a proposal for the community to critique.

Our goal is to satisfy the needs of Operators, Developers, and Contributors
by:

   - Revising, restructuring, and expanding existing topics.
   - Authoring new topics, such as *Quick Start* and *What is Mesos?*.
   - Reorganizing the table of contents.
   - Providing role-specific views of the table of contents.

   *Please note that versioning of the documentation will be addressed in a
separate project.*

This will be an iterative process. Your feedback and contributions are very
important to making this project a success!

I will follow up very soon with a request for your comments on proposed
changes. I look forward to your feedback.

Sincerely,


James Neiman

Technical Writing Consultant, Mesosphere

jneima...@mesosphere.io