Drupal 8 Docs: Some Thoughts

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

With feature freeze for Drupal 8 approaching quickly, I thought it might be a good time to raise the thorny subject of what can/should/will/might be done to update the core documentation on d.o and the online help. At a bare minimum, it would be useful to at least articulate the scope of the work and perhaps identify priorities and challenges.

Another closely related question is how d.o.'s upgrade to D7 and the GSOC work on the help system might impact the approach to D8 documentation. This might significantly affect the way content is handled and how much work can be accomplished by a tiny and highly transient group of contributors. That's a topic for another post but if anyone has information or opinions, please post in the comments!

Eventually it would be nice to work up a comprehensive doc plan that covers everything in detail but to get the ball rolling, here's a first crack at articulating the scope of documentation impacts, broken out by guide. This is based on a quick initial scan and is just intended to get the conversation started (if there's anyone out there to converse with):

  • Understanding Drupal - Probably no significant changes (but needs to be checked)
  • Installation Guide - system requirements has already been updated, installing contributed modules is a little different in D8. Because the directory structure is different in D8, various parts of the installation guide will need to be updated. Also the install script itself will be different. Looks like there might be lots of stuff under the "Additional Topics" heading (which should be changed to something less vague). Do we need a separate "Installing Drupal 8 Section"?
  • Administration and Security Guide - We have a 'Getting Started with Drupal 7 Administration' section and will probably need a similar section for D8 (or rethink the concept of that section). The security section I'm guessing will be largely unchanged but that assumption needs to be validated. There's a "Managing Configuration in Drupal 8" stub which needs to be fleshed out. I believe there are some big changes in this area so it might be a bit of work. A big priority in this guide will be in the 'Upgrading From Previous Version Section' where there absolutely must be an 'Upgrading From 7 to 8' page. The rest of the guide needs to be evaluated for changes.
  • Structure Guide - Now that Views is in core, this section will become a priority. A lot of conceptual/structural stuff seems to be changing (i.e. blocks) so there's probably some significant updates needed throughout this guide.
  • Site Building Guide - Much of this guide is based on contrib modules but there are definitely chunks that need updating like the list of core modules and various topics such as media handling
  • Multilingual Guide - Big changes now that Drupal 8 is supposed to be international out of the box.
  • Theming Guide - More significant changes to theming in D8. I suspect that this will again be one of the biggest and thorniest guides to deal with. And probably we will again have the discussion of whether there should be version-specific Theming Guide and again I will say yes ... BUT ... we desperately need a way to reuse generic content across guides (as opposed to duplicating content in each guide which, in technical communication, is the equivalent of killing kittens).
  • Mobile Guide - Looks relatively generic and contrib-focused but needs further analysis
  • Develop for Drupal - There has been some ongoing work to update for D8 but there will probably be some fairly significant changes and new content. One priority might be a "Creating Drupal 8.x modules" section (to go with similar sections for 6 and 7)
  • Everything else on d.o. - Most of the other guides, like FAQs, recipes, etc. are done on an ad hoc basis anyway, so are probably out of scope for this survey (and the API reference is a different world)
  • Help - No idea what is planned for D8. Anybody want to jump in?

Thoughts? Comments? Please jump in

Comments

The New Help System...

jhodgdon's picture

The proposed help system that the two GSoC students worked on the past two summers is not going to make it into Drupal 8. It's just not ready enough to make the deadline (which is Nov 30). For reference, the help system is described/specified here:
http://drupal.org/node/1095012
and the issue tracking progress is:
http://drupal.org/node/1549580

I have some hope that we'll be able to deploy the "better documentation" system components of that on drupal.org after d.o is updated to drupal 7, but I don't have a timeline right now, and we need to get some governance in place for the documentation team before we even contemplate deploying tools.

Tools impact

LeeHunter's picture

So it sounds like we should assume that by the time help.d.o. is implemented, tested, deployed it will likely be rather late in the D8 cycle which means that d.o D8 docs will use the same approach as was used for D7. And then at some point all the content will be refactored as needed to fit the new model.

For example, in the Theming Guide we'll simply add D8 info to the current version like was done for D7. The user will continue to see a somewhat overwhelming guide that displays content relevant to all versions (as opposed to being able to open a streamlined "Drupal 8 Theming Guide" which is simply the theming content filtered to show only generic + D8-specific content). And we won't have the ability to map a single chunk of content to multiple guides etc.

And the Help text will continue to live in strings as duplicated content which we'll continue to try to keep consistent with similar content on d.o.

Those things are not ideal but not a huge impact on the effort towards updating the docs for D8. The one tool that could potentially have a major impact would be inline editing which, I think, would both provide a huge productivity boost and make it more likely that people will jump in and start editing.

Issues created

LeeHunter's picture

Most of the points above have now been broken out in the issue queue http://drupal.org/project/issues/search/documentation?issue_tags=d8docs

Regarding updating the Help

batigolix's picture

Regarding updating the Help sections of the core modules: we probably need a meta issues for that in the drupal core issue queue, with issues for updating the help sections of each individual module. Right?

There doesnt seem to be such an issue yet:
http://drupal.org/project/issues/search/drupal?text=help&assigned=&submi...

For some modules a related issue exist:
- locale: http://drupal.org/node/1861934
- cmi: http://drupal.org/node/1831798
- node: http://drupal.org/node/19882
et cetera

Help and d.o. docs

LeeHunter's picture

Yeah a meta issue for the Help topics would be good.

I'd also like to somehow align the Help for each core module with the content that's in the d.o. docs. Unfortunately, we're not at the point where we can write it in one spot and then programmatically reuse the content in both places, but it would be good if we could at least recognize that we've got this fork happening.

Maybe each of these issues should have two parts, the help and the online versions, so that whoever is looking at the Help for module x is also looking at the d.o. content.

Regarding the help topics: we

batigolix's picture

Regarding the help topics:

we need to keep an eye on the Issue about using Twig templates for help

Unlikely

jhodgdon's picture

We have already passed Feature Freeze and my personal opinion is that this "help topics using twig" thing is likely to get into Drupal 8. It would require:
- Everyone to agree on the format
- Some code to be written
- The effort to not be considered a "feature", since new features are not allowed any more in Drupal 8

All three are questionable, in my opinion, and I think right now the best idea is to focus on the help text anyway. If good text is written, we can find people to make it into PHP patches within the current help system without any problem.

About the meta issue for

batigolix's picture

About the meta issue for help:

We would need something like:
https://drupal.org/node/537828

With a list of all modules and links to an issue for updating the hook_help of each individual module like in:
https://drupal.org/node/537828#comment-2263104

The meta issue can also be used to discuss what we want to achieve with updating the help texts for Drupal 8 . We did a major clean up, standardization and textual & style improvements for Drupal 7. Question is what we want for Drupal 8 (in realistic terms).

Already a meta issue for hook_help()

jhodgdon's picture

The in-Drupal help for Core modules (provided by hook_help() in the code) already has a meta issue:
http://drupal.org/node/1908570

Documentation

Group categories

Event type

Post type

Group notifications

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