You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@community.apache.org by Sharan Foga <sh...@apache.org> on 2019/05/03 20:30:39 UTC
[DISCUSSION] Documentation Hackathons at ApacheCon
Hi All
Recently with the Google Season of Docs, quite a few of our projects were interested in applying to get some help with their documentation, so I’m thinking, what if we try and add some sort of documentation section to our ApacheCon hackathons.
If we have enough people from a project community we could start at a very basic level e.g writing up some install or very basic getting started docs.
Another idea is that the projects who weren’t successful in getting a technical writer with Season of Docs, bring their idea and have a hackathon or Birds of a Feather session during ApacheCon to plan, prepare or write something that could help.
At one of the previous open source summits I attended I saw a presentation on what they called ‘Book Sprints’ where a group of people got together for a fixed time period and then wrote the documentation and pubished it. While we may not have the same time frame, perhaps doing at least a documentation proof of concept could be interesting for both Las Vegas and Berlin.
What do people think?
Thanks
Sharan
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@community.apache.org
For additional commands, e-mail: dev-help@community.apache.org
Re: [DISCUSSION] Documentation Hackathons at ApacheCon
Posted by Sharan F <sh...@apache.org>.
Hi Kevin
Not yet. Let's wait to see if we get any responses on this before blocking
any time slots.
Thanks
Sharan
On Tue, 18 Jun 2019, 02:27 Kevin A. McGrail, <km...@apache.org> wrote:
> Would you like to request a block of time for this on the hackathon
> schedule?
> --
> Kevin A. McGrail
> Member, Apache Software Foundation
> Chair Emeritus Apache SpamAssassin Project
> https://www.linkedin.com/in/kmcgrail - 703.798.0171
>
>
> On Mon, Jun 17, 2019 at 6:33 PM Sharan Foga <sh...@apache.org> wrote:
>
> > Hi All
> >
> > I am bringing this thread up again as we are looking at the topics to add
> > to the Hackathon in Las Vegas. I'd like to add this documentation hack -
> so
> > next we need to find some projects that need help with their
> documentation
> > that will also be present in Las Vegas.
> >
> > Thanks
> > Sharan
> >
> > On 2019/05/03 20:30:39, Sharan Foga <sh...@apache.org> wrote:
> > > Hi All
> > >
> > > Recently with the Google Season of Docs, quite a few of our projects
> > were interested in applying to get some help with their documentation, so
> > I’m thinking, what if we try and add some sort of documentation section
> to
> > our ApacheCon hackathons.
> > >
> > > If we have enough people from a project community we could start at a
> > very basic level e.g writing up some install or very basic getting
> started
> > docs.
> > >
> > > Another idea is that the projects who weren’t successful in getting a
> > technical writer with Season of Docs, bring their idea and have a
> hackathon
> > or Birds of a Feather session during ApacheCon to plan, prepare or write
> > something that could help.
> > >
> > > At one of the previous open source summits I attended I saw a
> > presentation on what they called ‘Book Sprints’ where a group of people
> got
> > together for a fixed time period and then wrote the documentation and
> > pubished it. While we may not have the same time frame, perhaps doing at
> > least a documentation proof of concept could be interesting for both Las
> > Vegas and Berlin.
> > >
> > > What do people think?
> > >
> > > Thanks
> > > Sharan
> > >
> > > ---------------------------------------------------------------------
> > > To unsubscribe, e-mail: dev-unsubscribe@community.apache.org
> > > For additional commands, e-mail: dev-help@community.apache.org
> > >
> > >
> >
> > ---------------------------------------------------------------------
> > To unsubscribe, e-mail: dev-unsubscribe@community.apache.org
> > For additional commands, e-mail: dev-help@community.apache.org
> >
> >
>
Re: [DISCUSSION] Documentation Hackathons at ApacheCon
Posted by "Kevin A. McGrail" <km...@apache.org>.
Would you like to request a block of time for this on the hackathon
schedule?
--
Kevin A. McGrail
Member, Apache Software Foundation
Chair Emeritus Apache SpamAssassin Project
https://www.linkedin.com/in/kmcgrail - 703.798.0171
On Mon, Jun 17, 2019 at 6:33 PM Sharan Foga <sh...@apache.org> wrote:
> Hi All
>
> I am bringing this thread up again as we are looking at the topics to add
> to the Hackathon in Las Vegas. I'd like to add this documentation hack - so
> next we need to find some projects that need help with their documentation
> that will also be present in Las Vegas.
>
> Thanks
> Sharan
>
> On 2019/05/03 20:30:39, Sharan Foga <sh...@apache.org> wrote:
> > Hi All
> >
> > Recently with the Google Season of Docs, quite a few of our projects
> were interested in applying to get some help with their documentation, so
> I’m thinking, what if we try and add some sort of documentation section to
> our ApacheCon hackathons.
> >
> > If we have enough people from a project community we could start at a
> very basic level e.g writing up some install or very basic getting started
> docs.
> >
> > Another idea is that the projects who weren’t successful in getting a
> technical writer with Season of Docs, bring their idea and have a hackathon
> or Birds of a Feather session during ApacheCon to plan, prepare or write
> something that could help.
> >
> > At one of the previous open source summits I attended I saw a
> presentation on what they called ‘Book Sprints’ where a group of people got
> together for a fixed time period and then wrote the documentation and
> pubished it. While we may not have the same time frame, perhaps doing at
> least a documentation proof of concept could be interesting for both Las
> Vegas and Berlin.
> >
> > What do people think?
> >
> > Thanks
> > Sharan
> >
> > ---------------------------------------------------------------------
> > To unsubscribe, e-mail: dev-unsubscribe@community.apache.org
> > For additional commands, e-mail: dev-help@community.apache.org
> >
> >
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@community.apache.org
> For additional commands, e-mail: dev-help@community.apache.org
>
>
Re: [DISCUSSION] Documentation Hackathons at ApacheCon
Posted by Sharan Foga <sh...@apache.org>.
Hi All
I am bringing this thread up again as we are looking at the topics to add to the Hackathon in Las Vegas. I'd like to add this documentation hack - so next we need to find some projects that need help with their documentation that will also be present in Las Vegas.
Thanks
Sharan
On 2019/05/03 20:30:39, Sharan Foga <sh...@apache.org> wrote:
> Hi All
>
> Recently with the Google Season of Docs, quite a few of our projects were interested in applying to get some help with their documentation, so I’m thinking, what if we try and add some sort of documentation section to our ApacheCon hackathons.
>
> If we have enough people from a project community we could start at a very basic level e.g writing up some install or very basic getting started docs.
>
> Another idea is that the projects who weren’t successful in getting a technical writer with Season of Docs, bring their idea and have a hackathon or Birds of a Feather session during ApacheCon to plan, prepare or write something that could help.
>
> At one of the previous open source summits I attended I saw a presentation on what they called ‘Book Sprints’ where a group of people got together for a fixed time period and then wrote the documentation and pubished it. While we may not have the same time frame, perhaps doing at least a documentation proof of concept could be interesting for both Las Vegas and Berlin.
>
> What do people think?
>
> Thanks
> Sharan
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@community.apache.org
> For additional commands, e-mail: dev-help@community.apache.org
>
>
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@community.apache.org
For additional commands, e-mail: dev-help@community.apache.org
Re: [DISCUSSION] Documentation Hackathons at ApacheCon
Posted by Kenneth Knowles <ke...@apache.org>.
+1 from me as well, and I'll be at ApacheCon NA to help out. Are there
steps to take now, like asking in the projects to see which of your ideas
fits best? I would guess the BoF+hackathon between all the projects from
GSoD would be cool. Worst case, you have too many people writing docs in a
room...
On Fri, May 3, 2019 at 1:40 PM Aizhamal Nurmamat kyzy
<ai...@google.com.invalid> wrote:
> I think this is a fantastic idea! I fully support any effort to foster
> documentation contributions/documentation improvements. Let me know if I
> can help in any way.
>
> Thanks,
> Aizhamal
>
> *From: *Sharan Foga <sh...@apache.org>
> *Date: *Fri, May 3, 2019 at 1:30 PM
> *To: * <de...@community.apache.org>
>
> Hi All
> >
> > Recently with the Google Season of Docs, quite a few of our projects were
> > interested in applying to get some help with their documentation, so I’m
> > thinking, what if we try and add some sort of documentation section to
> our
> > ApacheCon hackathons.
> >
> > If we have enough people from a project community we could start at a
> very
> > basic level e.g writing up some install or very basic getting started
> docs.
> >
> > Another idea is that the projects who weren’t successful in getting a
> > technical writer with Season of Docs, bring their idea and have a
> hackathon
> > or Birds of a Feather session during ApacheCon to plan, prepare or write
> > something that could help.
> >
> > At one of the previous open source summits I attended I saw a
> > presentation on what they called ‘Book Sprints’ where a group of people
> got
> > together for a fixed time period and then wrote the documentation and
> > pubished it. While we may not have the same time frame, perhaps doing at
> > least a documentation proof of concept could be interesting for both Las
> > Vegas and Berlin.
> >
> > What do people think?
> >
> > Thanks
> > Sharan
> >
> > ---------------------------------------------------------------------
> > To unsubscribe, e-mail: dev-unsubscribe@community.apache.org
> > For additional commands, e-mail: dev-help@community.apache.org
> >
> >
>
Re: [DISCUSSION] Documentation Hackathons at ApacheCon
Posted by Aizhamal Nurmamat kyzy <ai...@google.com.INVALID>.
I think this is a fantastic idea! I fully support any effort to foster
documentation contributions/documentation improvements. Let me know if I
can help in any way.
Thanks,
Aizhamal
*From: *Sharan Foga <sh...@apache.org>
*Date: *Fri, May 3, 2019 at 1:30 PM
*To: * <de...@community.apache.org>
Hi All
>
> Recently with the Google Season of Docs, quite a few of our projects were
> interested in applying to get some help with their documentation, so I’m
> thinking, what if we try and add some sort of documentation section to our
> ApacheCon hackathons.
>
> If we have enough people from a project community we could start at a very
> basic level e.g writing up some install or very basic getting started docs.
>
> Another idea is that the projects who weren’t successful in getting a
> technical writer with Season of Docs, bring their idea and have a hackathon
> or Birds of a Feather session during ApacheCon to plan, prepare or write
> something that could help.
>
> At one of the previous open source summits I attended I saw a
> presentation on what they called ‘Book Sprints’ where a group of people got
> together for a fixed time period and then wrote the documentation and
> pubished it. While we may not have the same time frame, perhaps doing at
> least a documentation proof of concept could be interesting for both Las
> Vegas and Berlin.
>
> What do people think?
>
> Thanks
> Sharan
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@community.apache.org
> For additional commands, e-mail: dev-help@community.apache.org
>
>