syslog-ng / syslog-ng/syslog-ng.github.io
Provide static, versioned documentation every time a new application release is created.
Open
Nobody has claimed this yet.
documentation
enhancement
- Dominant language
- JavaScript
- Stars
- 6
- Forks
- 15
- Avg merge
- 4h 32m
- Merged PRs (30d)
- 5
Description
As the develop and release versions are now two distinct states, we also need to provide a static, versioned copy of the documentation for each release.
e.g. to eliminate issues like https://github.com/syslog-ng/syslog-ng.github.io/pull/212
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
The issue names no files or tests; begin by reviewing the repository's documentation build and release workflow, then inspect linked PR #212 for the versioning problem. Done means each new application release produces a static, versioned documentation copy without the develop/release mix-up.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation, release
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100