riak-core-lite/riak_core_lite_basho

EEP48 Documentation

Open

#51 opened on May 29, 2020

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Erlang (14 forks)github user discovery
Communitydiscussiondocumentationenhancementfeaturehelp wanted

Repository metrics

Stars
 (85 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

Check if it makes sense to adopt EEP48 for riak core lite documentation.

Contributor guide

Research direction
Read EEP48 and evaluate whether the documentation structure of riak core lite basho would benefit from adopting it. Compare the current documentation files with the standard suggested by EEP48, and propose a plan if it makes sense.
Tech stack
None
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75