Improve documentation on how to instrument logging in a component
Maintainers usually reply within 2 days
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 35/100
- Issue type
- Documentation
- Clarity
- Needs clarification
- Activity status
- Stale
- Domain
- documentation
Research direction
Start by locating the existing logging documentation and the component instrumentation guidance in the repository. Confirm how the existing feature is used, then document the workflow and verify that the new guidance clearly explains how to instrument logging in a component.
Written by the indexing model from the issue text.
Description
Request Type
Undocumented existing feature
What needs to be documented?
As titled; logging docs in general could use more docs, but this is directly valuable to customers.
Where should this be documented?
No response
Why is this needed?
No response
Existing information
No response
Priority/Impact
Medium - important but not urgent
Are you planning to fix this issue?
No, just reporting the issue
First-time contributor support
- I'm new to contributing and would appreciate guidance on the process
- I'd like help understanding the project structure
- I need assistance with setting up the development environment
- I'm comfortable contributing but new to this project specifically
- Dominant language
- MDX
- Stars
- 9
- Forks
- 9
- Avg merge
- 1d 20h
- Merged PRs (30d)
- 16
Getting set up
- No Dockerfile or Docker Compose file
- No pull request template
- Read the contributing 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.
More from HarperFast/documentation
-
Difficulty 1/5 Under an hour Newbie friendliness 90/100
HarperFast/documentation#690 ·
Maintainers usually reply within 2 days
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
HarperFast/documentation#677 ·
Maintainers usually reply within 2 days
-
Difficulty 2/5 Half a day Newbie friendliness 88/100
HarperFast/documentation#675 ·
Maintainers usually reply within 2 days
-
Difficulty 1/5 Under an hour Newbie friendliness 92/100
HarperFast/documentation#665 ·
Maintainers usually reply within 2 days
-
content
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
HarperFast/documentation#478 ·
Maintainers usually reply within 2 days
All issues in HarperFast/documentation
Similar issues
-
Link Checker ReportOpenautomated issue report
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
documentation
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
PedestrianDynamics/pyFDS-Evac#475 ·
Maintainers usually reply within 1 day
-
Difficulty 1/5 Under an hour Newbie friendliness 85/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
ethereum/execution-apis#915 ·
Maintainers usually reply within 1 day
-
area:ansible source:reader type:content-error
Difficulty 1/5 Under an hour Newbie friendliness 86/100
stephrobert/blog-roadmap#42 ·