You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@myriad.apache.org by Will Ochandarena <wo...@maprtech.com> on 2015/07/31 01:42:34 UTC
Introducing Ruth - documentation
Myriad Team, I want to introduce you to Ruth Harris from the MapR
documentation team. She'll be leading the lead on documentation for
Myriad, hopefully with ample help from each of you.
She's been digging into Myriad for a few weeks now, and has a preliminary
outline. I'll let her reply to this and send it to start getting feedback.
One thing she needs is a place to start posting to. Looking at other
Apache projects, it seems like the most common practice is to use a
gh-pages branch of the main github
<https://github.com/apache/incubator-myriad>.
Adam - could you create the branch so she has something to send PRs to?
Jim - you seem to be our resident web/css expert. Any chance you could
build a simple layout for the doc site?
Thanks!
Will
Re: Introducing Ruth - documentation
Posted by Adam Bordelon <ad...@mesosphere.io>.
Thanks for the link. While I personally prefer ReviewBoard's feature-set
(multi-line select, tracking patch issues) for larger code changes, github
PRs are nice for reviewing (generated) markdown, and fine for
documentation/small changes. But, yeah, well, that's just like, my opinion,
man.
On Fri, Jul 31, 2015 at 8:20 AM, Jim Scott <js...@maprtech.com> wrote:
> Thanks for sharing that. I was looking for more information on it, as the
> Apache Drill team is also moving in this direction, and is a little further
> ahead, but I was not finding the right information to share back with the
> group.
>
> Most of the projects are tending toward this process now as it is becoming
> much easier to manage, offers a higher level of visibility and makes it
> that much easier on contributors and committers.
>
>
> On Fri, Jul 31, 2015 at 10:13 AM, Jim Klucar <kl...@gmail.com> wrote:
>
> > Adam,
> >
> > Apache has actually improved github integration. I talked to an Accumulo
> > committer because I know they interact with people via github sometimes.
> He
> > pointed me here
> >
> >
> >
> https://blogs.apache.org/infra/entry/improved_integration_between_apache_and
> >
> >
> > On Thu, Jul 30, 2015 at 7:52 PM, Adam Bordelon <ad...@mesosphere.io>
> wrote:
> >
> > > We should start with our Confluence wiki:
> > > https://cwiki.apache.org/confluence/display/MYRIAD/Myriad+Home
> > > It's also recommended that we create a proper website at
> > > http://myriad.incubator.apache.org/
> > >
> > > I'd rather we didn't rely on gh-pages, especially since the github repo
> > is
> > > just a mirror of Apache git, so we can't actually use github PRs
> without
> > > downloading the patches, applying them locally, and then pushing to
> > Apache
> > > git.
> > >
> > > On Thu, Jul 30, 2015 at 4:42 PM, Will Ochandarena <
> > > wochandarena@maprtech.com
> > > > wrote:
> > >
> > > > Myriad Team, I want to introduce you to Ruth Harris from the MapR
> > > > documentation team. She'll be leading the lead on documentation for
> > > > Myriad, hopefully with ample help from each of you.
> > > >
> > > > She's been digging into Myriad for a few weeks now, and has a
> > preliminary
> > > > outline. I'll let her reply to this and send it to start getting
> > > feedback.
> > > >
> > > > One thing she needs is a place to start posting to. Looking at other
> > > > Apache projects, it seems like the most common practice is to use a
> > > > gh-pages branch of the main github
> > > > <https://github.com/apache/incubator-myriad>.
> > > >
> > > > Adam - could you create the branch so she has something to send PRs
> to?
> > > > Jim - you seem to be our resident web/css expert. Any chance you
> could
> > > > build a simple layout for the doc site?
> > > >
> > > > Thanks!
> > > > Will
> > > >
> > >
> >
>
>
>
> --
> *Jim Scott*
> Director, Enterprise Strategy & Architecture
> +1 (347) 746-9281
>
> <http://www.mapr.com/>
> [image: MapR Technologies] <http://www.mapr.com>
>
> Now Available - Free Hadoop On-Demand Training
> <
> http://www.mapr.com/training?utm_source=Email&utm_medium=Signature&utm_campaign=Free%20available
> >
>
Re: Introducing Ruth - documentation
Posted by Jim Scott <js...@maprtech.com>.
Thanks for sharing that. I was looking for more information on it, as the
Apache Drill team is also moving in this direction, and is a little further
ahead, but I was not finding the right information to share back with the
group.
Most of the projects are tending toward this process now as it is becoming
much easier to manage, offers a higher level of visibility and makes it
that much easier on contributors and committers.
On Fri, Jul 31, 2015 at 10:13 AM, Jim Klucar <kl...@gmail.com> wrote:
> Adam,
>
> Apache has actually improved github integration. I talked to an Accumulo
> committer because I know they interact with people via github sometimes. He
> pointed me here
>
>
> https://blogs.apache.org/infra/entry/improved_integration_between_apache_and
>
>
> On Thu, Jul 30, 2015 at 7:52 PM, Adam Bordelon <ad...@mesosphere.io> wrote:
>
> > We should start with our Confluence wiki:
> > https://cwiki.apache.org/confluence/display/MYRIAD/Myriad+Home
> > It's also recommended that we create a proper website at
> > http://myriad.incubator.apache.org/
> >
> > I'd rather we didn't rely on gh-pages, especially since the github repo
> is
> > just a mirror of Apache git, so we can't actually use github PRs without
> > downloading the patches, applying them locally, and then pushing to
> Apache
> > git.
> >
> > On Thu, Jul 30, 2015 at 4:42 PM, Will Ochandarena <
> > wochandarena@maprtech.com
> > > wrote:
> >
> > > Myriad Team, I want to introduce you to Ruth Harris from the MapR
> > > documentation team. She'll be leading the lead on documentation for
> > > Myriad, hopefully with ample help from each of you.
> > >
> > > She's been digging into Myriad for a few weeks now, and has a
> preliminary
> > > outline. I'll let her reply to this and send it to start getting
> > feedback.
> > >
> > > One thing she needs is a place to start posting to. Looking at other
> > > Apache projects, it seems like the most common practice is to use a
> > > gh-pages branch of the main github
> > > <https://github.com/apache/incubator-myriad>.
> > >
> > > Adam - could you create the branch so she has something to send PRs to?
> > > Jim - you seem to be our resident web/css expert. Any chance you could
> > > build a simple layout for the doc site?
> > >
> > > Thanks!
> > > Will
> > >
> >
>
--
*Jim Scott*
Director, Enterprise Strategy & Architecture
+1 (347) 746-9281
<http://www.mapr.com/>
[image: MapR Technologies] <http://www.mapr.com>
Now Available - Free Hadoop On-Demand Training
<http://www.mapr.com/training?utm_source=Email&utm_medium=Signature&utm_campaign=Free%20available>
Re: Introducing Ruth - documentation
Posted by Jim Klucar <kl...@gmail.com>.
Adam,
Apache has actually improved github integration. I talked to an Accumulo
committer because I know they interact with people via github sometimes. He
pointed me here
https://blogs.apache.org/infra/entry/improved_integration_between_apache_and
On Thu, Jul 30, 2015 at 7:52 PM, Adam Bordelon <ad...@mesosphere.io> wrote:
> We should start with our Confluence wiki:
> https://cwiki.apache.org/confluence/display/MYRIAD/Myriad+Home
> It's also recommended that we create a proper website at
> http://myriad.incubator.apache.org/
>
> I'd rather we didn't rely on gh-pages, especially since the github repo is
> just a mirror of Apache git, so we can't actually use github PRs without
> downloading the patches, applying them locally, and then pushing to Apache
> git.
>
> On Thu, Jul 30, 2015 at 4:42 PM, Will Ochandarena <
> wochandarena@maprtech.com
> > wrote:
>
> > Myriad Team, I want to introduce you to Ruth Harris from the MapR
> > documentation team. She'll be leading the lead on documentation for
> > Myriad, hopefully with ample help from each of you.
> >
> > She's been digging into Myriad for a few weeks now, and has a preliminary
> > outline. I'll let her reply to this and send it to start getting
> feedback.
> >
> > One thing she needs is a place to start posting to. Looking at other
> > Apache projects, it seems like the most common practice is to use a
> > gh-pages branch of the main github
> > <https://github.com/apache/incubator-myriad>.
> >
> > Adam - could you create the branch so she has something to send PRs to?
> > Jim - you seem to be our resident web/css expert. Any chance you could
> > build a simple layout for the doc site?
> >
> > Thanks!
> > Will
> >
>
Re: Introducing Ruth - documentation
Posted by Adam Bordelon <ad...@mesosphere.io>.
We should start with our Confluence wiki:
https://cwiki.apache.org/confluence/display/MYRIAD/Myriad+Home
It's also recommended that we create a proper website at
http://myriad.incubator.apache.org/
I'd rather we didn't rely on gh-pages, especially since the github repo is
just a mirror of Apache git, so we can't actually use github PRs without
downloading the patches, applying them locally, and then pushing to Apache
git.
On Thu, Jul 30, 2015 at 4:42 PM, Will Ochandarena <wochandarena@maprtech.com
> wrote:
> Myriad Team, I want to introduce you to Ruth Harris from the MapR
> documentation team. She'll be leading the lead on documentation for
> Myriad, hopefully with ample help from each of you.
>
> She's been digging into Myriad for a few weeks now, and has a preliminary
> outline. I'll let her reply to this and send it to start getting feedback.
>
> One thing she needs is a place to start posting to. Looking at other
> Apache projects, it seems like the most common practice is to use a
> gh-pages branch of the main github
> <https://github.com/apache/incubator-myriad>.
>
> Adam - could you create the branch so she has something to send PRs to?
> Jim - you seem to be our resident web/css expert. Any chance you could
> build a simple layout for the doc site?
>
> Thanks!
> Will
>
Fwd: Introducing Ruth - documentation
Posted by Ruth Harris <rh...@maprtech.com>.
Hi Luciano, Adam, Danese, and Team,
(Resending...)
Thank you everyone for welcoming me. I'm ready to roll up my sleeves and
get to work.
1. I've sent an email to start the process re: an ICLA
2. I've also created an Apache Wiki account and can access the Myriad
Wiki, but when I checked today, I didn't have Edit or Create page
permissions.
3. *Could the space administrator please grant me permissions?*
4. I've also done some basic editing on the .markdown files from GitHub
Phase 1. (I have copies on my local system.) *If there are no objections*,
I'll convert the .md files to confluence and put the cleaned up versions in
the wiki.
5. The following is an initial outline for Myriad Open Source. Please
review and provide feedback: I.E. Too many topics, wrong type of topics,
missing topics, etc.
An initial draft is targeted August 17th (< 2 weeks) *unless* you all think
it is too aggressive. Obviously, I'll need help with the topics:
Major Topics
-
Description (aka: what it is)
-
Use Cases (aka: why and how it is used)
-
Architecture (aka: how it works)
-
RMs (ResourceManager) and NM (NodeManager) in Mesos Containers
-
NodeManager Profiles
-
Fine-grained Scaling
-
High Availability (HA)
-
Installation
-
Pre-installation and prerequisites
-
Installation (generic)
-
Post-installation and configuration
-
Administration (aka: how to use it)
-
Launching Myriad
-
Scaling (Flex up/down on nodes, see REST API)
-
Running YARN apps
-
Stopping
- Configuring
- Monitoring
- REST API
-
PUT /api/cluster/flexup
-
PUT /api/cluster/flexdown
-
GET /api/state
GET /api/config
On Thu, Jul 30, 2015 at 5:16 PM, Luciano Resende <lu...@gmail.com>
wrote:
>
>
> On Thu, Jul 30, 2015 at 5:09 PM, Adam Bordelon <ad...@mesosphere.io> wrote:
>
>> Oh, absolutely. We'll have to vote in new committers at this point, and
>> there are a few other active contributors (e.g. Brandon, Darin) that are
>> already in the queue there.
>> For the wiki, however, we don't need to grant committer privileges to give
>> Ruth edit permissions.
>>
>
> All substantial contributions should be backed by a an ICLA [1], so I
> would recommend that Ruth file a ICLA before any substantial contribution
> to the wiki.
>
> [1] https://www.apache.org/licenses/icla.txt
>
>
> --
> Luciano Resende
> http://people.apache.org/~lresende
> http://twitter.com/lresende1975
> http://lresende.blogspot.com/
>
--
Ruth Harris
Sr. Technical Writer, MapR
--
Ruth Harris
Sr. Technical Writer, MapR
Re: Introducing Ruth - documentation
Posted by Ruth Harris <rh...@maprtech.com>.
Hi Luciano, Adam, Danese, and Team,
Thank you everyone for welcoming me. I'm ready to roll up my sleeves and
get to work.
1. I've sent an email to start the process re: an ICLA
2. I've also created an Apache Wiki account and can access the Myriad
Wiki, but when I checked today, I didn't have Edit or Create page
permissions.
3. *Could the space administrator please grant me permissions?*
4. I've also done some basic editing on the .markdown files from GitHub
Phase 1. (I have copies on my local system.) *If there are no objections*,
I'll convert the .md files to confluence and put the cleaned up versions in
the wiki.
5. The following is an initial outline for Myriad Open Source. Please
review and provide feedback: I.E. Too many topics, wrong type of topics,
missing topics, etc.
An initial draft is targeted August 17th (< 2 weeks) *unless* you all think
it is too aggressive. Obviously, I'll need help with the topics:
Major Topics
-
Description (aka: what it is)
-
Use Cases (aka: why and how it is used)
-
Architecture (aka: how it works)
-
RMs (ResourceManager) and NM (NodeManager) in Mesos Containers
-
NodeManager Profiles
-
Fine-grained Scaling
-
High Availability (HA)
-
Installation
-
Pre-installation and prerequisites
-
Installation (generic)
-
Post-installation and configuration
-
Administration (aka: how to use it)
-
Launching Myriad
-
Scaling (Flex up/down on nodes, see REST API)
-
Running YARN apps
-
Stopping
- Configuring
- Monitoring
- REST API
-
PUT /api/cluster/flexup
-
PUT /api/cluster/flexdown
-
GET /api/state
GET /api/config
On Thu, Jul 30, 2015 at 5:16 PM, Luciano Resende <lu...@gmail.com>
wrote:
>
>
> On Thu, Jul 30, 2015 at 5:09 PM, Adam Bordelon <ad...@mesosphere.io> wrote:
>
>> Oh, absolutely. We'll have to vote in new committers at this point, and
>> there are a few other active contributors (e.g. Brandon, Darin) that are
>> already in the queue there.
>> For the wiki, however, we don't need to grant committer privileges to give
>> Ruth edit permissions.
>>
>
> All substantial contributions should be backed by a an ICLA [1], so I
> would recommend that Ruth file a ICLA before any substantial contribution
> to the wiki.
>
> [1] https://www.apache.org/licenses/icla.txt
>
>
> --
> Luciano Resende
> http://people.apache.org/~lresende
> http://twitter.com/lresende1975
> http://lresende.blogspot.com/
>
--
Ruth Harris
Sr. Technical Writer, MapR
Re: Introducing Ruth - documentation
Posted by Luciano Resende <lu...@gmail.com>.
On Thu, Jul 30, 2015 at 5:09 PM, Adam Bordelon <ad...@mesosphere.io> wrote:
> Oh, absolutely. We'll have to vote in new committers at this point, and
> there are a few other active contributors (e.g. Brandon, Darin) that are
> already in the queue there.
> For the wiki, however, we don't need to grant committer privileges to give
> Ruth edit permissions.
>
All substantial contributions should be backed by a an ICLA [1], so I would
recommend that Ruth file a ICLA before any substantial contribution to the
wiki.
[1] https://www.apache.org/licenses/icla.txt
--
Luciano Resende
http://people.apache.org/~lresende
http://twitter.com/lresende1975
http://lresende.blogspot.com/
Re: Introducing Ruth - documentation
Posted by Adam Bordelon <ad...@mesosphere.io>.
Oh, absolutely. We'll have to vote in new committers at this point, and
there are a few other active contributors (e.g. Brandon, Darin) that are
already in the queue there.
For the wiki, however, we don't need to grant committer privileges to give
Ruth edit permissions.
On Thu, Jul 30, 2015 at 4:54 PM, Danese Cooper <da...@gmail.com> wrote:
> Hi Ruth.
>
> Can I (as mentor) request that we go through the formalism of asking Ruth
> to submit contributor PRs that an existing committer reviews and merges for
> awhile before we hold a vote about granting her committership? It's the
> Apache Way to treat everybody the same after the initial bootstrapping is
> done.
>
> D
>
> > On Jul 30, 2015, at 4:42 PM, Will Ochandarena <wo...@maprtech.com>
> wrote:
> >
> > Myriad Team, I want to introduce you to Ruth Harris from the MapR
> > documentation team. She'll be leading the lead on documentation for
> > Myriad, hopefully with ample help from each of you.
> >
> > She's been digging into Myriad for a few weeks now, and has a preliminary
> > outline. I'll let her reply to this and send it to start getting
> feedback.
> >
> > One thing she needs is a place to start posting to. Looking at other
> > Apache projects, it seems like the most common practice is to use a
> > gh-pages branch of the main github
> > <https://github.com/apache/incubator-myriad>.
> >
> > Adam - could you create the branch so she has something to send PRs to?
> > Jim - you seem to be our resident web/css expert. Any chance you could
> > build a simple layout for the doc site?
> >
> > Thanks!
> > Will
>
Re: Introducing Ruth - documentation
Posted by Luciano Resende <lu...@gmail.com>.
On Thu, Jul 30, 2015 at 4:54 PM, Danese Cooper <da...@gmail.com> wrote:
> Hi Ruth.
>
> Can I (as mentor) request that we go through the formalism of asking Ruth
> to submit contributor PRs that an existing committer reviews and merges for
> awhile before we hold a vote about granting her committership? It's the
> Apache Way to treat everybody the same after the initial bootstrapping is
> done.
>
> D
>
I second Danese's request.
Re: Introducing Ruth - documentation
Posted by Danese Cooper <da...@gmail.com>.
Hi Ruth.
Can I (as mentor) request that we go through the formalism of asking Ruth to submit contributor PRs that an existing committer reviews and merges for awhile before we hold a vote about granting her committership? It's the Apache Way to treat everybody the same after the initial bootstrapping is done.
D
> On Jul 30, 2015, at 4:42 PM, Will Ochandarena <wo...@maprtech.com> wrote:
>
> Myriad Team, I want to introduce you to Ruth Harris from the MapR
> documentation team. She'll be leading the lead on documentation for
> Myriad, hopefully with ample help from each of you.
>
> She's been digging into Myriad for a few weeks now, and has a preliminary
> outline. I'll let her reply to this and send it to start getting feedback.
>
> One thing she needs is a place to start posting to. Looking at other
> Apache projects, it seems like the most common practice is to use a
> gh-pages branch of the main github
> <https://github.com/apache/incubator-myriad>.
>
> Adam - could you create the branch so she has something to send PRs to?
> Jim - you seem to be our resident web/css expert. Any chance you could
> build a simple layout for the doc site?
>
> Thanks!
> Will