How tos : confirm location of how to type documentation.
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 25/100
- Issue type
- Documentation
- Clarity
- Needs clarification
- Activity status
- Stale
- Domain
- documentation
Research direction
Start by reviewing the current navigation and section structure on docs.localgovdrupal.org, then consider where developer-facing how-to content about enabling and configuring content lock would fit. The issue is complete when the documentation location and audience structure are agreed and recorded.
Written by the indexing model from the issue text.
Description
Discussing how-to documentation in the product backlog group with @willguv and @stephen-cox.
The case in point is adding https://www.drupal.org/project/content_lock
Once we add it, it will probabyl not be enabled by default on a stock install.
So we would like to be able to direct people at a clear "how to enable and configure content lock".
I guess this best lives on the https://docs.localgovdrupal.org/ site, but where?
Some of this how-to documentation could be for multiple audiences, but probably mainly developers.
- A new top-level section for "How tos" ?
- A new section under developers for "How tos" ?
- a seperate section for "How-tos" which is not necessarily linked to from the top level primary links?
@msayoung do you have thoughts on this?
- Dominant language
- No language data
- Stars
- 7
- Forks
- 22
- PR merge metrics
- No merged PRs in 30d
Getting set up
- No Dockerfile or Docker Compose file
- No pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from localgovdrupal/docs
-
Difficulty 2/5 1-3 hours Newbie friendliness 55/100
localgovdrupal/docs#348 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 25/100
localgovdrupal/docs#341 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 55/100
localgovdrupal/docs#340 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 35/100
localgovdrupal/docs#332 ·
-
Difficulty 4/5 3-5 days Newbie friendliness 25/100
localgovdrupal/docs#333 ·
All issues in localgovdrupal/docs
Similar issues
-
Scrub the retired Kaizen target out of the deploy runbookPossibly taken @mcannonbrookes claimed this today. Opendocumentation
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
atlassian-labs/roving-office#25 ·
Maintainers usually reply within 1 day
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
Maintainers usually reply within 1 day
-
P4: low tooling
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
jeffknupp/association#318 ·
-
documentation good first issue hacktoberfest size/small type/docs up-for-grabs
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
Redo-San/RedoSan-Authenticity#511 ·
Maintainers usually reply within 1 day
-
Difficulty 1/5 Under an hour Newbie friendliness 88/100