Documentation for multi-line log formatting
Open
Nobody has claimed this yet.
operator
- Dominant language
- Python
- Stars
- 4
- Forks
- 71
- Avg merge
- 2d 1h
- Merged PRs (30d)
- 11
Description
Re this conversation in MM: https://mattermost.web.cern.ch/rucio/pl/wqe5jsas6fn4m8tjk54te4qrwh
Log formatting is a bit of a sore point - in the operator documentation there should be some description of how to output multiple line tracebacks as a single line.
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
Start with the operator documentation and review the linked Mattermost conversation for the expected log-formatting behavior. Update the documentation to explain how to output multi-line tracebacks as a single line; done when operators can follow the guidance without needing additional context.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100