spockframework / spockframework/spock
Split Documentation into the four types tutorials, how-to guides, technical reference and explanation
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 3.6k
- Forks
- 483
- PR merge metrics
- No merged PRs in 30d
Description
The current documentation of Spock is a mix of those for types. It would increase the usefulness to our users and potential users to untangle the documentation.
Source https://documentation.divio.com/
I can highly recommend the video that explains this.
This issue is a place to discuss this proposal and its implementation.
Open issues:
- Define a structure
- Define a place (i.e. will everything live in this repository, or will we have separate repositories for certain parts, e.g. tutorials)
- Find contributors willing to work on How-Tos and Tutorials with support from us.
Any comments @spockframework/supporter ?
Contributor 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.
Research direction
No files, tests, or entry points are named. Start by reviewing the Divio documentation model linked in the issue and the three listed open questions. Done requires an agreed structure, a decision about where each documentation type will live, and a plan for finding contributors for tutorials and how-to guides.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100