You are viewing a plain text version of this content. The canonical link for it is here.
Posted to general@incubator.apache.org by "Jean T. Anderson" <jt...@bristowhill.com> on 2006/01/18 04:33:56 UTC
[doc] "Getting Started in the Incubator" topic
Here's another starter installment for the "Incubator Guidelines
Documentation" project Noel posted at
http://mail-archives.apache.org/mod_mbox/incubator-general/200512.mbox/%3cNBBBJGEAGJAKLIDBKJOPAEBMFGAC.noel@devtech.com%3e
Several times during derby's incubation I felt disoriented because while
there's a lot of info on the incubator site, I didn't seem to always
find what I needed as a completely new podling committer.
Below is a first shot at providing a succinct Getting Started that
points complete newbies to resources already on the incubator site and
fills in a few holes.
For those of you currently in incubation, does this help? Or would it
have helped when you first started. :-) What more would help?
==================================
Getting Started: Podling Committer
==================================
Welcome! Your general committer role is described at
http://incubator.apache.org/incubation/Roles_and_Responsibilities.html#Committers
, but here's more information to help you get started.
(1) Mailing lists
- Subscribe to the user, dev, and commit lists for your project.
- Become aware of what else is going on in the Incubator by
subscribing to the general@incubator.apache.org list described at
http://incubator.apache.org/howtoparticipate.html#Mailing+lists
- Become aware of what else is going on at the ASF by
subscribing to the Apache-wide lists described at
http://incubator.apache.org/learn/mailing-lists.html
(Note: we should add legal-discuss@a.o to this list.)
(2) Project web site
+ How to get your project web site going is documented at
http://incubator.apache.org/howtoparticipate.html#Project+Website+Howto
+ Post any questions to general@incubator.apache.org.
(3) Committer Resources
+ Browse the pages at http://www.apache.org/dev/ often.
+ Subscribe to infrastructure@apache.org, then raise awareness
on your project on what goes on behind the scenes.
Be proactive about responding to infrastructure issues on your
project mailing lists. Does the web server seem to be down? Is
Jira or Subversion down? Check the status at
http://monitoring.apache.org/status/ and report back to your list.
(4) Podling PMC (PPMC)
If you are a member of your PPMC, become familiar with the
Incubation Policy at
http://incubator.apache.org/incubation/Incubation_Policy.html .
You'll likely participate in the following:
+ Update the podling status on the Incubator site:
http://incubator.apache.org/guides/website.html#Edit+your+project+status+report
+ Add new committers to your project:
http://incubator.apache.org/learn/newcommitters.html
+ Make sure that a quarterly report is submitted when the
Incubator PMC Chair requests it.
================
end draft
================
OK, this is pretty thin so far, but should give the idea of what I'm
shooting for.
I think this information should go in one of these places:
http://incubator.apache.org/learn/
http://incubator.apache.org/guides/
It shouldn't be buried deep in a subpage, nor should it be on a page
that is already busy. http://incubator.apache.org/howtoparticipate.html
is borderline too busy and covers more than this one role.
comments? feedback?
thanks,
-jean
---------------------------------------------------------------------
To unsubscribe, e-mail: general-unsubscribe@incubator.apache.org
For additional commands, e-mail: general-help@incubator.apache.org
Re: [doc] "Getting Started in the Incubator" topic
Posted by "Jean T. Anderson" <jt...@bristowhill.com>.
Martin Sebor wrote:
> Jean T. Anderson wrote:
>> Jean T. Anderson wrote:
<snip>
>> I initialized a page for new committers here and will incorporate
>> feedback as it gets posted:
>>
>> http://incubator.apache.org/guides/committer.html
>
> Just a few minor nits :)
>
> The name of the commits list is typically -commits (plural). I would
> also suggest to prepend a hyphen to the generic names of the lists,
> i.e.,
>
> "Subscribe to the -user, -dev, and -commits lists for your project."
OK -- thanks for the suggestion.
> In this sentence
>
> "Become aware of what else is going on in the Incubator by subscribing
> to the general at incubator.apache.org list."
>
> the "general at incubator.apache.org" is a link but not the mailto:
> kind implied by the text. I suggest to change the text so as not
> to imply the mailto: kind of a link (along the same lines as the
> community, infrastructure, and legal-discuss lists in the bullet
> below). Ditto in the Questions section.
I changed that text to read "the Incubator's general list", leaving the
link to http://incubator.apache.org/howtoparticipate.html#Mailing+lists.
> Btw., I'm curious if there is a recommended convention for the use
> of email addresses on our Web pages: should they be obfuscated like
> the one above or is it okay to use the actual email address?
I was just following the style at
http://incubator.apache.org/howtoparticipate.html#Mailing+lists . There
may be a specific recommendation buried somewhere in the posts.
> Also, I noticed a typo here:
> http://incubator.apache.org/learn/newcommitters.html
>
> "signicant" should read "significant."
I added a reminder to INCUBATOR-4, which proposes modifications to that
page.
thanks for the feedback,
-jean
---------------------------------------------------------------------
To unsubscribe, e-mail: general-unsubscribe@incubator.apache.org
For additional commands, e-mail: general-help@incubator.apache.org
Re: [doc] "Getting Started in the Incubator" topic
Posted by Martin Sebor <se...@roguewave.com>.
Jean T. Anderson wrote:
> Jean T. Anderson wrote:
>
>> Here's another starter installment for the "Incubator Guidelines
>> Documentation" project Noel posted at
>> http://mail-archives.apache.org/mod_mbox/incubator-general/200512.mbox/%3cNBBBJGEAGJAKLIDBKJOPAEBMFGAC.noel@devtech.com%3e
>
>
>
> <vast snippage>
>
> I initialized a page for new committers here and will incorporate
> feedback as it gets posted:
>
> http://incubator.apache.org/guides/committer.html
Just a few minor nits :)
The name of the commits list is typically -commits (plural). I would
also suggest to prepend a hyphen to the generic names of the lists,
i.e.,
"Subscribe to the -user, -dev, and -commits lists for your project."
In this sentence
"Become aware of what else is going on in the Incubator by subscribing
to the general at incubator.apache.org list."
the "general at incubator.apache.org" is a link but not the mailto:
kind implied by the text. I suggest to change the text so as not
to imply the mailto: kind of a link (along the same lines as the
community, infrastructure, and legal-discuss lists in the bullet
below). Ditto in the Questions section.
Btw., I'm curious if there is a recommended convention for the use
of email addresses on our Web pages: should they be obfuscated like
the one above or is it okay to use the actual email address?
Also, I noticed a typo here:
http://incubator.apache.org/learn/newcommitters.html
"signicant" should read "significant."
Martin
---------------------------------------------------------------------
To unsubscribe, e-mail: general-unsubscribe@incubator.apache.org
For additional commands, e-mail: general-help@incubator.apache.org
Re: [doc] "Getting Started in the Incubator" topic
Posted by "Jean T. Anderson" <jt...@bristowhill.com>.
Jean T. Anderson wrote:
> Here's another starter installment for the "Incubator Guidelines
> Documentation" project Noel posted at
> http://mail-archives.apache.org/mod_mbox/incubator-general/200512.mbox/%3cNBBBJGEAGJAKLIDBKJOPAEBMFGAC.noel@devtech.com%3e
<vast snippage>
I initialized a page for new committers here and will incorporate
feedback as it gets posted:
http://incubator.apache.org/guides/committer.html
Incidently, I initially planned to link to the ASF-wide mail lists
documented at http://incubator.apache.org/learn/mailing-lists.html, but
am not sure about the move of that learn section to Anakia. In the
meantime, I just added links for the mail lists documented at
http://www.apache.org/foundation/mailinglists.html .
any comments, corrections, improvements, etc. are welcome.
-jean
---------------------------------------------------------------------
To unsubscribe, e-mail: general-unsubscribe@incubator.apache.org
For additional commands, e-mail: general-help@incubator.apache.org
Re: [doc] "Getting Started in the Incubator" topic
Posted by "Jean T. Anderson" <jt...@bristowhill.com>.
Leo Simons wrote:
> On Tue, Jan 17, 2006 at 07:33:56PM -0800, Jean T. Anderson wrote:
>
>>I think this information should go in one of these places:
>>
>> http://incubator.apache.org/learn/
>> http://incubator.apache.org/guides/
>
> +1.
with more thought, guides would be the best fit; besides, there are
guides for pretty much everyone else.
Also according to what David wrote in
http://mail-archives.apache.org/mod_mbox/incubator-general/200601.mbox/%3c20060118074010.GB23606@igg.indexgeo.com.au%3e
, learn is on the way out.
>
> I think there should also be something like a
>
> svn cp https://svn.apache.org/repos/asf/infrastructure/trunk/tools/account-welcome.ezt \
> https://svn.apache.org/repos/asf/infrastructure/trunk/tools/account-welcome-incubator.ezt
>
> and with the latter file then pointing at the above. Heck, you might
> want to consider updating the original file a little, too.
I'd be happy to update the original, especially to change the "This will
grant you access to cvs.apache.org" to reference subversion instead. :-)
copying account-welcome.ezt to account-welcome-incubator.ezt would
require the infra volunteer to pay close attention to the account being
created to see which "welcome" fits best -- not strictly necessary.
>
>>comments? feedback?
>
> Great stuff. The only worry is about this kind of information getting
> "stale" or "duplicated" since you're summarizing other bits of content.
> If that content ever changes, does the summary change? Oh well.
I'm hoping for the most part to summarize pointers to content, not copy
content in that would need to be synced up when the original changed
(gack). Even so, those pointers will get stale and have to be updated,
but I think it's worth having a more coherent starting pointing for new
podling committers. --I can add a disclaimer to that effect, and point
to www.apache.org/dev for the latest and greatest in current info.
thanks for the feedback,
-jean
---------------------------------------------------------------------
To unsubscribe, e-mail: general-unsubscribe@incubator.apache.org
For additional commands, e-mail: general-help@incubator.apache.org
Re: [doc] "Getting Started in the Incubator" topic
Posted by Leo Simons <ma...@leosimons.com>.
On Tue, Jan 17, 2006 at 07:33:56PM -0800, Jean T. Anderson wrote:
> I think this information should go in one of these places:
>
> http://incubator.apache.org/learn/
> http://incubator.apache.org/guides/
+1.
I think there should also be something like a
svn cp https://svn.apache.org/repos/asf/infrastructure/trunk/tools/account-welcome.ezt \
https://svn.apache.org/repos/asf/infrastructure/trunk/tools/account-welcome-incubator.ezt
and with the latter file then pointing at the above. Heck, you might
want to consider updating the original file a little, too.
> comments? feedback?
Great stuff. The only worry is about this kind of information getting
"stale" or "duplicated" since you're summarizing other bits of content.
If that content ever changes, does the summary change? Oh well.
cheers,
LSD
---------------------------------------------------------------------
To unsubscribe, e-mail: general-unsubscribe@incubator.apache.org
For additional commands, e-mail: general-help@incubator.apache.org
Re: [doc] "Getting Started in the Incubator" topic
Posted by J Aaron Farr <fa...@apache.org>.
On 1/17/06, Jean T. Anderson <jt...@bristowhill.com> wrote:
> It shouldn't be buried deep in a subpage, nor should it be on a page
> that is already busy. http://incubator.apache.org/howtoparticipate.html
> is borderline too busy and covers more than this one role.
>
> comments? feedback?
Looks good. I think a checklist approach is useful.
A while back I worked on some documentation that Ted Husted had
started. I'll see if I can dig that up.
--
jaaron
---------------------------------------------------------------------
To unsubscribe, e-mail: general-unsubscribe@incubator.apache.org
For additional commands, e-mail: general-help@incubator.apache.org