Google Season of Docs 2019 - Idea List

We encourage users to post events happening in the community to the community events group on https://www.drupal.org.
You are viewing a wiki page. You are welcome to join the group and then edit it. Be bold!

NOTE: Please preview this wiki before submitting the edit form. Some edits seem to break the wiki, so you MUST click on preview before hitting SAVE.

Welcome to Drupal's wiki organizing project ideas for Google's Season of Docs 2019. Please utilize this wiki to document project ideas and list yourself as a potential writer or mentor. Find us on Slack at #drupal-google if you want to chat.

Edit this wiki and add your project ideas. If you want to mentor a task, add your name. If you DON'T want to be a mentor, leave the field blank as other mentors might be interested if a project is selected.

How to think of documentation ideas?

  • Drupal 8 is here! There is TONS of documentation work to be done!
  • Review current projects being ported to Drupal 8 @ https://contribkanban.com/board/contrib_tracker
  • Have a module ready for the community but don't have documentation?
  • Maintain a module and need help taking documentation to the next level?
  • Have you ever said "I can't figure out how to configure module X in Drupal?"

Guidelines

Anyone with a drupal.org account is allowed to post ideas into this wiki. Even if the idea is basic or not complete, please add whatever you have. Additional mentors are available if project idea is accepted. Writers are encouraged to contact the project author via their drupal.org contact page.

Information for Writers

Read the GSoD Technical Writer Guide

Information for Mentors

Read the GSoD Mentor Guide.

Copy/paste the template below to bottom of content in this wiki. Enter your idea and be careful with revisions as this may be a popular node to edit.

=================================

Project Name: NAME OF IDEA EXAMPLE

Project Mentors: d.o user names to open contact

Project Difficulty: INTERMEDIATE/DIFFICULT

Project Skills/Prerequisite: STUFF LIKE PHP, SYMFONY, SQL, CMS

Project Description: DESCRIPTION OF PROJECT?/IDEA

Project Goal: WHAT IS PROJECT ACCOMPLISHING AND WHAT WILL BE THE FINAL DELIVERABLE?

Project Resources: This is place for writers to find resources/links and direction on how to research the documentation. Example, is this a specific type of module related to Commerce in Drupal 8? Should the writer join any groups on gdo, dig through mailing list archives, or search specific issue queues? If this is a module documentation, maybe you can list links of previous modules accomplishing similar functionality with previously created documentation.

=================================

Project Name: Migrate GSoC documentation

Project Mentors: Slurpee

Project Difficulty: Easy

Project Skills/Prerequisite: GSoC, PHP, basic development setup

Project Description: Migrate GSoC documentation from legacy doc system to new system

Project Goal: Currently we have GSoC documentation in the legacy doc system on drupal.org. Project goal is to migrate to the new system and improve documentation when available.

Project Resources:

Current GSoC documentation @ https://www.drupal.org/node/2415225

Example of GCI documentation already migrated to new system @ https://www.drupal.org/docs/develop/for-gci-students-where-to-start

=================================

Project Name: Drupal 8 Security Modules Documentation Initiative

Project Mentors: nerdstein, daggerhart, manuel garcia, rlhawk, gambry

Project Difficulty: Intermediate

Project Skills/Prerequisite:Basic security concepts

Project Description: Many of the security related modules for Drupal 8 need better documentation. And, many of the modules work together. Such examples include Encrypt, Key, TFA, GA Login, Real AES, Encrypt RSA and more. This initiative would be to do a broad sweep through these modules and help create and/or improve documentation across the board.

Project Goal: Analyze the modules and propose/create a baseline set of documents.

Project Resources:

=================================

Project Name: User Guide Volume 2

Project Mentors: jhodgdon, eojthebrave, Amber Himes Matz

Project Difficulty: intermediate

Project Skills/Prerequisite: Drupal site building at an intermediate/advanced level. Ability to write in AsciiDoc format (similar to Markdown) (not difficult to learn).

Project Description: We currently have a User Guide for Drupal 8, which is a tutorial that teaches the basics of site building with Drupal. It's quite basic. The idea of this project would be to develop more advanced site building topics to be put into a "Volume 2". Each topic (or perhaps set of topics or chapter) would stand on its own (knowledge of the basics in the User Guide would be assumed, but readers could pick topics from Volume 2 to read that interested them). Topics could include:

  • Views - advanced usage, more examples, contrib views modules, exporting data
  • Layouts
  • Data modeling - more advanced, more examples
  • Custom theming
  • Media handling
  • Menus, navigation, breadcrumbs, pathauto
  • Rules

Project Goal: Write various topics for Volume 2 of the User Guide

The goal is not necessarily to write all the documentation yourself, but rather to help facilitate it being written. This includes, drafting an outline for one or more sections of the guide. Submitting the proposed outline for feedback from the community and soliciting feedback from community members with advanced knowledge of the underlying systems. Drafting an outline for each concept and task, and then getting those pages written by both writing yourself and helping to coordinate the efforts of other community members. Reviewing and providing feedback to others helping with the writing. And more.

In order to be successful with this initiative you'll need to both write documentation, and help coordinate the efforts of others in the community. This is a great opportunity to learn the ins and outs of contributing to a large open-source project's documentation, building community, and helping mentor on-board new contributors.

Project Resources:
Original User Guide project: https://www.drupal.org/project/user_guide
(Project page has links to the contributor guide, and to the User Guide itself)

=================================

Project Name: Actions module & API rewrite

Project Mentors:

Project Difficulty: beginner

Project Skills/Prerequisite: Familiar with the plugins API

Project Description: The current documentation for the core Actions module is out of date. The site builder side of the documentation of the Actions module also includes code documentation (which seems out of place, also out of date). There is no API section for action plugins in the code-orientated documentation pages.

Project Goal:
Reorganised, succinct site builder documentation for the Actions module to reflect the current state of the module in core.
Have an API documentation page for Action plugins.

Project Resources:

=================================

Project Name: Make a "Contribute" or "Getting Involved" section of docs

Project Mentors: jhodgdon, rachel_norfolk

Project Difficulty: medium

Project Skills/Prerequisite: Ability to reorganize messy pile of documentation into coherent structure

Project Description: On drupal.org, we currently have an outdated and disorganized section that documents the "how" for potential contributors to the project. This section needs to be reorganized, and some documentation will need to be edited and/or rewritten.

Project Goal: A section of documentation, called either Getting Involved or Contribute or something like that, that describes the "how" of various ways that people can contribute their skills and time to the Drupal project. We're looking for documentation on how to use the issue queue, how to use Git, how to make a patch file, how to update documentation, how to find something to work on, and things like that -- but not programming details like how to write a module, how to create a theme, or use a specific API (those belong elsewhere). So some of the documentation under Getting Involved may need to be moved out; some may be outdated and need updating; some may duplicate other pages; and we may need new pages written.

Project Resources:

  • The newly reorganized Community section is at https://www.drupal.org/community . That section is meant to give people ideas about how they can connect to the community and contribute to the project, and (though it can be updated), it's pretty decent. What we're looking for in this project is the pages that tell people who have found something they're interested in contributing to how to do it (so sections on Community might link to documentation in the new Contribute guide).

  • The current Getting Involved section is at https://www.drupal.org/getting-involved-guide ; confusingly, there is also a Getting Involved landing page at https://www.drupal.org/getting-involved that is kind of weird (it mostly points to pages within the Getting Involved Guide). The documentation there is somewhat OK, but it's hard to find things in it and it all needs reorganization.
  • One section of the Getting Involved guide is pretty good: https://www.drupal.org/contributor-tasks -- pages within this section use templates and describe specific tasks for contributors. Perhaps the rest of the information under Getting Involved could be reorganized into this section?
  • We have an issue describing the desired outcome (maybe slightly outdated, given that we finished making the Community section described just above): https://www.drupal.org/project/drupal_org_community/issues/1414988

=================================

Project Name: NAME OF IDEA

Project Mentors: d.o user names to open contact

Project Difficulty: INTERMEDIATE/DIFFICULT

Project Skills/Prerequisite: STUFF LIKE PHP, SYMFONY, SQL, CMS

Project Description: DESCRIPTION OF PROJECT?/IDEA

Project Goal: WHAT IS PROJECT ACCOMPLISHING AND WHAT WILL BE THE FINAL DELIVERABLE?

Project Resources: This is place for writers to find resources/links and direction on how to research the documentation. Example, is this a specific type of module related to Commerce in Drupal 8? Should the writer join any groups on gdo, dig through mailing list archives, or search specific issue queues? If this is a module documentation, maybe you can list links of previous modules accomplishing similar functionality with previously created documentation.

=================================