Call for programmers and site builders to help with docs infrastructure!

We encourage users to post events happening in the community to the community events group on https://www.drupal.org.
jhodgdon's picture

If you are an experienced site builder, or a medium-to-experience PHP programmer, the Docs Team needs your help! We have several things that we’d like to get done that will improve the infrastructure for documentation and for contributing to documentation in the Drupal project.

EDIT: I'm marking tasks "taken" if someone has spoken up to do them.
Update Sept 23 - new tasks added!!
Update November 15 - task list edited

Site Builder Tasks

These tasks involve site building for Drupal.org, such as adding a field to a content type, making a view block, maybe doing a bit of CSS tweaking, exporting the content type and view changes as a Feature, and getting these updates deployed on Drupal.org. (Mentoring help is available from Jennifer on the “getting the updates deployed” step, but to take on one of these tasks, you should have the site building knowledge necessary to build the desired functionality). Skills needed:

  • Drush and/or Linux command line updates to site
  • Views, CCK, building content types
  • Features (at a very basic level)
  • Some minor CSS tweaking and/or themeing for some projects

Tasks:

  1. (done) http://drupal.org/node/528682 - Research and set up a solution that allows people to insert images into Documentation pages, without using IMG tags (since they have security implications).
  2. (taken) http://drupal.org/node/733908 - Set up a nodereference on Documentation book pages that references a project, so a page can say which project(s) it references. Then make a tab on the Project page that would show all related doc pages.
  3. (not doing this!)http://drupal.org/node/1027608 - Set up a noderef field for Forum posts to reference Book nodes, and a page/block to show related discussions on Book page nodes.
  4. (taken) http://drupal.org/node/1289072 - Layout and nav tweaks for Book pages - this is dependent on a few other issues, so not quite available to be taken as a task yet!

If you want to take on one of these tasks, the process for getting them done would be:

  1. Sign up for the task -- with a comment below, and assign the issue to yourself. You might want to discuss with Jennifer (jhodgdon) in IRC first.
  2. Get a Drupal.org development server clone -- see http://drupal.org/node/1018084
  3. Develop your solution on your development server clone.
  4. Get some other people to review your solution.
  5. Make a patch (or several patches) that contains your solution. Jennifer can help with this.
  6. Get the patch deployed on Drupal.org. Jennifer can help with this.

Programming tasks - API module

The API module is what generates the api.drupal.org reference site. There are several issues with that module that I’d really like to see fixed (and many others that could be worked on too -- see http://drupal.org/project/issues/api). To work on one of these issues, add a comment to the issue explaining your time frame for working on it, assign it to yourself, make a patch, and set the patch to Needs Review.

High priority, well-defined tasks (which I've marked easy/medium/hard as a rough idea of how much knowledge of the API module and/or Drupal and PHP they would require, or at least I think so):

  1. (taken) (medium) http://drupal.org/node/770784 - Create a new navigation header to facilitate navigate between different Drupal versions of the same function. Right now it us using hook_menu()’s local tasks for navigation, but this doesn’t work well.
  2. (hard) http://drupal.org/node/990108 - Flx links so they work across projects.
  3. (taken) (easy) http://drupal.org/node/1230198 - More prominent link to the file the function is in, when you are viewing a function page (or constant or class or whatever).
  4. (hard) http://drupal.org/node/987450 - On a hook page, list the functions that implement the hook.
  5. (taken) (hard) http://drupal.org/node/745204 - Turn hook names within module_invoke() and theme calls within theme() into links (and other things like that - Drupalism-awareness).
  6. (taken) (easy) http://drupal.org/node/1189498 - Bug fix: See Also section is not working for constants.
  7. (taken) (medium) http://drupal.org/node/1041718 -- Bug fix: files with -- in the name don’t work correctly for links.

Programming Tasks - Help System

We’d like to have a new help system for Drupal 8, which would include a revamped Help module in Drupal core, which would be able to import help documents from a new curated help site (docs.drupal.org or help.drupal.org or something like that). See http://drupal.org/node/1095012 for detailed proposal.

In order to get this done, there are several tasks outstanding (which are detailed on the above page). If you’d like to take one of these on, please comment below and discuss with Jennifer (jhodgdon) on IRC.

  1. Create Help topic entities module. I think Carolyn is working on this -- how is that going?
  2. Create an outline/map builder module. I think Tamas/yorirou has a start on this -- is it a sandbox yet?
  3. Create a Glossary module, with an A-Z glossary index and the ability to have pop-up glossary links as a text filter.
  4. (taken) Create the doc importer client and server modules.
  5. (taken) Research workflow modules and techniques, and create (probably) an add-on for the Workbench module that would accomplish the editorial/translation workflows we need for the official help site.

Other Module Development Tasks

  1. http://drupal.org/node/1289090 - Build a drop-down navigation block for Books, to replace the current (large, space-eating) book navigation we have on the sidebar of all Documentation pages currently
  2. (not doing)Figure out how to convert existing Book page comments into Forum posts (dependent on Site Building item above where nodereference is added to Forum to point to Book page, so not really available to be taken as a task yet).

Comments

anyone?

Sree's picture

Hi,

I can pick:

Create the doc importer client and server modules.
Research workflow modules and techniques, and create (probably) an add-on for the Workbench module that would accomplish the editorial/translation workflows we need for the official help site

Anyone else picked any of these?

Sree

No one as of yet...

jhodgdon's picture

How about if you pick one to start with, in case someone else wants to help with the other? I think they will both take some work, and I think it would be a good idea to start by creating a sandbox project, and committing code as you go, so anyone who is interested (such as myself) can try it out and offer suggestions. Thanks!

i am in

dgoutam's picture

Why not fix conf call as a kickoff?

Huh?

jhodgdon's picture

I am not sure what you are talking about here...

@jhodgdon Ok - I would start

Sree's picture

@jhodgdon

Ok - I would start with Research workflow modules and techniques, and create (probably) an add-on for the Workbench module that would accomplish the editorial/translation workflows we need for the official help site

I would come up with my analysis shortly.

IRC nick: sreeveturi

Sree

Great!

jhodgdon's picture

I had earlier marked that as "taken" but forgot to thank you for taking on this task. :)

Check this out...

jhodgdon's picture

Hi Sree,

Alex UA pointed out this other module that may have some of the editorial control parts we need:
http://drupal.org/project/revisioning

Looks like it's worth checking out, as an alternative to or addition to http://drupal.org/project/workbench

I'll send you this by email too just to make sure you've seen it. :)

revisioning / workbench

Sree's picture

Hi jhodgdon,

Thanks for updating me with the suggestion from Alex.

I have used revisioning earlier but alone it wouldnt serve our requirement.

We may need to come up with a mixture of revisioning capabilities to workbench as an add-on.

Please let me know your views/ suggestions.

Sree

Pls share your suggestions here ...

Sree's picture

Everyone,

Please feel free to share your suggestions here: http://drupal.org/node/1283496

Sree

(hard)

alanmackenzie's picture

(hard) http://drupal.org/node/745204 - Turn hook names within module_invoke() and theme calls within theme() into links (and other things like that - Drupalism-awareness).

I'm happy to do this over the weekend. I'll come find you on IRC after work.

Great!

jhodgdon's picture

I won't be around late today or over the weekend, but you may be able to get some help from drumm (the maintainer of the module). Start by assigning the issue to yourself, in any case! Thanks!

project reference

mojzis's picture

i will try to do the project reference : http://drupal.org/node/733908

Sounds good!

jhodgdon's picture

I see you already assigned the issue to yourself. It might take a little while to get things set up (i.e., your Drupal workspace), so be patient. Thanks!

i got slightly confused - I

mojzis's picture

i got slightly confused - I did get access to the staging server, but there is only 1 new directory under dev, which is docnoderef-drupal.redesign.devdrupal.org . I guess we can work on this one together, I just wanted to make sure that is what we are ment to ?
thanks :-)

Work on which together with whom?

jhodgdon's picture

That is up to you and the other person to coordinate. If you want your own dev site, you can probably get one, but you have to request it.

thus far, you are the one to

mojzis's picture

thus far, you are the one to whom the #995292 is asssigned :). Probably the most logical would be for me to take it too, if there is noone else.

Ah.

jhodgdon's picture

Sorry, I just forgot to un-assign it from myself. Feel free to take it over. :)

Spoke too soon...

jhodgdon's picture

I forgot that davidhernandez is working on this one. Sorry! See below..

Create a new navigation header

schiavone's picture

I can work on this next week

(medium) http://drupal.org/node/770784 - Create a new navigation header to facilitate navigate between different Drupal versions of the same function. Right now it us using hook_menu()’s local tasks for navigation, but this doesn’t work well.

Excellent, thanks!

jhodgdon's picture

I see you've already assigned the issue to yourself - thanks! Looking forward to testing out the patch. This is something we desperately need by November 1st (if not already), since it will allow people to navigate between function versions when the file names have changed. (The reason Nov. 1st is important is that there is a patch scheduled for that day that will move all Drupal 8 files into a "core" directory, so suddenly every Drupal 8 function will be in a different file from its corresponding d7 function.)

Deadline's help

schiavone's picture

Thanks for the heads up

Research

MGParisi's picture

Ill

Research and set up a solution that allows people to insert images into Documentation pages, without using IMG tags (since they have security implications). (“Inline” module?).


--Sig--
Owner of Proper Programming, LLC a software and website development firm.

It should be noted (as I

arianek's picture

It should be noted (as I mentioned in the last comment on the issue) that webchick had a working prototype of this already built - if she still has it, we just need to help her get it exported as she was having some issues with featurizing it. I'll ping her and see what's up... (keep an eye on the issue for updates).

Removed

MGParisi's picture

Well the issue has been taken over by half of Drupal (including Web Chick, Sun, Chx, and half of Contrib), so I guess My Job is Done!


--Sig--
Owner of Proper Programming, LLC a software and website development firm.

Indeed, they have been

arianek's picture

Indeed, they have been speedy! ;) Thanks for the hypothetical help on it though!

Will Take Credit

MGParisi's picture

I will be happy to take credit on the completion of a resolution of this issue; However if the issue fails to find a conclusion, I have a list of names to blame! ;)


--Sig--
Owner of Proper Programming, LLC a software and website development firm.

I'll work on #995292

davidhernandez's picture

I'll work on #995292

Thanks

jhodgdon's picture

Sounds good!

aenw's picture

I'll take on this API task:

(easy) http://drupal.org/node/1230198 - More prominent link to the file the function is in, when you are viewing a function page (or constant or class or whatever).

Great!

jhodgdon's picture

I see you're already working on this on the issue - much appreciated!

I took (easy) 1189498 - Bug fix: See Also

aenw's picture

I took care of: (easy) http://drupal.org/node/1189498 - Bug fix: See Also section is not working for constants.

will take (medium) 1041718 Bug fix: files with -- in the name

aenw's picture

I'll take: (medium) http://drupal.org/node/1041718 -- Bug fix: files with -- in the name don’t work correctly for links.

Although jmrivero has already done a lot of the footwork needed (but says can't do development on it right now, so I should take it).

Noted!

jhodgdon's picture

Thanks! It's great to see people taking an interest in fixing up the API module -- much appreciated!

New tasks added!

jhodgdon's picture

We now have a concrete proposal for how to restructure the current d.o Documentation -- see http://drupal.org/node/1278256 (you only need to read the issue summary to see what's proposed).

So, there are some new tasks in the list above, which will help us make that happen. Any takers? :)

vaidik's picture

I am interested in taking up the Create the doc importer client and server modules task.

I guess nobody has taken that yet.

Vaidik Kapoor

Sounds good...

jhodgdon's picture

Great! I guess we don't have an issue for this yet. So I would suggest starting by posting an issue, and creating a Sandbox project where you can work on this. It's a fairly involved/large project, and needs to be written carefully so that the client can get into Drupal Core eventually, so I hope you are open to some careful, constructive criticism!

Great!

vaidik's picture

Apologies for the late reply. I have been away for long.

I am excited to work on this. And I am open to all sorts of suggestions, criticisms, guidance. I really want to work on this. After SoC, getting to contribute to D8 is really great for me! :)

Vaidik Kapoor

Urgent need for site builder!

jhodgdon's picture

We have come to a conclusion on what we need to do for the Community Docs ... we really need someone to take on task #3 above:

http://drupal.org/node/1027608 - Set up node ref for doc pages on forums

There are some other tasks in the "remaining tasks" section of the main issue too that can be claimed:
http://drupal.org/node/1278256

It's a great time to get involved!

Ready to pick http://drupal.org/node/1027608

surendramohan's picture

Hi,

I am ready to pick http://drupal.org/node/1027608:
"Set up a noderef field for Forum posts to reference Book nodes, and a page/block to show related discussions on Book page nodes."

Please let me know how to proceed ahead.


Surendra Mohan
Drupal Consultant | Architect | Author | Trainer | Blogger
http://www.surendramohan.info/

Sorry...

jhodgdon's picture

I need to update this post -- we decided not to do that... let me update the list and maybe you can find something else that would be of interest to you. Thanks for your interest!

List updated...

jhodgdon's picture

The list above has been updated. I guess we don't have any site builder tasks at the moment, sorry!

Documentation

Group categories

Event type

Post type

Group notifications

This group offers an RSS feed. Or subscribe to these personalized, sitewide feeds: