orientechnologies / orientechnologies/orientdb-docs
Improve documentation about all configuration parameters
Nobody has claimed this yet.
- Dominant language
- CSS
- Stars
- 59
- Forks
- 165
- PR merge metrics
- No merged PRs in 30d
Description
http://orientdb.com/docs/master/Configuration.html#parameters
May take some time, but as a possible mid-term objective:
For any parameter, it is important to have a set of properties, e.g.:
- when it was added
- default value
- if can be set at runtime
- when it was deprecated
Ideally there is a table from where all these info can be quickly read, and where each parameter is clickable (--> paragraph which includes the full description of the parameter)
Thanks,
Contributor guide
No contributing guide indexed for this repository
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
Start with the Configuration.html#parameters page linked in the issue and inventory how its parameter descriptions are organized. Document each parameter's added date, default value, runtime configurability, and deprecation status, with a table linking to full descriptions; done means the configuration parameters are consistently covered.
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
- Mostly clear
- Newbie friendliness
- 35/100