docs: document session log contents#1222
Open
Gero1999 wants to merge 4 commits into1210-enhancement/replace-logger-with-consolefrom
Open
docs: document session log contents#1222Gero1999 wants to merge 4 commits into1210-enhancement/replace-logger-with-consolefrom
Gero1999 wants to merge 4 commits into1210-enhancement/replace-logger-with-consolefrom
Conversation
Include explanation of what the log captures, current threshold, visible levels, and a link to the full reference page. Closes #1220 (partial) Co-authored-by: Ona <no-reply@ona.com>
Developer website page documenting all logged events by workflow stage, log levels, and configuration via aNCA_LOG_LEVEL. Closes #1220 (partial) Co-authored-by: Ona <no-reply@ona.com>
Add 'Session Log Reference' entry under Developer Resources in the website navigation. Closes #1220 (partial) Co-authored-by: Ona <no-reply@ona.com>
Clarify what the log captures vs. what it does not, and link to the full session log reference page. Closes #1220 (partial) Co-authored-by: Ona <no-reply@ona.com>
Gero1999
force-pushed
the
1220-enhancement/document-session-logs
branch
from
d10e924 to
f62eaf2
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Issue
Closes #1220 but merges in #1212
Description
Adds documentation for the session log so users and developers understand what
session_log.txtcontains.Changes:
.export_session_log()now prepends a comment block tosession_log.txtexplaining what the log captures, what it doesn't, the current threshold, visible levels, and a link to the reference page.vignettes/session_log.Rmdwith a full reference of all logged events organized by workflow stage, log level explanations, andaNCA_LOG_LEVELconfiguration.logging.Rheader — Added scope clarification and reference link to the source file.Definition of Done
session_log.txtstarts with a header explaining its contentsHow to test
aNCA::run_app(), upload data, run NCAsession_log.txt— verify the header block is presentpkgdown::build_site()) and verify the Session Log Reference page appears under Developer ResourcesContributor checklist
.scsschange was done, rundata-raw/compile_css.RNotes to reviewer
This PR targets
1210-enhancement/replace-logger-with-console(#1212), notmain. It will auto-retarget tomainonce #1212 is merged.The vignette references events from both the existing log-points and those added in #1221. If #1221 is not merged first, the NCA Settings / Exclusions rows in the table describe log-points that don't exist yet — but the table is still accurate as a target reference.
Version bump and NEWS entry still needed before merge.