Problem/Motivation
We have role task cards https://www.drupal.org/sprint-task-cards
There have been a number of discussions about how to encourage and recognize contributions to Drupal that are not about creating, reviewing, and testing code. In specific, some of these discussions have centered on the topic of documentation.
I noticed that none of the contributor cards mention documentation.
Proposed resolution
If we continue to use "contributor cards" at future events. Consider adding a card/sticker for documentation "Documentor"? Or adding a documentation task on one of the other cards. For example: Adding something about documentation on "Community Contributor" card (This is not my first choice, but is acceptable option).
Proposed card text
# Documentor
You are a Community Contributor who can write well in English, and are ready to share knowledge about Drupal 8 with others.
## Get Ready to Sprint
- Join #drupal-docs on IRC.
- Review documentation style guide, and instructions for taking screenshots, and uploading images. https://www.drupal.org/governance/documentation-policies - https://www.drupal.org/node/762
- Figure out how to take screenshots on your OS.
- Read the current documentation priorities. https://www.drupal.org/node/1005304
## Sprint
- Work on writing, editing, or reviewing the Drupal 8 User Manual. https://www.drupal.org/project/user_guide
- Fix documentation page titles. https://www.drupal.org/contributor-tasks/fix-page-titles
- Add keywords to a documentation page. https://www.drupal.org/contributor-tasks/add-keywords
- Incorporate the content of a comment into the documentation itself. https://www.drupal.org/contributor-tasks/incorporate-comments
## Bonus
- Work on any issue with the d8docs tag or in the documentation project issue queue. https://www.drupal.org/project/issues/documentation?categories=All - https://www.drupal.org/project/issues/search?status[]=Open&issue_tags=d8...
- Work with subject matter experts to document things they are working on.
## Continue At Home
- Attend Drupal Core office hours.
- Join groups.drupal.org/documentation.
Next: Mentor or Developer
Proposed card text (Spanish)
# Documentor
Eres Community Contributor con nociones de escribir en inglés, y estás preparado o preparada para compartir tus conocimientos sobre Drupal 8 con otros.
## Prepárate para el Sprint
- Únete a #drupal-docs en IRC.
- Revisa la guía de estilo de documentación, y las instrucciones para hacer capturas de pantalla y subir imágenes. https://www.drupal.org/governance/documentation-policies - https://www.drupal.org/node/762
- Descubre cómo hacer capturas de pantalla en tu sistema operativo.
- Lee las necesidades prioritarias de documentación. https://www.drupal.org/node/1005304
## El día del Sprint
- Trabaja escribiendo, editando o revisando el Manual de Usuario de Drupal 8. https://www.drupal.org/project/user_guide
- Arregla títulos de páginas de documentación. https://www.drupal.org/contributor-tasks/fix-page-titles
- Añade palabras clave a una página de documentación. https://www.drupal.org/contributor-tasks/add-keywords
- Incorpora el contenido de un comentario a la propia documentación. https://www.drupal.org/contributor-tasks/incorporate-comments
## Tareas extra
- Trabaja en algún issue con la etiqueta d8docs o de la lista de issues del proyecto de documentación. https://www.drupal.org/project/issues/documentation?categories=All - https://www.drupal.org/project/issues/search?status[]=Open&issue_tags=d8...
- Trabaja con expertos en la materia para documentar áreas en las que están trabajando.
## Continúa en casa
- Asiste a las IRC core office hours.
- Únete a groups.drupal.org/documentation.
Siguiente: Mentor o Developer
Remaining tasks
- lay it out for print to see if we have too many items/words
- clarify wordings (so if people google it, they might, for example, find the doc or contributor task page
- change the format to html, make the html match the pattern for the other cards https://github.com/drupal-mentoring/drupal-contributor-roles/blob/master...
- get reviews
- needs a spanish translation
- make a pull request to add a reviewed version to the github repo https://github.com/drupal-mentoring
- take the urls out (for the print version)
Comment | File | Size | Author |
---|---|---|---|
#27 | sprint-task-diagram.svg_.txt | 13.52 KB | kattekrab |
#27 | sprint-task-diagram.png | 12.55 KB | kattekrab |
#27 | sprint-task-diagram.pdf | 4.65 KB | kattekrab |
#24 | sprint-tasks-documentor.png | 149.42 KB | kattekrab |
#24 | sprint-tasks-documentor.svg_.txt | 31.09 KB | kattekrab |
Comments
Comment #1
dman CreditAttribution: dman commentedThis is totally possible.
It just needs wording and tasks that can be identified as deliverable achievements, in a similar format to the others.
Before our sprint, we tried and failed to come up with enough appropriate tasks that didn't end up nebulous "Improve a handbook page on drupal.org" or hard to follow through without eventual code work "Add a step to tour.module for part of the UI that you think needs it".
Please lets get some ideas on the wording you want to see! We should come up with half a dozen, one-sentence tasks that are as substantial and do-able, and as the ones on the other cards.
Given the *content*, there should be nothing preventing anyone dropping it into a template.
Comment #2
eojthebraveHere's a first pass at some text for this card:
I moved this text to the issue summary so others can help refine it ...
I would also recommend that we update the "Explorer" and "Community Contributor" cards to indicate the "Documentor" is a possible next step.
Comment #3
eojthebraveComment #4
dinarcon CreditAttribution: dinarcon commentedComment #5
YesCT CreditAttribution: YesCT commentedI think that some of the things about being and explorer, and a community contributor are needed before contributing to documentation. (they need to know something about what they are documenting, and they need a drupal.org account and to be in irc).
Note that all the other role cards talk about drupal 8.
We use these for the Drupal Core Mentored Sprint, which has a Core (drupal 8) focus.
I suggest it start with
You are a Community Contributor and ready to start documenting Drupal 8.
Or maybe
You are a Community Contributor, a good writer in English, and ready to share knowledge about Drupal 8 with others.
(that might be too long, and there might be some strange grammar in that wording)
Comment #6
YesCT CreditAttribution: YesCT commentedmany of the other cards, if you add up the checkbox things under get ready, sprint, bonus, continue at home, have between 9 and 12 checkbox items.
This has 14.
I think we should scale back the items both for layout space reasons, and also so we do not overwhelm the new documentors.
they should be in the docs irc cannel while sprinting.. not just at home IMO
I put it first under get ready to sprint, because that is where they can ask questions about how to do the stuff on the sprint card (in addition to working with people in the room).
Note, we avoid URLs on the cards, so we may want to phrase these things more specifically....
OH, I see we took out the online versions when we moved to github.
https://www.drupal.org/node/2306609/revisions/view/7762059/8033509
I think we might want to consider having something that would generate the online version to put on d.o which could have links, but still track changes through github.
I will post a comment about that on #2269681-98: (BCN, Due: 2015-08-20) Contributor role cards and stickers for booth
Comment #7
YesCT CreditAttribution: YesCT commentedCheck out can mean something very specific with regards to git, and might not be easy for non-native english speakers to understand.
I think what we mean is "Read"
--
I think the screenshots style guide has some hints about how to take screenshots, so reading that could be helpful to do first.
ohh... no it does not. ok. leaving the order as it was.
--
I think the tag does not have a # in it.
Comment #8
YesCT CreditAttribution: YesCT commentedI rearranged some checkbox tasks, moved the issue queue ones to bonus.
(so that people who do the others, but do not get to them will not feel like they didn't get enough done)
--
I removed the
- Answer a question in the support forums
line.
because this reduces the number of things on the card (good)
and because I'm not sure this is an actual recommendation that has community consensus. (things have been moving off the forums).
Comment #9
YesCT CreditAttribution: YesCT commentedThe other cards have periods at the end of their task sentences. Making this consistent with that pattern.
also added Core to the office hours line (might want to check other cards to make sure we are referring to them all the same way).
took "the" out of the irc channel line. (instead of adding in the word "channel")
Comment #10
YesCT CreditAttribution: YesCT commentedupdated remaining tasks
Comment #11
eojthebraveComment #12
eojthebraveThansk @YesCT. Great suggestions.
I've made a few more tweaks. I combined the two bonus elements that relate to finding issues in the queue to a single line, and I've combined the review style guide, and review screenshot instructions into a single element as well. This helps to tighten things up.
I also did a little bit of wordsmith/tweaking after doing a few Google searches to try and help make sure people get to the right pages.
As far as I'm concerned the content for these is good. As long as it fits well into the print layout.
Comment #13
eojthebraveComment #14
eojthebraveI might be jumping the gun here, but I made a pull-request to help keep things moving along. https://github.com/drupal-mentoring/drupal-contributor-roles/pull/8
Though, we should probably still get some reviews in this issue first I suppose. :)
Comment #15
eojthebraveChanging this to needs review so that it's clear what the next step is.
The thing that needs reviewing is the text for the proposed documentor card, either in the issue summary above, or in this pull-request. They are both the same text, so whatever is easier for you to read. https://github.com/drupal-mentoring/drupal-contributor-roles/pull/8
Comment #16
stpaultim CreditAttribution: stpaultim commentedI looked over the lastest text and it looks good to me. I'm going to leave this on "needs review" for a little longer to see if anyone else wants to add any comments.
Comment #17
dman CreditAttribution: dman commentedSounds a little *not* to me.
I suggest
I read through the corresponding contributor tasks - and they seem really well done..
I like what has been happening in Documentation this year. The top-level topic page rewrites are landing well, and the This month in Drupal documentation updates show a lot of activity.
I really do think that this idea of actively encouraging documentation as a sprint task is a great idea.
Comment #18
alimac CreditAttribution: alimac commentedComment #19
kattekrab CreditAttribution: kattekrab at Creative Contingencies commentedI think this is an AWESOME idea.
And I just updated the issue summary based on D-man's suggestion.
Comment #20
kattekrab CreditAttribution: kattekrab at Creative Contingencies commentedHere's a stab at the HTML version
Comment #21
eojthebraveI think it would be good to add a note about helping out with the Drupal 8 User Guide, at least during BCN this could be a great way for someone to get involved. https://www.drupal.org/project/user_guide
Maybe either as a new sprint task, or, as an additional item listed along with the d8docs tag and the documentation issue queue.
Comment #22
YesCT CreditAttribution: YesCT commentedWe need to finalize this. running out of time for BCN.
Comment #23
eojthebraveHere's a version of this with a task added for helping out with the Drupal 8 User Manual.
<li>Work on writing, editing, or reviewing the Drupal 8 User Manual. https://www.drupal.org/project/user_guide</li>
As far as I'm concerned this is good to go now.
Comment #24
kattekrab CreditAttribution: kattekrab at Creative Contingencies commentedI used @eojthebrave's version to have a crack at the layout in inkscape (and included that dot point in the issue summary)
We can't add SVGs here, so I've added .txt extension to the SVG file. Just remove that to get the editable version. PDF and PNG for proofing also attached.
Not sure what the original font was for the others though, but that's an easy fix.
Comment #25
kattekrab CreditAttribution: kattekrab at Creative Contingencies commentedOh - we probably need a follow up - to update the progression diagram on the other cards to include the documentor option.
Comment #26
kattekrab CreditAttribution: kattekrab at Creative Contingencies commentedI'm thinking I need to redo the progress diagram.
The Documentor follows community contributor - not issue mover.
Putting back to needs work
Comment #27
kattekrab CreditAttribution: kattekrab at Creative Contingencies commentedRevised process diagram - does that work?
Comment #28
kattekrab CreditAttribution: kattekrab at Creative Contingencies commentedComment #29
eojthebraveWorks fine for me. The items appear in the right order/progression and it's easy enough to read. Thanks! Should we open a follow up issue for updating the rest of the cards and then call this one good to go?
Comment #30
penyaskitoTranslated to Spanish in the IS.
Comment #31
heddnre #27: The letters on DC & DV don't make sense to me any more in the little process diagram.
The titles of the actors in Spanish I feel should also be translated. Right now they are still in English, even though the rest is translated. And mentions of IRC could (should?) mention #drupal-es, not just #drupal.
Comment #32
YesCT CreditAttribution: YesCT commentedthis looks fine to me.
some of the items on the card would be useful to have links.... are those in a contributor task document? https://www.drupal.org/contributor-tasks
we have
"Add keywords to a Community Documentation page" https://www.drupal.org/contributor-tasks/add-keywords
I know where to find the manual g.d.o announcement... but can we get each of the items documented here with links (at least for a start)
Comment #33
YesCT CreditAttribution: YesCT commented@heddn we decided not to translate the titles, since in english, they are gender neutral and in other languages, when we make them gender binary they get long by listing both a male and female version. And when we leave the titles in english, the same first letter can be used in the diagram. See discussion in #2269681-64: (BCN, Due: 2015-08-20) Contributor role cards and stickers for booth
I should read the issue summary. the links are in there. :)
Comment #34
David Hernández CreditAttribution: David Hernández as a volunteer commentedI reviewed the spanish translation and seems good to me, but I sugest a change to make it gender neutral:
"Eres Community Contributor con nociones de escribir en inglés, y estás preparado o preparada para compartir tus conocimientos sobre Drupal 8 con otros."
Could be:
"Eres Community Contributor con nociones de escribir en inglés, y tienes la preparación para compartir tus conocimientos sobre Drupal 8 con otros."
Comment #35
penyaskitoAgree with David suggestion. We should reach consensus if there isn't yet about doing this card or not, and dump this into https://github.com/drupal-mentoring/drupal-contributor-roles. Handling this through issue queue will be tough.
Comment #36
David Hernández CreditAttribution: David Hernández as a volunteer commentedPull Request created: https://github.com/drupal-mentoring/drupal-contributor-roles/pull/9
Comment #37
kattekrab CreditAttribution: kattekrab at Creative Contingencies commentedCool! Let's do it :)
Comment #38
penyaskitoPR is merged. What else do we need for marking this one as Fixed?
Comment #39
David Hernández CreditAttribution: David Hernández as a volunteer commentedFrom https://www.drupal.org/node/2269681#comment-10189842
Should be documentor or documenter? https://en.wiktionary.org/wiki/documenter
Comment #40
David Hernández CreditAttribution: David Hernández as a volunteer commentedI added a new PR to fix the issues reported on #2269681: (BCN, Due: 2015-08-20) Contributor role cards and stickers for booth.
https://github.com/drupal-mentoring/drupal-contributor-roles/pull/12
Comment #41
tatarbjI'm closing this issue as as part of issue queue clean-up meta: #2960983: [meta] Plan for Mentoring Project/Issue Queue. This does not mean topics in this issue is or was not important or completed.
Issue was used for DrupalCon Barcelona and as is can be considered outdated.