There are a lot of good Drupal tutorial videos available on the web, and it would be nice to be able to include (some of) them in the documentation on drupal.org. Videos is a great way to complement written documentation, especially when it comes to learning how to use computer tools. It's a bit problematic that user interfaces may change and make videos outdated, but that's a problem with any documentation that is detailed. ...more »
We currently keep docs on d.o and in version control. Since docs are tied to code, I feel that the authoritative source should most naturally our git repositories. The suggestion would be to investigate how we can start deriving some degree of docs from files we commit to VCS, ideally written in a simple markup language like markdown. Obviously this would require other very significant efforts in regards to UI changes ...more »
There are hundreds of modules and themes and every one of them wants to introduce there module or theme or features or just help starters. Registered users should be allowed to post videos from YouTube or other sources and link them on Drupal.org/ ScreenCast??? And Voting the videos is most important part because there will be similar videos posted by different users. Highest voted videos will be shown on top of others ...more »
Link d.o project pages, which are fully controlled by the project maintainer(s), to the documentation page for each project (which can be edited by everyone) as soon as the documentation page exists.
The coder module carefully checks whether a contributed module conforms to the Drupal code comment standards. However, Drupal.org is not doing anything with the code documentation. Perhaps automatically generated API docs can be generated for modules with a sufficient level of conforming documentation, much like PEAR does for its projects.
Just goin' out on a limb here, but...
Would it be helpful to see a related block of current issues related to a certain docs API page?
Does this initiative already exist?
When you search for advice would be useful to filter only those docs and forum discussions pertaining to your version of Drupal.
Edit: note that you can already tag by version when creating a forum topic (don't know about creating docs), but I don't see any way of filtering search results by version. This would be of most benefit in searching documentation.
(thanks poster below! Hope it makes sense now)
I think it will be good to have a dedicate sprint of 4 hours at each Drupal Con for everyone to contribute to Documentation... Also the documentation today can be STRUCTURED better. Today the documentation lacks standardization and appears very random on some modules. It must the use cases applicable for each module, provide screenshots, demo sites, screencasts and case studies references for each Module / Feature ...more »
As a complete newbie, one of the most confusing things is to be reading documentation explicitly for drupal 7 and follow a link to a page which is only for drupal 6.
Also. I have not found any quick start guides so I am in the process of writing an extensive one, which I will post after I have succeeded in getting my first three sites up and running.
Links to d.o documentation from api.d.o currently are not very visible, if they exist at all. They are usually buried and readers could benefit from having them pulled out into their own section or highlighted with better markup.
Somehow provide a link from api.d.o topics back to the associated documentation on d.o. For example, there's quite a bit of good information at http://drupal.org/node/37775 on the Form API which topic pages like api.drupal.org/api/drupal/includes!form.inc/group/form_api/7 could link to.
There are 8000 pages of documentation on Drupal.org, far too much for a single docs team (and a single docs team lead) to oversee. Even with this glut, many modules and tasks do not have adequate documentation. At the same time, there is a wealth of high-quality documentation posted on blogs that come through Drupal Planet. However, this documentation is hard to find when you need it. If blog authors add just a little ...more »