Getting involved with documentation efforts: how and where?

View: New views
4 Messages — Rating Filter:   Alert me  

Getting involved with documentation efforts: how and where?

by Mr. Meitar Moscovitz-2 :: Rate this Message:

Reply to Author | View Threaded | Show Only this Message

Hi all,

I'm new here, and I'm a developer new to Drupal as well. I've just  
recently begun working with Drupal full time in a professional  
context, and in the process have found the existing Drupal docs to be  
of invaluable importance in my learning. Naturally, I found some areas  
where they could be better, more clear, or are simply lacking. I  
thought I'd raise my hand to volunteer to help out whatever  
documentation efforts the Drupal community has and, especially as a  
new Drupal user and developer, try to flesh out whatever I can so its  
more accessible to people without prior Drupal experience or knowledge.

I've already added a few a page of my own to the documentation, not  
very Drupal-specific but helpful (I think), which you can see at http://drupal.org/user/265715/track

A while ago I also put in this documentation issue: http://drupal.org/node/238799

I let it sit for a while since I hadn't had the time to get back to it—
it's always a challenge to balance "getting work done" and "giving  
back to the community" as I'm sure you al know. In any event, I'd love  
to start getting more involved, but don't know precisely how to go  
about doing that. I figured what better place to ask than here, on the  
doc list?

Who do I poke about that documentation issue? Where can I go to see  
other issues that I can help out with (if not the documentation  
issues, which apparently I need special privileges that I lack to  
affect). So basically…yeah, where might I be needed, or helpful?

By way of delayed introduction, I'm a technical author and a web  
developer/sysadmin by trade. I'm specifically a front-end specialist,  
with a focus on semantic web technologies, and if that's not enough,  
I'm dating a writer. :)

Cheers,
-Meitar Moscovitz

Drupal: http://drupal.org/user/265715
Personal: http://maymay.net/
Professional: http://MeitarMoscovitz.com/

--
Pending work: http://drupal.org/project/issues/documentation/
List archives: http://lists.drupal.org/pipermail/documentation/

Re: Getting involved with documentation efforts: how and where?

by Nathaniel Catchpole-2 :: Rate this Message:

Reply to Author | View Threaded | Show Only this Message

Meitar,

You can edit that page directly if you're a member of the documentation team. To do that, you just need to follow the process outlined here: http://drupal.org/node/23367 - the short version is go to http://drupal.org/project/issues/documentation/ and add a request.

You also seem to be our exact target for a proposed new block to make it easier to find information about contributing to documentation - your input would be very helpful on this issue: http://drupal.org/node/263767

Nat




On 5/30/08, Mr. Meitar Moscovitz <meitarm@...> wrote:
Hi all,

I'm new here, and I'm a developer new to Drupal as well. I've just
recently begun working with Drupal full time in a professional
context, and in the process have found the existing Drupal docs to be
of invaluable importance in my learning. Naturally, I found some areas
where they could be better, more clear, or are simply lacking. I
thought I'd raise my hand to volunteer to help out whatever
documentation efforts the Drupal community has and, especially as a
new Drupal user and developer, try to flesh out whatever I can so its
more accessible to people without prior Drupal experience or knowledge.

I've already added a few a page of my own to the documentation, not
very Drupal-specific but helpful (I think), which you can see at http://drupal.org/user/265715/track

A while ago I also put in this documentation issue: http://drupal.org/node/238799

I let it sit for a while since I hadn't had the time to get back to it—
it's always a challenge to balance "getting work done" and "giving
back to the community" as I'm sure you al know. In any event, I'd love
to start getting more involved, but don't know precisely how to go
about doing that. I figured what better place to ask than here, on the
doc list?

Who do I poke about that documentation issue? Where can I go to see
other issues that I can help out with (if not the documentation
issues, which apparently I need special privileges that I lack to
affect). So basically…yeah, where might I be needed, or helpful?

By way of delayed introduction, I'm a technical author and a web
developer/sysadmin by trade. I'm specifically a front-end specialist,
with a focus on semantic web technologies, and if that's not enough,
I'm dating a writer. :)

Cheers,
-Meitar Moscovitz

Drupal: http://drupal.org/user/265715
Personal: http://maymay.net/
Professional: http://MeitarMoscovitz.com/


--
Pending work: http://drupal.org/project/issues/documentation/
List archives: http://lists.drupal.org/pipermail/documentation/


--
Pending work: http://drupal.org/project/issues/documentation/
List archives: http://lists.drupal.org/pipermail/documentation/

Re: Getting involved with documentation efforts: how and where?

by Shai Gluskin-2 :: Rate this Message:

Reply to Author | View Threaded | Show Only this Message

Hi Meitar,

Great piece on setting up a multisite local development server!

Meitar, here is the part that may have confused you: Any registered user of Drupal.org has permissions to create a new handbook page. That's how you could post the multisite local development piece that you wrote to the handbook. If you create the page, you can also edit it.

In order to edit a handbook page that you did not create, you need to be on the docs team. I highly recommend that you join the docs team. Nat Catch gave you the URL and I'll give it to you again: http://drupal.org/project/issues/documentation/  Create a new issue and put in the title, "Request to Join Docs Team." It could take from a couple minutes to a couple days to go through. List your user number and mention that you've written a doc already.

It seems like you got hung up a bit on your lack of permission to assign an issue in the issue queue to anyone other than yourself. That feature isn't really used by the documentation team, anyway. Just post away in the Doc issue queue if you have issues to bring up.

Regarding the issue you raised at: http://drupal.org/node/263767 (Configuring Apache and PHP for Drupal in a Shared Environment" Best Practices), which no one responded to: tt was a proposal, actually a draft, to write another book page.  Let me translate the lack of response: "Meitar, go for it, no objections here." However,  I totally understand that it is hard to read that in the silence.  I'm pleased that you wrote to this list and didn't give up. I'll go leave a note on that issue now. Your experience teaches a lesson about how it can be confusing about how to be involved in Drupal.

I second Nat's suggestion that you join the discussion at: http://drupal.org/node/263767, which in some ways is trying to address isues that you bring up.

How can you help? You already have. More. Keep thinking of handbook pages that you think need writing and write some of them yourself. Poke around the handbook and edit other's work (afteryou get doc team privileges). Monitor this listserve. There are some IRC meeting being convened by Addi Berry to discuss major upgrades to the handbook for the upcoming upgrade to Drupal.org; I believe she always announces those meetings on this list serve. Monitor the documentation issue queue.

Thanks for writing and I look forward to working with you and getting to know you better,

Shai
content2zero


On Fri, May 30, 2008 at 6:41 AM, Nathaniel Catchpole <catch56@...> wrote:
>
> Meitar,
>
> You can edit that page directly if you're a member of the documentation team. To do that, you just need to follow the process outlined here: http://drupal.org/node/23367 - the short version is go to http://drupal.org/project/issues/documentation/ and add a request.
>
> You also seem to be our exact target for a proposed new block to make it easier to find information about contributing to documentation - your input would be very helpful on this issue: http://drupal.org/node/263767
>

> Nat
>
>
>
>
> On 5/30/08, Mr. Meitar Moscovitz <meitarm@...> wrote:
>>
>> Hi all,
>>
>> I'm new here, and I'm a developer new to Drupal as well. I've just
>> recently begun working with Drupal full time in a professional
>> context, and in the process have found the existing Drupal docs to be
>> of invaluable importance in my learning. Naturally, I found some areas
>> where they could be better, more clear, or are simply lacking. I
>> thought I'd raise my hand to volunteer to help out whatever
>> documentation efforts the Drupal community has and, especially as a
>> new Drupal user and developer, try to flesh out whatever I can so its
>> more accessible to people without prior Drupal experience or knowledge.
>>
>> I've already added a few a page of my own to the documentation, not
>> very Drupal-specific but helpful (I think), which you can see at http://drupal.org/user/265715/track
>>
>> A while ago I also put in this documentation issue: http://drupal.org/node/238799
>>
>> I let it sit for a while since I hadn't had the time to get back to it—
>> it's always a challenge to balance "getting work done" and "giving
>> back to the community" as I'm sure you al know. In any event, I'd love
>> to start getting more involved, but don't know precisely how to go
>> about doing that. I figured what better place to ask than here, on the
>> doc list?
>>
>> Who do I poke about that documentation issue? Where can I go to see
>> other issues that I can help out with (if not the documentation
>> issues, which apparently I need special privileges that I lack to
>> affect). So basically…yeah, where might I be needed, or helpful?
>>
>> By way of delayed introduction, I'm a technical author and a web
>> developer/sysadmin by trade. I'm specifically a front-end specialist,
>> with a focus on semantic web technologies, and if that's not enough,
>> I'm dating a writer. :)
>>
>> Cheers,
>> -Meitar Moscovitz
>>
>> Drupal: http://drupal.org/user/265715
>> Personal: http://maymay.net/
>> Professional: http://MeitarMoscovitz.com/
>>
>>
>> --
>> Pending work: http://drupal.org/project/issues/documentation/
>> List archives: http://lists.drupal.org/pipermail/documentation/
>
>
> --
> Pending work: http://drupal.org/project/issues/documentation/
> List archives: http://lists.drupal.org/pipermail/documentation/


--
Pending work: http://drupal.org/project/issues/documentation/
List archives: http://lists.drupal.org/pipermail/documentation/

Re: Getting involved with documentation efforts: how and where?

by Mr. Meitar Moscovitz-2 :: Rate this Message:

Reply to Author | View Threaded | Show Only this Message

Hi Shai, Nat, et. al.,

Thanks for the warm welcome and the pointers to where to go next. I've followed your links and created a new issue to request to join the docs team:


I'll certainly monitor this listserve, though I suspect I'll be quiet-ish while I find my feet. Since working with Drupal is now my day job and I'm still learning about it, I'll probably spend a fair bit of time on the Drupal.org handbook pages in the coming weeks.

Sounds like since I'm in Sydney and much of the Drupal community is in America or Europe, I might not be able to discuss much in real time over IRC or the like. But that's all right, I'll just post here and make what I hope will be helpful edits for a while as I get to know you all.

Thanks again for the warm welcome. I'm looking forward to getting to know all of you, as well,
Cheers,
--
-Meitar Moscovitz


On May 30, 2008, at 11:18 PM, Shai Gluskin wrote:


Hi Meitar,

Great piece on setting up a multisite local development server!

Meitar, here is the part that may have confused you: Any registered user of Drupal.org has permissions to create a new handbook page. That's how you could post the multisite local development piece that you wrote to the handbook. If you create the page, you can also edit it.

In order to edit a handbook page that you did not create, you need to be on the docs team. I highly recommend that you join the docs team. Nat Catch gave you the URL and I'll give it to you again: http://drupal.org/project/issues/documentation/  Create a new issue and put in the title, "Request to Join Docs Team." It could take from a couple minutes to a couple days to go through. List your user number and mention that you've written a doc already.

It seems like you got hung up a bit on your lack of permission to assign an issue in the issue queue to anyone other than yourself. That feature isn't really used by the documentation team, anyway. Just post away in the Doc issue queue if you have issues to bring up.

Regarding the issue you raised at: http://drupal.org/node/263767 (Configuring Apache and PHP for Drupal in a Shared Environment" Best Practices), which no one responded to: tt was a proposal, actually a draft, to write another book page.  Let me translate the lack of response: "Meitar, go for it, no objections here." However,  I totally understand that it is hard to read that in the silence.  I'm pleased that you wrote to this list and didn't give up. I'll go leave a note on that issue now. Your experience teaches a lesson about how it can be confusing about how to be involved in Drupal.

I second Nat's suggestion that you join the discussion at: http://drupal.org/node/263767, which in some ways is trying to address isues that you bring up.

How can you help? You already have. More. Keep thinking of handbook pages that you think need writing and write some of them yourself. Poke around the handbook and edit other's work (afteryou get doc team privileges). Monitor this listserve. There are some IRC meeting being convened by Addi Berry to discuss major upgrades to the handbook for the upcoming upgrade to Drupal.org; I believe she always announces those meetings on this list serve. Monitor the documentation issue queue.

Thanks for writing and I look forward to working with you and getting to know you better,

Shai
content2zero


On Fri, May 30, 2008 at 6:41 AM, Nathaniel Catchpole <catch56@...> wrote:
>
> Meitar,
>
> You can edit that page directly if you're a member of the documentation team. To do that, you just need to follow the process outlined here: http://drupal.org/node/23367 - the short version is go to http://drupal.org/project/issues/documentation/ and add a request.
>
> You also seem to be our exact target for a proposed new block to make it easier to find information about contributing to documentation - your input would be very helpful on this issue: http://drupal.org/node/263767
>
> Nat
>
>
>
>
> On 5/30/08, Mr. Meitar Moscovitz <meitarm@...> wrote:
>>
>> Hi all,
>>
>> I'm new here, and I'm a developer new to Drupal as well. I've just
>> recently begun working with Drupal full time in a professional
>> context, and in the process have found the existing Drupal docs to be
>> of invaluable importance in my learning. Naturally, I found some areas
>> where they could be better, more clear, or are simply lacking. I
>> thought I'd raise my hand to volunteer to help out whatever
>> documentation efforts the Drupal community has and, especially as a
>> new Drupal user and developer, try to flesh out whatever I can so its
>> more accessible to people without prior Drupal experience or knowledge.
>>
>> I've already added a few a page of my own to the documentation, not
>> very Drupal-specific but helpful (I think), which you can see at http://drupal.org/user/265715/track
>>
>> A while ago I also put in this documentation issue: http://drupal.org/node/238799
>>
>> I let it sit for a while since I hadn't had the time to get back to it—
>> it's always a challenge to balance "getting work done" and "giving
>> back to the community" as I'm sure you al know. In any event, I'd love
>> to start getting more involved, but don't know precisely how to go
>> about doing that. I figured what better place to ask than here, on the
>> doc list?
>>
>> Who do I poke about that documentation issue? Where can I go to see
>> other issues that I can help out with (if not the documentation
>> issues, which apparently I need special privileges that I lack to
>> affect). So basically…yeah, where might I be needed, or helpful?
>>
>> By way of delayed introduction, I'm a technical author and a web
>> developer/sysadmin by trade. I'm specifically a front-end specialist,
>> with a focus on semantic web technologies, and if that's not enough,
>> I'm dating a writer. :)
>>
>> Cheers,
>> -Meitar Moscovitz
>>
>> Drupal: http://drupal.org/user/265715
>> Personal: http://maymay.net/
>> Professional: http://MeitarMoscovitz.com/
>>
>>
>> --
>> Pending work: http://drupal.org/project/issues/documentation/
>> List archives: http://lists.drupal.org/pipermail/documentation/
>
>
> --
> Pending work: http://drupal.org/project/issues/documentation/
> List archives:


--
Pending work: http://drupal.org/project/issues/documentation/
List archives: http://lists.drupal.org/pipermail/documentation/