You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@airflow.apache.org by Jarek Potiuk <ja...@potiuk.com> on 2022/03/06 14:20:56 UTC
Re: [LOOKING FOR MENTORS] New Outreachy and Season of Docs rounds
Hey Nick, Giorgio,
Apologies for a little delay.
[Goirgio - just to clarify - would you also like to help with the Season of
Docs or Outreachy new round ?. The latter can only be led by PMC members -
rule of Outreachy, so it would need someone from the PMC to sign-up as
mentor]
Going back to the Season of Docs:
Nick - At this stage it seems that the organizations need to sign-up to
participate (deadline March 25) but we would need some brainstorming on
Project Ideas. In the meantime I can check what's the ASF approach (if we
still are OK to submit as a separate project). I will ask in a separate
thread.
Unlike in Outreachy, I think there are no "formal" requirements for the
people who submit the organization.
Last time when I did it for GSOC (April 2019) I wasn't a committer yet :) -
and I submitted it based on having support from Aizhamal (CC:d) and other
PMC members and at that time it was decided that each project from Apache
will apply individually rather than as the whole Apache organization to
increase the possible number of Technical Writers we could get.
Some relevant threads from 2019:
- https://lists.apache.org/thread/x6ssgo2zczvfo4wd0qjwr51d03lhkrjz
- https://lists.apache.org/thread/w2qm09ovlxr4bftvjvl68f361ff6zoff
- https://lists.apache.org/thread/q4rv750mn52f1s034w9wh9lwodzj3w57
What we need I think:
- check with ASF on submission (I can take that on)
- start brainstorming/doc on the projects we can do (looking at you Nick to
lead it :))
- last but not least - maybe others would like to join the effort too
(defining the project and guiding/helping the tech writers).
I think it would be great to have more contributors who are also users of
Airflow to help. I think as committers and PMC members - unless we are also
users.
Our "assumptions" might make the user documentation we write a bit cryptic,
and we might not realize that some things are not clear, so if we have a
few heavy "users" we have who are struggling with the current documentation
they might guide the Technical Writer much better than committers. That
might be a fantastic contribution to the project :).
J.
On Mon, Feb 28, 2022 at 5:32 PM <ni...@shook.family> wrote:
> Thanks, just to be clear, I’d be submitting an application for myself on
> behalf of Airflow here? Thanks,
> ---
> nick
>
> On Feb 27, 2022, at 17:50, Jarek Potiuk <ja...@potiuk.com> wrote:
>
> This is cool. Thanks Nick and Giorgio !
>
> Let me just forward the message about google season of docs (see below).
>
> I think there are also more people interested in making our documentation
> better - so maybe a few more volunteers will pop up :)
> The deadline to apply is 25 of March - I think having a technical writer
> who can help with that might be cool.
>
> Maybe someone would like to take a lead in defining the scope of the
> project - what to improve, what focus, what we want to achieve etc. :). For
> example starting a shared doc with some proposals. I think that might be a
> good start. Once we see that we have a concrete proposal, I can take it on
> and find out what to do to make ASF apply :).
>
> WDYT? anyone who would like to take a lead on that :) ?
>
> J,
>
> ---------- Forwarded message ---------
> 发件人： Season of Docs - Announce <se...@googlegroups.com>
> Date: 2022年2月24日周四 01:20
> Subject: [Season of Docs - Announcements] 2022 organization applications
> are now open
> To: Season of Docs - Announce <se...@googlegroups.com>
>
>
> Open source organizations can now submit applications to participate in
> Season of Docs! The deadline to apply is March 25, 2022 at 18:00 UTC.
> Season of Docs allows open source organizations to apply for a grant based
> on their documentation needs. If selected, open source organizations will
> use their grant to hire a technical writer directly to complete their
> documentation project.
>
> How does my organization apply to take part in Season of Docs?
>
> Take a look at the examples of project ideas
> <https://developers.google.com/season-of-docs/docs/project-ideas>, then
> create a project proposal
> <https://developers.google.com/season-of-docs/docs/org-proposal-template>
> based on your open source project’s actual documentation needs. Your goal
> is to attract technical writers to your organization, making them feel
> comfortable about approaching the organization and excited about what they
> can achieve.
>
> Organizations can submit their applications here: https://goo.gle/3dRyD7P
> <https://docs
> .google.com/forms/d/e/1FAIpQLSehVjMLUjnoPgS8kX4ErpE76N-KWc3AgrCyCxe7bRrtDm6tew/closedform?resourcekey=0-GIaZX6zeX6zvB58FARfOHQ
> >.
> Organization applications close on March 25th at 18:00 UTC.
>
> Season of Docs allows open source organizations to apply for a grant based
> on their documentation needs. If selected, open source organizations will
> use their grant to hire a technical writer directly to complete their
> documentation project.
>
> How do technical writers take part in Season of Docs?
>
> Technical writers interested in working with accepted open source
> organizations can share their contact information via the Season of Docs
> GitHub repository <https://github.com/google/season-of-docs>; or they may
> submit proposals directly to the organizations using the contact
> information shared on the organization project page. Technical writers do
> not submit a formal application through Season of Docs.
>
> Technical writers interested in participating in the 2022 Season of Docs
> should read our guide for technical writers
> <https://developers.google.com/season-of-docs/docs/tech-writer-guide> on
> the Season of Docs website. Please note that technical writer recruiting
> began on February 3, 2022.
>
> For more information about the program visit the Season of Docs site
> <http://developers.google.com/season-of-docs>. If you have additional
> questions, please email the Season of Docs team at season-of-docs
> @google.com
> .
>
> Best,
>
> The Season of Docs team
>
> On Sun, Feb 27, 2022 at 11:30 PM Giorgio Zoppi <gi...@gmail.com>
> wrote:
>
>> Same here Jarek,
>> I am willing to help. This has been the reason that I joined the last
>> call. It will nice to have a better monitoring.
>>
>>
>
Re: [LOOKING FOR MENTORS] New Outreachy and Season of Docs rounds
Posted by Jarek Potiuk <ja...@potiuk.com>.
Will do. I am at the FOSS Berlin now (one of the things I was
discussing at the dinner today was how we can make it works for the
ASF :). I will take a closer look when I am back (Sunday).
On Thu, Mar 17, 2022 at 8:31 PM <ni...@shook.family> wrote:
>
> wonderful, thanks Jarek. Maybe we can discuss it further on this GitHub issue? - https://github.com/apache/airflow/issues/22349. Please feel free to edit the body of my comment if you’re able to.
> ---
> nick
>
> On Mar 15, 2022, at 14:13, Jarek Potiuk <ja...@potiuk.com> wrote:
>
> I confirm that we can submit one submission per project :)
>
> On Tue, Mar 15, 2022 at 7:10 PM Jarek Potiuk <ja...@potiuk.com> wrote:
>
>
> All right. Looks like we've got some ways to handle it (Got the
> response from Greg/Infra and the GSoD) and seems that both approaches
> are workable.
>
> Now I think what's left is to prepare proposal(s) for the
> documentation project(s). Nick - would that be possible to start
> creating a doc for that?
>
> And maybe others would like to join?
>
> I will see in the meantime if there is a possibility to apply for more
> than one project from Apache (which would make it even more
> appealing).
>
> J.
>
> On Mon, Mar 14, 2022 at 10:47 AM Jarek Potiuk <ja...@potiuk.com> wrote:
>
>
> Just a bit of status/update (and warning).
>
> The new rules **might** mean that we won't be able to take part. They
> require the organization to receive the grants that are targeted to
> particular individuals, and this is against the ASF rules - as the ASF
> does not really pay individuals for code improvements, I am trying to
> check it two-fold:
>
> * I check if we can get through ASF Infra (not very likely)
> * I just asked the question at the GSoD discussion list -
> https://groups.google.com/g/season-of-docs-discuss/c/gPdh0PYQaU4/m/ywaXlU4QAgAJ
> to check if they can adjust their rules.
>
> J.
>
> On Wed, Mar 9, 2022 at 12:17 PM Jarek Potiuk <ja...@potiuk.com> wrote:
>
>
> FYI. It seems that this year the rules changed a bit and the organization involvement is much more "formal" (seems that ASF will have to get a grant and pay the writers). I reached out to dev@community to see how we can do that:
>
> https://lists.apache.org/thread/x52xrnz463b3r83ykg14oztsms6681sr
>
> On Sun, Mar 6, 2022 at 10:09 PM <ni...@shook.family> wrote:
>
>
> Sounds good, thanks so much Jarek for doing what you do!
>
> I think Airflow has some incredible docs on how to use the program itself. I’m interested in writing docs about how to use Airflow as a team, which I don’t think is fully covered yet. Like, how should pull requests work? How should a staging environment be used? (should there even be one b/c duping large prod tables is tough)? How do hotfixes work? Git Flow? etc. I’m interested in these things b/c I don’t have the answers yet, nor do I think there’ll be a definitive one, but I think a lot of people using Airflow can benefit from strong recommendations.
>
> I’m happy to broach other topics if you all decide and will wait on what org I should submit this under before continuing.
>
> Thanks!
> ---
> nick
>
> On Mar 6, 2022, at 06:20, Jarek Potiuk <ja...@potiuk.com> wrote:
>
> Hey Nick, Giorgio,
>
> Apologies for a little delay.
>
> [Goirgio - just to clarify - would you also like to help with the Season of Docs or Outreachy new round ?. The latter can only be led by PMC members - rule of Outreachy, so it would need someone from the PMC to sign-up as mentor]
>
> Going back to the Season of Docs:
>
> Nick - At this stage it seems that the organizations need to sign-up to participate (deadline March 25) but we would need some brainstorming on Project Ideas. In the meantime I can check what's the ASF approach (if we still are OK to submit as a separate project). I will ask in a separate thread.
>
> Unlike in Outreachy, I think there are no "formal" requirements for the people who submit the organization.
> Last time when I did it for GSOC (April 2019) I wasn't a committer yet :) - and I submitted it based on having support from Aizhamal (CC:d) and other PMC members and at that time it was decided that each project from Apache will apply individually rather than as the whole Apache organization to increase the possible number of Technical Writers we could get.
>
> Some relevant threads from 2019:
>
> https://lists.apache.org/thread/x6ssgo2zczvfo4wd0qjwr51d03lhkrjz
> https://lists.apache.org/thread/w2qm09ovlxr4bftvjvl68f361ff6zoff
> https://lists.apache.org/thread/q4rv750mn52f1s034w9wh9lwodzj3w57
>
> What we need I think:
>
> - check with ASF on submission (I can take that on)
> - start brainstorming/doc on the projects we can do (looking at you Nick to lead it :))
>
> - last but not least - maybe others would like to join the effort too (defining the project and guiding/helping the tech writers).
>
> I think it would be great to have more contributors who are also users of Airflow to help. I think as committers and PMC members - unless we are also users.
> Our "assumptions" might make the user documentation we write a bit cryptic, and we might not realize that some things are not clear, so if we have a few heavy "users" we have who are struggling with the current documentation they might guide the Technical Writer much better than committers. That might be a fantastic contribution to the project :).
>
> J.
>
>
> On Mon, Feb 28, 2022 at 5:32 PM <ni...@shook.family> wrote:
>
>
> Thanks, just to be clear, I’d be submitting an application for myself on behalf of Airflow here? Thanks,
> ---
> nick
>
> On Feb 27, 2022, at 17:50, Jarek Potiuk <ja...@potiuk.com> wrote:
>
> This is cool. Thanks Nick and Giorgio !
>
> Let me just forward the message about google season of docs (see below).
>
> I think there are also more people interested in making our documentation better - so maybe a few more volunteers will pop up :)
> The deadline to apply is 25 of March - I think having a technical writer who can help with that might be cool.
>
> Maybe someone would like to take a lead in defining the scope of the project - what to improve, what focus, what we want to achieve etc. :). For example starting a shared doc with some proposals. I think that might be a good start. Once we see that we have a concrete proposal, I can take it on and find out what to do to make ASF apply :).
>
> WDYT? anyone who would like to take a lead on that :) ?
>
> J,
>
> ---------- Forwarded message ---------
> 发件人： Season of Docs - Announce <se...@googlegroups.com>
> Date: 2022年2月24日周四 01:20
> Subject: [Season of Docs - Announcements] 2022 organization applications
> are now open
> To: Season of Docs - Announce <se...@googlegroups.com>
>
>
> Open source organizations can now submit applications to participate in
> Season of Docs! The deadline to apply is March 25, 2022 at 18:00 UTC.
> Season of Docs allows open source organizations to apply for a grant based
> on their documentation needs. If selected, open source organizations will
> use their grant to hire a technical writer directly to complete their
> documentation project.
>
> How does my organization apply to take part in Season of Docs?
>
> Take a look at the examples of project ideas
> <https://developers.google.com/season-of-docs/docs/project-ideas>, then
> create a project proposal
> <https://developers.google.com/season-of-docs/docs/org-proposal-template>
> based on your open source project’s actual documentation needs. Your goal
> is to attract technical writers to your organization, making them feel
> comfortable about approaching the organization and excited about what they
> can achieve.
>
> Organizations can submit their applications here: https://goo.gle/3dRyD7P
> <https://docs.google.com/forms/d/e/1FAIpQLSehVjMLUjnoPgS8kX4ErpE76N-KWc3AgrCyCxe7bRrtDm6tew/closedform?resourcekey=0-GIaZX6zeX6zvB58FARfOHQ>.
> Organization applications close on March 25th at 18:00 UTC.
>
> Season of Docs allows open source organizations to apply for a grant based
> on their documentation needs. If selected, open source organizations will
> use their grant to hire a technical writer directly to complete their
> documentation project.
>
> How do technical writers take part in Season of Docs?
>
> Technical writers interested in working with accepted open source
> organizations can share their contact information via the Season of Docs
> GitHub repository <https://github.com/google/season-of-docs>; or they may
> submit proposals directly to the organizations using the contact
> information shared on the organization project page. Technical writers do
> not submit a formal application through Season of Docs.
>
> Technical writers interested in participating in the 2022 Season of Docs
> should read our guide for technical writers
> <https://developers.google.com/season-of-docs/docs/tech-writer-guide> on
> the Season of Docs website. Please note that technical writer recruiting
> began on February 3, 2022.
>
> For more information about the program visit the Season of Docs site
> <http://developers.google.com/season-of-docs>. If you have additional
> questions, please email the Season of Docs team at season-of-docs@google.com
> .
>
> Best,
>
> The Season of Docs team
>
> On Sun, Feb 27, 2022 at 11:30 PM Giorgio Zoppi <gi...@gmail.com> wrote:
>
>
> Same here Jarek,
> I am willing to help. This has been the reason that I joined the last call. It will nice to have a better monitoring.
>
>
>
>
Re: [LOOKING FOR MENTORS] New Outreachy and Season of Docs rounds
Posted by ni...@shook.family.
wonderful, thanks Jarek. Maybe we can discuss it further on this GitHub issue? - https://github.com/apache/airflow/issues/22349. Please feel free to edit the body of my comment if you’re able to.
---
nick
> On Mar 15, 2022, at 14:13, Jarek Potiuk <ja...@potiuk.com> wrote:
>
> I confirm that we can submit one submission per project :)
>
> On Tue, Mar 15, 2022 at 7:10 PM Jarek Potiuk <ja...@potiuk.com> wrote:
>>
>> All right. Looks like we've got some ways to handle it (Got the
>> response from Greg/Infra and the GSoD) and seems that both approaches
>> are workable.
>>
>> Now I think what's left is to prepare proposal(s) for the
>> documentation project(s). Nick - would that be possible to start
>> creating a doc for that?
>>
>> And maybe others would like to join?
>>
>> I will see in the meantime if there is a possibility to apply for more
>> than one project from Apache (which would make it even more
>> appealing).
>>
>> J.
>>
>> On Mon, Mar 14, 2022 at 10:47 AM Jarek Potiuk <ja...@potiuk.com> wrote:
>>>
>>> Just a bit of status/update (and warning).
>>>
>>> The new rules **might** mean that we won't be able to take part. They
>>> require the organization to receive the grants that are targeted to
>>> particular individuals, and this is against the ASF rules - as the ASF
>>> does not really pay individuals for code improvements, I am trying to
>>> check it two-fold:
>>>
>>> * I check if we can get through ASF Infra (not very likely)
>>> * I just asked the question at the GSoD discussion list -
>>> https://groups.google.com/g/season-of-docs-discuss/c/gPdh0PYQaU4/m/ywaXlU4QAgAJ
>>> to check if they can adjust their rules.
>>>
>>> J.
>>>
>>> On Wed, Mar 9, 2022 at 12:17 PM Jarek Potiuk <ja...@potiuk.com> wrote:
>>>>
>>>> FYI. It seems that this year the rules changed a bit and the organization involvement is much more "formal" (seems that ASF will have to get a grant and pay the writers). I reached out to dev@community to see how we can do that:
>>>>
>>>> https://lists.apache.org/thread/x52xrnz463b3r83ykg14oztsms6681sr
>>>>
>>>> On Sun, Mar 6, 2022 at 10:09 PM <ni...@shook.family> wrote:
>>>>>
>>>>> Sounds good, thanks so much Jarek for doing what you do!
>>>>>
>>>>> I think Airflow has some incredible docs on how to use the program itself. I’m interested in writing docs about how to use Airflow as a team, which I don’t think is fully covered yet. Like, how should pull requests work? How should a staging environment be used? (should there even be one b/c duping large prod tables is tough)? How do hotfixes work? Git Flow? etc. I’m interested in these things b/c I don’t have the answers yet, nor do I think there’ll be a definitive one, but I think a lot of people using Airflow can benefit from strong recommendations.
>>>>>
>>>>> I’m happy to broach other topics if you all decide and will wait on what org I should submit this under before continuing.
>>>>>
>>>>> Thanks!
>>>>> ---
>>>>> nick
>>>>>
>>>>> On Mar 6, 2022, at 06:20, Jarek Potiuk <ja...@potiuk.com> wrote:
>>>>>
>>>>> Hey Nick, Giorgio,
>>>>>
>>>>> Apologies for a little delay.
>>>>>
>>>>> [Goirgio - just to clarify - would you also like to help with the Season of Docs or Outreachy new round ?. The latter can only be led by PMC members - rule of Outreachy, so it would need someone from the PMC to sign-up as mentor]
>>>>>
>>>>> Going back to the Season of Docs:
>>>>>
>>>>> Nick - At this stage it seems that the organizations need to sign-up to participate (deadline March 25) but we would need some brainstorming on Project Ideas. In the meantime I can check what's the ASF approach (if we still are OK to submit as a separate project). I will ask in a separate thread.
>>>>>
>>>>> Unlike in Outreachy, I think there are no "formal" requirements for the people who submit the organization.
>>>>> Last time when I did it for GSOC (April 2019) I wasn't a committer yet :) - and I submitted it based on having support from Aizhamal (CC:d) and other PMC members and at that time it was decided that each project from Apache will apply individually rather than as the whole Apache organization to increase the possible number of Technical Writers we could get.
>>>>>
>>>>> Some relevant threads from 2019:
>>>>>
>>>>> https://lists.apache.org/thread/x6ssgo2zczvfo4wd0qjwr51d03lhkrjz
>>>>> https://lists.apache.org/thread/w2qm09ovlxr4bftvjvl68f361ff6zoff
>>>>> https://lists.apache.org/thread/q4rv750mn52f1s034w9wh9lwodzj3w57
>>>>>
>>>>> What we need I think:
>>>>>
>>>>> - check with ASF on submission (I can take that on)
>>>>> - start brainstorming/doc on the projects we can do (looking at you Nick to lead it :))
>>>>>
>>>>> - last but not least - maybe others would like to join the effort too (defining the project and guiding/helping the tech writers).
>>>>>
>>>>> I think it would be great to have more contributors who are also users of Airflow to help. I think as committers and PMC members - unless we are also users.
>>>>> Our "assumptions" might make the user documentation we write a bit cryptic, and we might not realize that some things are not clear, so if we have a few heavy "users" we have who are struggling with the current documentation they might guide the Technical Writer much better than committers. That might be a fantastic contribution to the project :).
>>>>>
>>>>> J.
>>>>>
>>>>>
>>>>> On Mon, Feb 28, 2022 at 5:32 PM <ni...@shook.family> wrote:
>>>>>>
>>>>>> Thanks, just to be clear, I’d be submitting an application for myself on behalf of Airflow here? Thanks,
>>>>>> ---
>>>>>> nick
>>>>>>
>>>>>> On Feb 27, 2022, at 17:50, Jarek Potiuk <ja...@potiuk.com> wrote:
>>>>>>
>>>>>> This is cool. Thanks Nick and Giorgio !
>>>>>>
>>>>>> Let me just forward the message about google season of docs (see below).
>>>>>>
>>>>>> I think there are also more people interested in making our documentation better - so maybe a few more volunteers will pop up :)
>>>>>> The deadline to apply is 25 of March - I think having a technical writer who can help with that might be cool.
>>>>>>
>>>>>> Maybe someone would like to take a lead in defining the scope of the project - what to improve, what focus, what we want to achieve etc. :). For example starting a shared doc with some proposals. I think that might be a good start. Once we see that we have a concrete proposal, I can take it on and find out what to do to make ASF apply :).
>>>>>>
>>>>>> WDYT? anyone who would like to take a lead on that :) ?
>>>>>>
>>>>>> J,
>>>>>>
>>>>>> ---------- Forwarded message ---------
>>>>>> 发件人： Season of Docs - Announce <se...@googlegroups.com>
>>>>>> Date: 2022年2月24日周四 01:20
>>>>>> Subject: [Season of Docs - Announcements] 2022 organization applications
>>>>>> are now open
>>>>>> To: Season of Docs - Announce <se...@googlegroups.com>
>>>>>>
>>>>>>
>>>>>> Open source organizations can now submit applications to participate in
>>>>>> Season of Docs! The deadline to apply is March 25, 2022 at 18:00 UTC.
>>>>>> Season of Docs allows open source organizations to apply for a grant based
>>>>>> on their documentation needs. If selected, open source organizations will
>>>>>> use their grant to hire a technical writer directly to complete their
>>>>>> documentation project.
>>>>>>
>>>>>> How does my organization apply to take part in Season of Docs?
>>>>>>
>>>>>> Take a look at the examples of project ideas
>>>>>> <https://developers.google.com/season-of-docs/docs/project-ideas>, then
>>>>>> create a project proposal
>>>>>> <https://developers.google.com/season-of-docs/docs/org-proposal-template>
>>>>>> based on your open source project’s actual documentation needs. Your goal
>>>>>> is to attract technical writers to your organization, making them feel
>>>>>> comfortable about approaching the organization and excited about what they
>>>>>> can achieve.
>>>>>>
>>>>>> Organizations can submit their applications here: https://goo.gle/3dRyD7P
>>>>>> <https://docs.google.com/forms/d/e/1FAIpQLSehVjMLUjnoPgS8kX4ErpE76N-KWc3AgrCyCxe7bRrtDm6tew/closedform?resourcekey=0-GIaZX6zeX6zvB58FARfOHQ>.
>>>>>> Organization applications close on March 25th at 18:00 UTC.
>>>>>>
>>>>>> Season of Docs allows open source organizations to apply for a grant based
>>>>>> on their documentation needs. If selected, open source organizations will
>>>>>> use their grant to hire a technical writer directly to complete their
>>>>>> documentation project.
>>>>>>
>>>>>> How do technical writers take part in Season of Docs?
>>>>>>
>>>>>> Technical writers interested in working with accepted open source
>>>>>> organizations can share their contact information via the Season of Docs
>>>>>> GitHub repository <https://github.com/google/season-of-docs>; or they may
>>>>>> submit proposals directly to the organizations using the contact
>>>>>> information shared on the organization project page. Technical writers do
>>>>>> not submit a formal application through Season of Docs.
>>>>>>
>>>>>> Technical writers interested in participating in the 2022 Season of Docs
>>>>>> should read our guide for technical writers
>>>>>> <https://developers.google.com/season-of-docs/docs/tech-writer-guide> on
>>>>>> the Season of Docs website. Please note that technical writer recruiting
>>>>>> began on February 3, 2022.
>>>>>>
>>>>>> For more information about the program visit the Season of Docs site
>>>>>> <http://developers.google.com/season-of-docs>. If you have additional
>>>>>> questions, please email the Season of Docs team at season-of-docs@google.com
>>>>>> .
>>>>>>
>>>>>> Best,
>>>>>>
>>>>>> The Season of Docs team
>>>>>>
>>>>>> On Sun, Feb 27, 2022 at 11:30 PM Giorgio Zoppi <gi...@gmail.com> wrote:
>>>>>>>
>>>>>>> Same here Jarek,
>>>>>>> I am willing to help. This has been the reason that I joined the last call. It will nice to have a better monitoring.
>>>>>>>
>>>>>>
>>>>>
Re: [LOOKING FOR MENTORS] New Outreachy and Season of Docs rounds
Posted by Jarek Potiuk <ja...@potiuk.com>.
I confirm that we can submit one submission per project :)
On Tue, Mar 15, 2022 at 7:10 PM Jarek Potiuk <ja...@potiuk.com> wrote:
>
> All right. Looks like we've got some ways to handle it (Got the
> response from Greg/Infra and the GSoD) and seems that both approaches
> are workable.
>
> Now I think what's left is to prepare proposal(s) for the
> documentation project(s). Nick - would that be possible to start
> creating a doc for that?
>
> And maybe others would like to join?
>
> I will see in the meantime if there is a possibility to apply for more
> than one project from Apache (which would make it even more
> appealing).
>
> J.
>
> On Mon, Mar 14, 2022 at 10:47 AM Jarek Potiuk <ja...@potiuk.com> wrote:
> >
> > Just a bit of status/update (and warning).
> >
> > The new rules **might** mean that we won't be able to take part. They
> > require the organization to receive the grants that are targeted to
> > particular individuals, and this is against the ASF rules - as the ASF
> > does not really pay individuals for code improvements, I am trying to
> > check it two-fold:
> >
> > * I check if we can get through ASF Infra (not very likely)
> > * I just asked the question at the GSoD discussion list -
> > https://groups.google.com/g/season-of-docs-discuss/c/gPdh0PYQaU4/m/ywaXlU4QAgAJ
> > to check if they can adjust their rules.
> >
> > J.
> >
> > On Wed, Mar 9, 2022 at 12:17 PM Jarek Potiuk <ja...@potiuk.com> wrote:
> > >
> > > FYI. It seems that this year the rules changed a bit and the organization involvement is much more "formal" (seems that ASF will have to get a grant and pay the writers). I reached out to dev@community to see how we can do that:
> > >
> > > https://lists.apache.org/thread/x52xrnz463b3r83ykg14oztsms6681sr
> > >
> > > On Sun, Mar 6, 2022 at 10:09 PM <ni...@shook.family> wrote:
> > >>
> > >> Sounds good, thanks so much Jarek for doing what you do!
> > >>
> > >> I think Airflow has some incredible docs on how to use the program itself. I’m interested in writing docs about how to use Airflow as a team, which I don’t think is fully covered yet. Like, how should pull requests work? How should a staging environment be used? (should there even be one b/c duping large prod tables is tough)? How do hotfixes work? Git Flow? etc. I’m interested in these things b/c I don’t have the answers yet, nor do I think there’ll be a definitive one, but I think a lot of people using Airflow can benefit from strong recommendations.
> > >>
> > >> I’m happy to broach other topics if you all decide and will wait on what org I should submit this under before continuing.
> > >>
> > >> Thanks!
> > >> ---
> > >> nick
> > >>
> > >> On Mar 6, 2022, at 06:20, Jarek Potiuk <ja...@potiuk.com> wrote:
> > >>
> > >> Hey Nick, Giorgio,
> > >>
> > >> Apologies for a little delay.
> > >>
> > >> [Goirgio - just to clarify - would you also like to help with the Season of Docs or Outreachy new round ?. The latter can only be led by PMC members - rule of Outreachy, so it would need someone from the PMC to sign-up as mentor]
> > >>
> > >> Going back to the Season of Docs:
> > >>
> > >> Nick - At this stage it seems that the organizations need to sign-up to participate (deadline March 25) but we would need some brainstorming on Project Ideas. In the meantime I can check what's the ASF approach (if we still are OK to submit as a separate project). I will ask in a separate thread.
> > >>
> > >> Unlike in Outreachy, I think there are no "formal" requirements for the people who submit the organization.
> > >> Last time when I did it for GSOC (April 2019) I wasn't a committer yet :) - and I submitted it based on having support from Aizhamal (CC:d) and other PMC members and at that time it was decided that each project from Apache will apply individually rather than as the whole Apache organization to increase the possible number of Technical Writers we could get.
> > >>
> > >> Some relevant threads from 2019:
> > >>
> > >> https://lists.apache.org/thread/x6ssgo2zczvfo4wd0qjwr51d03lhkrjz
> > >> https://lists.apache.org/thread/w2qm09ovlxr4bftvjvl68f361ff6zoff
> > >> https://lists.apache.org/thread/q4rv750mn52f1s034w9wh9lwodzj3w57
> > >>
> > >> What we need I think:
> > >>
> > >> - check with ASF on submission (I can take that on)
> > >> - start brainstorming/doc on the projects we can do (looking at you Nick to lead it :))
> > >>
> > >> - last but not least - maybe others would like to join the effort too (defining the project and guiding/helping the tech writers).
> > >>
> > >> I think it would be great to have more contributors who are also users of Airflow to help. I think as committers and PMC members - unless we are also users.
> > >> Our "assumptions" might make the user documentation we write a bit cryptic, and we might not realize that some things are not clear, so if we have a few heavy "users" we have who are struggling with the current documentation they might guide the Technical Writer much better than committers. That might be a fantastic contribution to the project :).
> > >>
> > >> J.
> > >>
> > >>
> > >> On Mon, Feb 28, 2022 at 5:32 PM <ni...@shook.family> wrote:
> > >>>
> > >>> Thanks, just to be clear, I’d be submitting an application for myself on behalf of Airflow here? Thanks,
> > >>> ---
> > >>> nick
> > >>>
> > >>> On Feb 27, 2022, at 17:50, Jarek Potiuk <ja...@potiuk.com> wrote:
> > >>>
> > >>> This is cool. Thanks Nick and Giorgio !
> > >>>
> > >>> Let me just forward the message about google season of docs (see below).
> > >>>
> > >>> I think there are also more people interested in making our documentation better - so maybe a few more volunteers will pop up :)
> > >>> The deadline to apply is 25 of March - I think having a technical writer who can help with that might be cool.
> > >>>
> > >>> Maybe someone would like to take a lead in defining the scope of the project - what to improve, what focus, what we want to achieve etc. :). For example starting a shared doc with some proposals. I think that might be a good start. Once we see that we have a concrete proposal, I can take it on and find out what to do to make ASF apply :).
> > >>>
> > >>> WDYT? anyone who would like to take a lead on that :) ?
> > >>>
> > >>> J,
> > >>>
> > >>> ---------- Forwarded message ---------
> > >>> 发件人： Season of Docs - Announce <se...@googlegroups.com>
> > >>> Date: 2022年2月24日周四 01:20
> > >>> Subject: [Season of Docs - Announcements] 2022 organization applications
> > >>> are now open
> > >>> To: Season of Docs - Announce <se...@googlegroups.com>
> > >>>
> > >>>
> > >>> Open source organizations can now submit applications to participate in
> > >>> Season of Docs! The deadline to apply is March 25, 2022 at 18:00 UTC.
> > >>> Season of Docs allows open source organizations to apply for a grant based
> > >>> on their documentation needs. If selected, open source organizations will
> > >>> use their grant to hire a technical writer directly to complete their
> > >>> documentation project.
> > >>>
> > >>> How does my organization apply to take part in Season of Docs?
> > >>>
> > >>> Take a look at the examples of project ideas
> > >>> <https://developers.google.com/season-of-docs/docs/project-ideas>, then
> > >>> create a project proposal
> > >>> <https://developers.google.com/season-of-docs/docs/org-proposal-template>
> > >>> based on your open source project’s actual documentation needs. Your goal
> > >>> is to attract technical writers to your organization, making them feel
> > >>> comfortable about approaching the organization and excited about what they
> > >>> can achieve.
> > >>>
> > >>> Organizations can submit their applications here: https://goo.gle/3dRyD7P
> > >>> <https://docs.google.com/forms/d/e/1FAIpQLSehVjMLUjnoPgS8kX4ErpE76N-KWc3AgrCyCxe7bRrtDm6tew/closedform?resourcekey=0-GIaZX6zeX6zvB58FARfOHQ>.
> > >>> Organization applications close on March 25th at 18:00 UTC.
> > >>>
> > >>> Season of Docs allows open source organizations to apply for a grant based
> > >>> on their documentation needs. If selected, open source organizations will
> > >>> use their grant to hire a technical writer directly to complete their
> > >>> documentation project.
> > >>>
> > >>> How do technical writers take part in Season of Docs?
> > >>>
> > >>> Technical writers interested in working with accepted open source
> > >>> organizations can share their contact information via the Season of Docs
> > >>> GitHub repository <https://github.com/google/season-of-docs>; or they may
> > >>> submit proposals directly to the organizations using the contact
> > >>> information shared on the organization project page. Technical writers do
> > >>> not submit a formal application through Season of Docs.
> > >>>
> > >>> Technical writers interested in participating in the 2022 Season of Docs
> > >>> should read our guide for technical writers
> > >>> <https://developers.google.com/season-of-docs/docs/tech-writer-guide> on
> > >>> the Season of Docs website. Please note that technical writer recruiting
> > >>> began on February 3, 2022.
> > >>>
> > >>> For more information about the program visit the Season of Docs site
> > >>> <http://developers.google.com/season-of-docs>. If you have additional
> > >>> questions, please email the Season of Docs team at season-of-docs@google.com
> > >>> .
> > >>>
> > >>> Best,
> > >>>
> > >>> The Season of Docs team
> > >>>
> > >>> On Sun, Feb 27, 2022 at 11:30 PM Giorgio Zoppi <gi...@gmail.com> wrote:
> > >>>>
> > >>>> Same here Jarek,
> > >>>> I am willing to help. This has been the reason that I joined the last call. It will nice to have a better monitoring.
> > >>>>
> > >>>
> > >>
Re: [LOOKING FOR MENTORS] New Outreachy and Season of Docs rounds
Posted by Jarek Potiuk <ja...@potiuk.com>.
All right. Looks like we've got some ways to handle it (Got the
response from Greg/Infra and the GSoD) and seems that both approaches
are workable.
Now I think what's left is to prepare proposal(s) for the
documentation project(s). Nick - would that be possible to start
creating a doc for that?
And maybe others would like to join?
I will see in the meantime if there is a possibility to apply for more
than one project from Apache (which would make it even more
appealing).
J.
On Mon, Mar 14, 2022 at 10:47 AM Jarek Potiuk <ja...@potiuk.com> wrote:
>
> Just a bit of status/update (and warning).
>
> The new rules **might** mean that we won't be able to take part. They
> require the organization to receive the grants that are targeted to
> particular individuals, and this is against the ASF rules - as the ASF
> does not really pay individuals for code improvements, I am trying to
> check it two-fold:
>
> * I check if we can get through ASF Infra (not very likely)
> * I just asked the question at the GSoD discussion list -
> https://groups.google.com/g/season-of-docs-discuss/c/gPdh0PYQaU4/m/ywaXlU4QAgAJ
> to check if they can adjust their rules.
>
> J.
>
> On Wed, Mar 9, 2022 at 12:17 PM Jarek Potiuk <ja...@potiuk.com> wrote:
> >
> > FYI. It seems that this year the rules changed a bit and the organization involvement is much more "formal" (seems that ASF will have to get a grant and pay the writers). I reached out to dev@community to see how we can do that:
> >
> > https://lists.apache.org/thread/x52xrnz463b3r83ykg14oztsms6681sr
> >
> > On Sun, Mar 6, 2022 at 10:09 PM <ni...@shook.family> wrote:
> >>
> >> Sounds good, thanks so much Jarek for doing what you do!
> >>
> >> I think Airflow has some incredible docs on how to use the program itself. I’m interested in writing docs about how to use Airflow as a team, which I don’t think is fully covered yet. Like, how should pull requests work? How should a staging environment be used? (should there even be one b/c duping large prod tables is tough)? How do hotfixes work? Git Flow? etc. I’m interested in these things b/c I don’t have the answers yet, nor do I think there’ll be a definitive one, but I think a lot of people using Airflow can benefit from strong recommendations.
> >>
> >> I’m happy to broach other topics if you all decide and will wait on what org I should submit this under before continuing.
> >>
> >> Thanks!
> >> ---
> >> nick
> >>
> >> On Mar 6, 2022, at 06:20, Jarek Potiuk <ja...@potiuk.com> wrote:
> >>
> >> Hey Nick, Giorgio,
> >>
> >> Apologies for a little delay.
> >>
> >> [Goirgio - just to clarify - would you also like to help with the Season of Docs or Outreachy new round ?. The latter can only be led by PMC members - rule of Outreachy, so it would need someone from the PMC to sign-up as mentor]
> >>
> >> Going back to the Season of Docs:
> >>
> >> Nick - At this stage it seems that the organizations need to sign-up to participate (deadline March 25) but we would need some brainstorming on Project Ideas. In the meantime I can check what's the ASF approach (if we still are OK to submit as a separate project). I will ask in a separate thread.
> >>
> >> Unlike in Outreachy, I think there are no "formal" requirements for the people who submit the organization.
> >> Last time when I did it for GSOC (April 2019) I wasn't a committer yet :) - and I submitted it based on having support from Aizhamal (CC:d) and other PMC members and at that time it was decided that each project from Apache will apply individually rather than as the whole Apache organization to increase the possible number of Technical Writers we could get.
> >>
> >> Some relevant threads from 2019:
> >>
> >> https://lists.apache.org/thread/x6ssgo2zczvfo4wd0qjwr51d03lhkrjz
> >> https://lists.apache.org/thread/w2qm09ovlxr4bftvjvl68f361ff6zoff
> >> https://lists.apache.org/thread/q4rv750mn52f1s034w9wh9lwodzj3w57
> >>
> >> What we need I think:
> >>
> >> - check with ASF on submission (I can take that on)
> >> - start brainstorming/doc on the projects we can do (looking at you Nick to lead it :))
> >>
> >> - last but not least - maybe others would like to join the effort too (defining the project and guiding/helping the tech writers).
> >>
> >> I think it would be great to have more contributors who are also users of Airflow to help. I think as committers and PMC members - unless we are also users.
> >> Our "assumptions" might make the user documentation we write a bit cryptic, and we might not realize that some things are not clear, so if we have a few heavy "users" we have who are struggling with the current documentation they might guide the Technical Writer much better than committers. That might be a fantastic contribution to the project :).
> >>
> >> J.
> >>
> >>
> >> On Mon, Feb 28, 2022 at 5:32 PM <ni...@shook.family> wrote:
> >>>
> >>> Thanks, just to be clear, I’d be submitting an application for myself on behalf of Airflow here? Thanks,
> >>> ---
> >>> nick
> >>>
> >>> On Feb 27, 2022, at 17:50, Jarek Potiuk <ja...@potiuk.com> wrote:
> >>>
> >>> This is cool. Thanks Nick and Giorgio !
> >>>
> >>> Let me just forward the message about google season of docs (see below).
> >>>
> >>> I think there are also more people interested in making our documentation better - so maybe a few more volunteers will pop up :)
> >>> The deadline to apply is 25 of March - I think having a technical writer who can help with that might be cool.
> >>>
> >>> Maybe someone would like to take a lead in defining the scope of the project - what to improve, what focus, what we want to achieve etc. :). For example starting a shared doc with some proposals. I think that might be a good start. Once we see that we have a concrete proposal, I can take it on and find out what to do to make ASF apply :).
> >>>
> >>> WDYT? anyone who would like to take a lead on that :) ?
> >>>
> >>> J,
> >>>
> >>> ---------- Forwarded message ---------
> >>> 发件人： Season of Docs - Announce <se...@googlegroups.com>
> >>> Date: 2022年2月24日周四 01:20
> >>> Subject: [Season of Docs - Announcements] 2022 organization applications
> >>> are now open
> >>> To: Season of Docs - Announce <se...@googlegroups.com>
> >>>
> >>>
> >>> Open source organizations can now submit applications to participate in
> >>> Season of Docs! The deadline to apply is March 25, 2022 at 18:00 UTC.
> >>> Season of Docs allows open source organizations to apply for a grant based
> >>> on their documentation needs. If selected, open source organizations will
> >>> use their grant to hire a technical writer directly to complete their
> >>> documentation project.
> >>>
> >>> How does my organization apply to take part in Season of Docs?
> >>>
> >>> Take a look at the examples of project ideas
> >>> <https://developers.google.com/season-of-docs/docs/project-ideas>, then
> >>> create a project proposal
> >>> <https://developers.google.com/season-of-docs/docs/org-proposal-template>
> >>> based on your open source project’s actual documentation needs. Your goal
> >>> is to attract technical writers to your organization, making them feel
> >>> comfortable about approaching the organization and excited about what they
> >>> can achieve.
> >>>
> >>> Organizations can submit their applications here: https://goo.gle/3dRyD7P
> >>> <https://docs.google.com/forms/d/e/1FAIpQLSehVjMLUjnoPgS8kX4ErpE76N-KWc3AgrCyCxe7bRrtDm6tew/closedform?resourcekey=0-GIaZX6zeX6zvB58FARfOHQ>.
> >>> Organization applications close on March 25th at 18:00 UTC.
> >>>
> >>> Season of Docs allows open source organizations to apply for a grant based
> >>> on their documentation needs. If selected, open source organizations will
> >>> use their grant to hire a technical writer directly to complete their
> >>> documentation project.
> >>>
> >>> How do technical writers take part in Season of Docs?
> >>>
> >>> Technical writers interested in working with accepted open source
> >>> organizations can share their contact information via the Season of Docs
> >>> GitHub repository <https://github.com/google/season-of-docs>; or they may
> >>> submit proposals directly to the organizations using the contact
> >>> information shared on the organization project page. Technical writers do
> >>> not submit a formal application through Season of Docs.
> >>>
> >>> Technical writers interested in participating in the 2022 Season of Docs
> >>> should read our guide for technical writers
> >>> <https://developers.google.com/season-of-docs/docs/tech-writer-guide> on
> >>> the Season of Docs website. Please note that technical writer recruiting
> >>> began on February 3, 2022.
> >>>
> >>> For more information about the program visit the Season of Docs site
> >>> <http://developers.google.com/season-of-docs>. If you have additional
> >>> questions, please email the Season of Docs team at season-of-docs@google.com
> >>> .
> >>>
> >>> Best,
> >>>
> >>> The Season of Docs team
> >>>
> >>> On Sun, Feb 27, 2022 at 11:30 PM Giorgio Zoppi <gi...@gmail.com> wrote:
> >>>>
> >>>> Same here Jarek,
> >>>> I am willing to help. This has been the reason that I joined the last call. It will nice to have a better monitoring.
> >>>>
> >>>
> >>
Re: [LOOKING FOR MENTORS] New Outreachy and Season of Docs rounds
Posted by Jarek Potiuk <ja...@potiuk.com>.
Just a bit of status/update (and warning).
The new rules **might** mean that we won't be able to take part. They
require the organization to receive the grants that are targeted to
particular individuals, and this is against the ASF rules - as the ASF
does not really pay individuals for code improvements, I am trying to
check it two-fold:
* I check if we can get through ASF Infra (not very likely)
* I just asked the question at the GSoD discussion list -
https://groups.google.com/g/season-of-docs-discuss/c/gPdh0PYQaU4/m/ywaXlU4QAgAJ
to check if they can adjust their rules.
J.
On Wed, Mar 9, 2022 at 12:17 PM Jarek Potiuk <ja...@potiuk.com> wrote:
>
> FYI. It seems that this year the rules changed a bit and the organization involvement is much more "formal" (seems that ASF will have to get a grant and pay the writers). I reached out to dev@community to see how we can do that:
>
> https://lists.apache.org/thread/x52xrnz463b3r83ykg14oztsms6681sr
>
> On Sun, Mar 6, 2022 at 10:09 PM <ni...@shook.family> wrote:
>>
>> Sounds good, thanks so much Jarek for doing what you do!
>>
>> I think Airflow has some incredible docs on how to use the program itself. I’m interested in writing docs about how to use Airflow as a team, which I don’t think is fully covered yet. Like, how should pull requests work? How should a staging environment be used? (should there even be one b/c duping large prod tables is tough)? How do hotfixes work? Git Flow? etc. I’m interested in these things b/c I don’t have the answers yet, nor do I think there’ll be a definitive one, but I think a lot of people using Airflow can benefit from strong recommendations.
>>
>> I’m happy to broach other topics if you all decide and will wait on what org I should submit this under before continuing.
>>
>> Thanks!
>> ---
>> nick
>>
>> On Mar 6, 2022, at 06:20, Jarek Potiuk <ja...@potiuk.com> wrote:
>>
>> Hey Nick, Giorgio,
>>
>> Apologies for a little delay.
>>
>> [Goirgio - just to clarify - would you also like to help with the Season of Docs or Outreachy new round ?. The latter can only be led by PMC members - rule of Outreachy, so it would need someone from the PMC to sign-up as mentor]
>>
>> Going back to the Season of Docs:
>>
>> Nick - At this stage it seems that the organizations need to sign-up to participate (deadline March 25) but we would need some brainstorming on Project Ideas. In the meantime I can check what's the ASF approach (if we still are OK to submit as a separate project). I will ask in a separate thread.
>>
>> Unlike in Outreachy, I think there are no "formal" requirements for the people who submit the organization.
>> Last time when I did it for GSOC (April 2019) I wasn't a committer yet :) - and I submitted it based on having support from Aizhamal (CC:d) and other PMC members and at that time it was decided that each project from Apache will apply individually rather than as the whole Apache organization to increase the possible number of Technical Writers we could get.
>>
>> Some relevant threads from 2019:
>>
>> https://lists.apache.org/thread/x6ssgo2zczvfo4wd0qjwr51d03lhkrjz
>> https://lists.apache.org/thread/w2qm09ovlxr4bftvjvl68f361ff6zoff
>> https://lists.apache.org/thread/q4rv750mn52f1s034w9wh9lwodzj3w57
>>
>> What we need I think:
>>
>> - check with ASF on submission (I can take that on)
>> - start brainstorming/doc on the projects we can do (looking at you Nick to lead it :))
>>
>> - last but not least - maybe others would like to join the effort too (defining the project and guiding/helping the tech writers).
>>
>> I think it would be great to have more contributors who are also users of Airflow to help. I think as committers and PMC members - unless we are also users.
>> Our "assumptions" might make the user documentation we write a bit cryptic, and we might not realize that some things are not clear, so if we have a few heavy "users" we have who are struggling with the current documentation they might guide the Technical Writer much better than committers. That might be a fantastic contribution to the project :).
>>
>> J.
>>
>>
>> On Mon, Feb 28, 2022 at 5:32 PM <ni...@shook.family> wrote:
>>>
>>> Thanks, just to be clear, I’d be submitting an application for myself on behalf of Airflow here? Thanks,
>>> ---
>>> nick
>>>
>>> On Feb 27, 2022, at 17:50, Jarek Potiuk <ja...@potiuk.com> wrote:
>>>
>>> This is cool. Thanks Nick and Giorgio !
>>>
>>> Let me just forward the message about google season of docs (see below).
>>>
>>> I think there are also more people interested in making our documentation better - so maybe a few more volunteers will pop up :)
>>> The deadline to apply is 25 of March - I think having a technical writer who can help with that might be cool.
>>>
>>> Maybe someone would like to take a lead in defining the scope of the project - what to improve, what focus, what we want to achieve etc. :). For example starting a shared doc with some proposals. I think that might be a good start. Once we see that we have a concrete proposal, I can take it on and find out what to do to make ASF apply :).
>>>
>>> WDYT? anyone who would like to take a lead on that :) ?
>>>
>>> J,
>>>
>>> ---------- Forwarded message ---------
>>> 发件人： Season of Docs - Announce <se...@googlegroups.com>
>>> Date: 2022年2月24日周四 01:20
>>> Subject: [Season of Docs - Announcements] 2022 organization applications
>>> are now open
>>> To: Season of Docs - Announce <se...@googlegroups.com>
>>>
>>>
>>> Open source organizations can now submit applications to participate in
>>> Season of Docs! The deadline to apply is March 25, 2022 at 18:00 UTC.
>>> Season of Docs allows open source organizations to apply for a grant based
>>> on their documentation needs. If selected, open source organizations will
>>> use their grant to hire a technical writer directly to complete their
>>> documentation project.
>>>
>>> How does my organization apply to take part in Season of Docs?
>>>
>>> Take a look at the examples of project ideas
>>> <https://developers.google.com/season-of-docs/docs/project-ideas>, then
>>> create a project proposal
>>> <https://developers.google.com/season-of-docs/docs/org-proposal-template>
>>> based on your open source project’s actual documentation needs. Your goal
>>> is to attract technical writers to your organization, making them feel
>>> comfortable about approaching the organization and excited about what they
>>> can achieve.
>>>
>>> Organizations can submit their applications here: https://goo.gle/3dRyD7P
>>> <https://docs.google.com/forms/d/e/1FAIpQLSehVjMLUjnoPgS8kX4ErpE76N-KWc3AgrCyCxe7bRrtDm6tew/closedform?resourcekey=0-GIaZX6zeX6zvB58FARfOHQ>.
>>> Organization applications close on March 25th at 18:00 UTC.
>>>
>>> Season of Docs allows open source organizations to apply for a grant based
>>> on their documentation needs. If selected, open source organizations will
>>> use their grant to hire a technical writer directly to complete their
>>> documentation project.
>>>
>>> How do technical writers take part in Season of Docs?
>>>
>>> Technical writers interested in working with accepted open source
>>> organizations can share their contact information via the Season of Docs
>>> GitHub repository <https://github.com/google/season-of-docs>; or they may
>>> submit proposals directly to the organizations using the contact
>>> information shared on the organization project page. Technical writers do
>>> not submit a formal application through Season of Docs.
>>>
>>> Technical writers interested in participating in the 2022 Season of Docs
>>> should read our guide for technical writers
>>> <https://developers.google.com/season-of-docs/docs/tech-writer-guide> on
>>> the Season of Docs website. Please note that technical writer recruiting
>>> began on February 3, 2022.
>>>
>>> For more information about the program visit the Season of Docs site
>>> <http://developers.google.com/season-of-docs>. If you have additional
>>> questions, please email the Season of Docs team at season-of-docs@google.com
>>> .
>>>
>>> Best,
>>>
>>> The Season of Docs team
>>>
>>> On Sun, Feb 27, 2022 at 11:30 PM Giorgio Zoppi <gi...@gmail.com> wrote:
>>>>
>>>> Same here Jarek,
>>>> I am willing to help. This has been the reason that I joined the last call. It will nice to have a better monitoring.
>>>>
>>>
>>
Re: [LOOKING FOR MENTORS] New Outreachy and Season of Docs rounds
Posted by Jarek Potiuk <ja...@potiuk.com>.
FYI. It seems that this year the rules changed a bit and the organization
involvement is much more "formal" (seems that ASF will have to get a grant
and pay the writers). I reached out to dev@community to see how we can do
that:
https://lists.apache.org/thread/x52xrnz463b3r83ykg14oztsms6681sr
On Sun, Mar 6, 2022 at 10:09 PM <ni...@shook.family> wrote:
> Sounds good, thanks so much Jarek for doing what you do!
>
> I think Airflow has some incredible docs on how to use the program itself.
> I’m interested in writing docs about how to use Airflow as a team, which I
> don’t think is fully covered yet. Like, how should pull requests work? How
> should a staging environment be used? (should there even be one b/c duping
> large prod tables is tough)? How do hotfixes work? Git Flow? etc. I’m
> interested in these things b/c I don’t have the answers yet, nor do I think
> there’ll be a definitive one, but I think a lot of people using Airflow can
> benefit from strong recommendations.
>
> I’m happy to broach other topics if you all decide and will wait on what
> org I should submit this under before continuing.
>
> Thanks!
> ---
> nick
>
> On Mar 6, 2022, at 06:20, Jarek Potiuk <ja...@potiuk.com> wrote:
>
> Hey Nick, Giorgio,
>
> Apologies for a little delay.
>
> [Goirgio - just to clarify - would you also like to help with the Season
> of Docs or Outreachy new round ?. The latter can only be led by PMC members
> - rule of Outreachy, so it would need someone from the PMC to sign-up as
> mentor]
>
> Going back to the Season of Docs:
>
> Nick - At this stage it seems that the organizations need to sign-up to
> participate (deadline March 25) but we would need some brainstorming on
> Project Ideas. In the meantime I can check what's the ASF approach (if we
> still are OK to submit as a separate project). I will ask in a separate
> thread.
>
> Unlike in Outreachy, I think there are no "formal" requirements for the
> people who submit the organization.
> Last time when I did it for GSOC (April 2019) I wasn't a committer yet :)
> - and I submitted it based on having support from Aizhamal (CC:d) and other
> PMC members and at that time it was decided that each project from Apache
> will apply individually rather than as the whole Apache organization to
> increase the possible number of Technical Writers we could get.
>
> Some relevant threads from 2019:
>
> - https://lists.apache.org/thread/x6ssgo2zczvfo4wd0qjwr51d03lhkrjz
> - https://lists.apache.org/thread/w2qm09ovlxr4bftvjvl68f361ff6zoff
> - https://lists.apache.org/thread/q4rv750mn52f1s034w9wh9lwodzj3w57
>
> What we need I think:
>
> - check with ASF on submission (I can take that on)
> - start brainstorming/doc on the projects we can do (looking at you Nick
> to lead it :))
>
> - last but not least - maybe others would like to join the effort too
> (defining the project and guiding/helping the tech writers).
>
> I think it would be great to have more contributors who are also users of
> Airflow to help. I think as committers and PMC members - unless we are also
> users.
> Our "assumptions" might make the user documentation we write a bit
> cryptic, and we might not realize that some things are not clear, so if we
> have a few heavy "users" we have who are struggling with the current
> documentation they might guide the Technical Writer much better than
> committers. That might be a fantastic contribution to the project :).
>
> J.
>
>
> On Mon, Feb 28, 2022 at 5:32 PM <ni...@shook.family> wrote:
>
>> Thanks, just to be clear, I’d be submitting an application for myself on
>> behalf of Airflow here? Thanks,
>> ---
>> nick
>>
>> On Feb 27, 2022, at 17:50, Jarek Potiuk <ja...@potiuk.com> wrote:
>>
>> This is cool. Thanks Nick and Giorgio !
>>
>> Let me just forward the message about google season of docs (see below).
>>
>> I think there are also more people interested in making our documentation
>> better - so maybe a few more volunteers will pop up :)
>> The deadline to apply is 25 of March - I think having a technical writer
>> who can help with that might be cool.
>>
>> Maybe someone would like to take a lead in defining the scope of the
>> project - what to improve, what focus, what we want to achieve etc. :). For
>> example starting a shared doc with some proposals. I think that might be a
>> good start. Once we see that we have a concrete proposal, I can take it on
>> and find out what to do to make ASF apply :).
>>
>> WDYT? anyone who would like to take a lead on that :) ?
>>
>> J,
>>
>> ---------- Forwarded message ---------
>> 发件人： Season of Docs - Announce <se...@googlegroups.com>
>> Date: 2022年2月24日周四 01:20
>> Subject: [Season of Docs - Announcements] 2022 organization applications
>> are now open
>> To: Season of Docs - Announce <se...@googlegroups.com>
>>
>>
>> Open source organizations can now submit applications to participate in
>> Season of Docs! The deadline to apply is March 25, 2022 at 18:00 UTC.
>> Season of Docs allows open source organizations to apply for a grant
>> based
>> on their documentation needs. If selected, open source organizations will
>> use their grant to hire a technical writer directly to complete their
>> documentation project.
>>
>> How does my organization apply to take part in Season of Docs?
>>
>> Take a look at the examples of project ideas
>> <https://developers.google.com/season-of-docs/docs/project-ideas>, then
>> create a project proposal
>> <https://developers.google.com/season-of-docs/docs/org-proposal-template>
>> based on your open source project’s actual documentation needs. Your goal
>> is to attract technical writers to your organization, making them feel
>> comfortable about approaching the organization and excited about what they
>> can achieve.
>>
>> Organizations can submit their applications here: https://goo.gle/3dRyD7P
>> <https://docs
>> .google.com/forms/d/e/1FAIpQLSehVjMLUjnoPgS8kX4ErpE76N-KWc3AgrCyCxe7bRrtDm6tew/closedform?resourcekey=0-GIaZX6zeX6zvB58FARfOHQ
>> >.
>> Organization applications close on March 25th at 18:00 UTC.
>>
>> Season of Docs allows open source organizations to apply for a grant
>> based
>> on their documentation needs. If selected, open source organizations will
>> use their grant to hire a technical writer directly to complete their
>> documentation project.
>>
>> How do technical writers take part in Season of Docs?
>>
>> Technical writers interested in working with accepted open source
>> organizations can share their contact information via the Season of Docs
>> GitHub repository <https://github.com/google/season-of-docs>; or they may
>> submit proposals directly to the organizations using the contact
>> information shared on the organization project page. Technical writers do
>> not submit a formal application through Season of Docs.
>>
>> Technical writers interested in participating in the 2022 Season of Docs
>> should read our guide for technical writers
>> <https://developers.google.com/season-of-docs/docs/tech-writer-guide> on
>> the Season of Docs website. Please note that technical writer recruiting
>> began on February 3, 2022.
>>
>> For more information about the program visit the Season of Docs site
>> <http://developers.google.com/season-of-docs>. If you have additional
>> questions, please email the Season of Docs team at season-of-docs
>> @google.com
>> .
>>
>> Best,
>>
>> The Season of Docs team
>>
>> On Sun, Feb 27, 2022 at 11:30 PM Giorgio Zoppi <gi...@gmail.com>
>> wrote:
>>
>>> Same here Jarek,
>>> I am willing to help. This has been the reason that I joined the last
>>> call. It will nice to have a better monitoring.
>>>
>>>
>>
>
Re: [LOOKING FOR MENTORS] New Outreachy and Season of Docs rounds
Posted by ni...@shook.family.
Sounds good, thanks so much Jarek for doing what you do!
I think Airflow has some incredible docs on how to use the program itself. I’m interested in writing docs about how to use Airflow as a team, which I don’t think is fully covered yet. Like, how should pull requests work? How should a staging environment be used? (should there even be one b/c duping large prod tables is tough)? How do hotfixes work? Git Flow? etc. I’m interested in these things b/c I don’t have the answers yet, nor do I think there’ll be a definitive one, but I think a lot of people using Airflow can benefit from strong recommendations.
I’m happy to broach other topics if you all decide and will wait on what org I should submit this under before continuing.
Thanks!
---
nick
> On Mar 6, 2022, at 06:20, Jarek Potiuk <ja...@potiuk.com> wrote:
>
> Hey Nick, Giorgio,
>
> Apologies for a little delay.
>
> [Goirgio - just to clarify - would you also like to help with the Season of Docs or Outreachy new round ?. The latter can only be led by PMC members - rule of Outreachy, so it would need someone from the PMC to sign-up as mentor]
>
> Going back to the Season of Docs:
>
> Nick - At this stage it seems that the organizations need to sign-up to participate (deadline March 25) but we would need some brainstorming on Project Ideas. In the meantime I can check what's the ASF approach (if we still are OK to submit as a separate project). I will ask in a separate thread.
>
> Unlike in Outreachy, I think there are no "formal" requirements for the people who submit the organization.
> Last time when I did it for GSOC (April 2019) I wasn't a committer yet :) - and I submitted it based on having support from Aizhamal (CC:d) and other PMC members and at that time it was decided that each project from Apache will apply individually rather than as the whole Apache organization to increase the possible number of Technical Writers we could get.
>
> Some relevant threads from 2019:
> https://lists.apache.org/thread/x6ssgo2zczvfo4wd0qjwr51d03lhkrjz <https://lists.apache.org/thread/x6ssgo2zczvfo4wd0qjwr51d03lhkrjz>
> https://lists.apache.org/thread/w2qm09ovlxr4bftvjvl68f361ff6zoff <https://lists.apache.org/thread/w2qm09ovlxr4bftvjvl68f361ff6zoff>
> https://lists.apache.org/thread/q4rv750mn52f1s034w9wh9lwodzj3w57 <https://lists.apache.org/thread/q4rv750mn52f1s034w9wh9lwodzj3w57>
> What we need I think:
>
> - check with ASF on submission (I can take that on)
> - start brainstorming/doc on the projects we can do (looking at you Nick to lead it :))
>
> - last but not least - maybe others would like to join the effort too (defining the project and guiding/helping the tech writers).
>
> I think it would be great to have more contributors who are also users of Airflow to help. I think as committers and PMC members - unless we are also users.
> Our "assumptions" might make the user documentation we write a bit cryptic, and we might not realize that some things are not clear, so if we have a few heavy "users" we have who are struggling with the current documentation they might guide the Technical Writer much better than committers. That might be a fantastic contribution to the project :).
>
> J.
>
>
> On Mon, Feb 28, 2022 at 5:32 PM <ni...@shook.family> wrote:
> Thanks, just to be clear, I’d be submitting an application for myself on behalf of Airflow here? Thanks,
> ---
> nick
>
>> On Feb 27, 2022, at 17:50, Jarek Potiuk <jarek@potiuk.com <ma...@potiuk.com>> wrote:
>>
>> This is cool. Thanks Nick and Giorgio !
>>
>> Let me just forward the message about google season of docs (see below).
>>
>> I think there are also more people interested in making our documentation better - so maybe a few more volunteers will pop up :)
>> The deadline to apply is 25 of March - I think having a technical writer who can help with that might be cool.
>>
>> Maybe someone would like to take a lead in defining the scope of the project - what to improve, what focus, what we want to achieve etc. :). For example starting a shared doc with some proposals. I think that might be a good start. Once we see that we have a concrete proposal, I can take it on and find out what to do to make ASF apply :).
>>
>> WDYT? anyone who would like to take a lead on that :) ?
>>
>> J,
>>
>> ---------- Forwarded message ---------
>> 发件人： Season of Docs - Announce <season-of-docs-announce@googlegroups.com <ma...@googlegroups.com>>
>> Date: 2022年2月24日周四 01:20
>> Subject: [Season of Docs - Announcements] 2022 organization applications
>> are now open
>> To: Season of Docs - Announce <season-of-docs-announce@googlegroups.com <ma...@googlegroups.com>>
>>
>>
>> Open source organizations can now submit applications to participate in
>> Season of Docs! The deadline to apply is March 25, 2022 at 18:00 UTC.
>> Season of Docs allows open source organizations to apply for a grant based
>> on their documentation needs. If selected, open source organizations will
>> use their grant to hire a technical writer directly to complete their
>> documentation project.
>>
>> How does my organization apply to take part in Season of Docs?
>>
>> Take a look at the examples of project ideas
>> <https://developers.google.com/season-of-docs/docs/project-ideas <https://developers.google.com/season-of-docs/docs/project-ideas>>, then
>> create a project proposal
>> <https://developers.google.com/season-of-docs/docs/org-proposal-template <https://developers.google.com/season-of-docs/docs/org-proposal-template>>
>> based on your open source project’s actual documentation needs. Your goal
>> is to attract technical writers to your organization, making them feel
>> comfortable about approaching the organization and excited about what they
>> can achieve.
>>
>> Organizations can submit their applications here: https://goo.gle/3dRyD7P <https://goo.gle/3dRyD7P>
>> <https://docs.google.com/forms/d/e/1FAIpQLSehVjMLUjnoPgS8kX4ErpE76N-KWc3AgrCyCxe7bRrtDm6tew/closedform?resourcekey=0-GIaZX6zeX6zvB58FARfOHQ <https://docs.google.com/forms/d/e/1FAIpQLSehVjMLUjnoPgS8kX4ErpE76N-KWc3AgrCyCxe7bRrtDm6tew/closedform?resourcekey=0-GIaZX6zeX6zvB58FARfOHQ>>.
>> Organization applications close on March 25th at 18:00 UTC.
>>
>> Season of Docs allows open source organizations to apply for a grant based
>> on their documentation needs. If selected, open source organizations will
>> use their grant to hire a technical writer directly to complete their
>> documentation project.
>>
>> How do technical writers take part in Season of Docs?
>>
>> Technical writers interested in working with accepted open source
>> organizations can share their contact information via the Season of Docs
>> GitHub repository <https://github.com/google/season-of-docs <https://github.com/google/season-of-docs>>; or they may
>> submit proposals directly to the organizations using the contact
>> information shared on the organization project page. Technical writers do
>> not submit a formal application through Season of Docs.
>>
>> Technical writers interested in participating in the 2022 Season of Docs
>> should read our guide for technical writers
>> <https://developers.google.com/season-of-docs/docs/tech-writer-guide <https://developers.google.com/season-of-docs/docs/tech-writer-guide>> on
>> the Season of Docs website. Please note that technical writer recruiting
>> began on February 3, 2022.
>>
>> For more information about the program visit the Season of Docs site
>> <http://developers.google.com/season-of-docs <http://developers.google.com/season-of-docs>>. If you have additional
>> questions, please email the Season of Docs team at season-of-docs@google.com <ma...@google.com>
>> .
>>
>> Best,
>>
>> The Season of Docs team
>>
>> On Sun, Feb 27, 2022 at 11:30 PM Giorgio Zoppi <giorgio.zoppi@gmail.com <ma...@gmail.com>> wrote:
>> Same here Jarek,
>> I am willing to help. This has been the reason that I joined the last call. It will nice to have a better monitoring.
>>
>