syslog-ng / syslog-ng/syslog-ng.github.io
Cleanup of the obsolete/deprecated references
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 6
- Forks
- 15
- Avg merge
- 4h 32m
- Merged PRs (30d)
- 5
Description
We still have references to obsolete/deprecated options/features in a bunch of different styles.
Use a single consistent sentence that refers to the outdated state and the value of the outdated item.
A good candidate for the options can be
{% include doc/admin-guide/options/deprecated-options.md old='fetch-delay' new='log-fetch-delay' %}
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 by reviewing the existing include at doc/admin-guide/options/deprecated-options.md and searching the documentation for obsolete or deprecated option and feature references in different styles. Update the identified references to use one consistent sentence containing the outdated state and value, with the fetch-delay/log-fetch-delay example as a candidate; done means the relevant references are consistent.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100