You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@trafodion.apache.org by Gunnar Tapper <ta...@gmail.com> on 2016/01/24 18:42:33 UTC
[VOTE] Trafodion Contributor Guide
Hi,
Several of us found it hard to orient the web from a contributor's
perspective, including myself.
Thinking about it, I found that a guide format would probably work better
given the seriality of how you get started with the different contribution
subjects.
For your review, you can find an initial version at:
https://drive.google.com/open?id=0BxlwNhWxn8iTWlNENlVBM09yWVE
Overall, I find this format a lot easier to navigate and maintain (since
there's a flow and what was different web pages are now just chapters in an
overall story). I hope you agree by voting +1 for this guide.
If so, then I will submit this guide and change the relevant links on the
Trafodion web site to point into the different chapters instead of separate
we pages.
--
Thanks,
Gunnar
*If you think you can you can, if you think you can't you're right.*
Re: [VOTE] Trafodion Contributor Guide
Posted by Gunnar Tapper <ta...@gmail.com>.
Hi Dave,
I am testing through build environment, download source, build source,
create test environment, and run [some] tests since that's a key developer
experience. I hope to update the website links and publish this guide
Wednesday/Thursday assuming that the project wants to go this route.
Thanks,
Gunnar
On Mon, Jan 25, 2016 at 2:51 PM, Dave Birdsall <da...@esgyn.com>
wrote:
> Hi Gunnar,
>
> +1 on the concept. I'm guessing you're not waiting for a detailed review of
> the document before committing? (Though I'm prepared to start a proof read;
> at 80 pages it will take a while.)
>
> Dave
>
> -----Original Message-----
> From: Gunnar Tapper [mailto:tapper.gunnar@gmail.com]
> Sent: Monday, January 25, 2016 10:38 AM
> To: dev@trafodion.incubator.apache.org
> Subject: Re: [VOTE] Trafodion Contributor Guide
>
> Hi,
>
> Yes, it's easier IMO, especially since its a book with chapters written in
> asciidoc. I find that the web pages have me lost where I am at while the
> book helps me see the organization. The other thing is that you can search
> the book since it's in one file once generated. Normal web-browser search.
>
> You are, of course, right on that we don't need release-info for this one.
> Maybe just a date?
>
> Thanks,
>
> Gunnar
>
> On Mon, Jan 25, 2016 at 10:37 AM, Steve Varnau <st...@esgyn.com>
> wrote:
>
> > So the source is in asciidoc? I guess it as easy to edit as the
> > markdown docs.
> >
> > I do like the fact that there is good navigation of topics. Even if
> > I'm already a contributor and am looking for something specific, this
> > may make it easier to find.
> >
> > Unlike the product docs, however, it does not make as much sense to
> > have multiple release versions of this doc, right?
> > So there will be just one latest version of this doc?
> >
> > --Steve
> >
> >
> > > -----Original Message-----
> > > From: Gunnar Tapper [mailto:tapper.gunnar@gmail.com]
> > > Sent: Sunday, January 24, 2016 9:43 AM
> > > To: dev@trafodion.incubator.apache.org
> > > Subject: [VOTE] Trafodion Contributor Guide
> > >
> > > Hi,
> > >
> > > Several of us found it hard to orient the web from a contributor's
> > > perspective, including myself.
> > >
> > > Thinking about it, I found that a guide format would probably work
> > > better given the seriality of how you get started with the different
> > contribution
> > > subjects.
> > >
> > > For your review, you can find an initial version at:
> > > https://drive.google.com/open?id=0BxlwNhWxn8iTWlNENlVBM09yWVE
> > >
> > > Overall, I find this format a lot easier to navigate and maintain
> > > (since there's a flow and what was different web pages are now just
> > > chapters in an overall story). I hope you agree by voting +1 for
> > > this guide.
> > >
> > > If so, then I will submit this guide and change the relevant links
> > > on the Trafodion web site to point into the different chapters
> > > instead of separate we pages.
> > >
> > > --
> > > Thanks,
> > >
> > > Gunnar
> > > *If you think you can you can, if you think you can't you're right.*
> >
>
>
>
> --
> Thanks,
>
> Gunnar
> *If you think you can you can, if you think you can't you're right.*
>
--
Thanks,
Gunnar
*If you think you can you can, if you think you can't you're right.*
RE: [VOTE] Trafodion Contributor Guide
Posted by Dave Birdsall <da...@esgyn.com>.
Hi Gunnar,
+1 on the concept. I'm guessing you're not waiting for a detailed review of
the document before committing? (Though I'm prepared to start a proof read;
at 80 pages it will take a while.)
Dave
-----Original Message-----
From: Gunnar Tapper [mailto:tapper.gunnar@gmail.com]
Sent: Monday, January 25, 2016 10:38 AM
To: dev@trafodion.incubator.apache.org
Subject: Re: [VOTE] Trafodion Contributor Guide
Hi,
Yes, it's easier IMO, especially since its a book with chapters written in
asciidoc. I find that the web pages have me lost where I am at while the
book helps me see the organization. The other thing is that you can search
the book since it's in one file once generated. Normal web-browser search.
You are, of course, right on that we don't need release-info for this one.
Maybe just a date?
Thanks,
Gunnar
On Mon, Jan 25, 2016 at 10:37 AM, Steve Varnau <st...@esgyn.com>
wrote:
> So the source is in asciidoc? I guess it as easy to edit as the
> markdown docs.
>
> I do like the fact that there is good navigation of topics. Even if
> I'm already a contributor and am looking for something specific, this
> may make it easier to find.
>
> Unlike the product docs, however, it does not make as much sense to
> have multiple release versions of this doc, right?
> So there will be just one latest version of this doc?
>
> --Steve
>
>
> > -----Original Message-----
> > From: Gunnar Tapper [mailto:tapper.gunnar@gmail.com]
> > Sent: Sunday, January 24, 2016 9:43 AM
> > To: dev@trafodion.incubator.apache.org
> > Subject: [VOTE] Trafodion Contributor Guide
> >
> > Hi,
> >
> > Several of us found it hard to orient the web from a contributor's
> > perspective, including myself.
> >
> > Thinking about it, I found that a guide format would probably work
> > better given the seriality of how you get started with the different
> contribution
> > subjects.
> >
> > For your review, you can find an initial version at:
> > https://drive.google.com/open?id=0BxlwNhWxn8iTWlNENlVBM09yWVE
> >
> > Overall, I find this format a lot easier to navigate and maintain
> > (since there's a flow and what was different web pages are now just
> > chapters in an overall story). I hope you agree by voting +1 for
> > this guide.
> >
> > If so, then I will submit this guide and change the relevant links
> > on the Trafodion web site to point into the different chapters
> > instead of separate we pages.
> >
> > --
> > Thanks,
> >
> > Gunnar
> > *If you think you can you can, if you think you can't you're right.*
>
--
Thanks,
Gunnar
*If you think you can you can, if you think you can't you're right.*
Re: [VOTE] Trafodion Contributor Guide
Posted by Gunnar Tapper <ta...@gmail.com>.
Hi,
Yes, it's easier IMO, especially since its a book with chapters written in
asciidoc. I find that the web pages have me lost where I am at while the
book helps me see the organization. The other thing is that you can search
the book since it's in one file once generated. Normal web-browser search.
You are, of course, right on that we don't need release-info for this one.
Maybe just a date?
Thanks,
Gunnar
On Mon, Jan 25, 2016 at 10:37 AM, Steve Varnau <st...@esgyn.com>
wrote:
> So the source is in asciidoc? I guess it as easy to edit as the markdown
> docs.
>
> I do like the fact that there is good navigation of topics. Even if I'm
> already a contributor and am looking for something specific, this may make
> it easier to find.
>
> Unlike the product docs, however, it does not make as much sense to have
> multiple release versions of this doc, right?
> So there will be just one latest version of this doc?
>
> --Steve
>
>
> > -----Original Message-----
> > From: Gunnar Tapper [mailto:tapper.gunnar@gmail.com]
> > Sent: Sunday, January 24, 2016 9:43 AM
> > To: dev@trafodion.incubator.apache.org
> > Subject: [VOTE] Trafodion Contributor Guide
> >
> > Hi,
> >
> > Several of us found it hard to orient the web from a contributor's
> > perspective, including myself.
> >
> > Thinking about it, I found that a guide format would probably work better
> > given the seriality of how you get started with the different
> contribution
> > subjects.
> >
> > For your review, you can find an initial version at:
> > https://drive.google.com/open?id=0BxlwNhWxn8iTWlNENlVBM09yWVE
> >
> > Overall, I find this format a lot easier to navigate and maintain (since
> > there's a flow and what was different web pages are now just chapters in
> > an
> > overall story). I hope you agree by voting +1 for this guide.
> >
> > If so, then I will submit this guide and change the relevant links on the
> > Trafodion web site to point into the different chapters instead of
> > separate
> > we pages.
> >
> > --
> > Thanks,
> >
> > Gunnar
> > *If you think you can you can, if you think you can't you're right.*
>
--
Thanks,
Gunnar
*If you think you can you can, if you think you can't you're right.*
RE: [VOTE] Trafodion Contributor Guide
Posted by Steve Varnau <st...@esgyn.com>.
So the source is in asciidoc? I guess it as easy to edit as the markdown
docs.
I do like the fact that there is good navigation of topics. Even if I'm
already a contributor and am looking for something specific, this may make
it easier to find.
Unlike the product docs, however, it does not make as much sense to have
multiple release versions of this doc, right?
So there will be just one latest version of this doc?
--Steve
> -----Original Message-----
> From: Gunnar Tapper [mailto:tapper.gunnar@gmail.com]
> Sent: Sunday, January 24, 2016 9:43 AM
> To: dev@trafodion.incubator.apache.org
> Subject: [VOTE] Trafodion Contributor Guide
>
> Hi,
>
> Several of us found it hard to orient the web from a contributor's
> perspective, including myself.
>
> Thinking about it, I found that a guide format would probably work better
> given the seriality of how you get started with the different contribution
> subjects.
>
> For your review, you can find an initial version at:
> https://drive.google.com/open?id=0BxlwNhWxn8iTWlNENlVBM09yWVE
>
> Overall, I find this format a lot easier to navigate and maintain (since
> there's a flow and what was different web pages are now just chapters in
> an
> overall story). I hope you agree by voting +1 for this guide.
>
> If so, then I will submit this guide and change the relevant links on the
> Trafodion web site to point into the different chapters instead of
> separate
> we pages.
>
> --
> Thanks,
>
> Gunnar
> *If you think you can you can, if you think you can't you're right.*