resolve logging auto-generated docs issues #11018
Conversation
|
This change is |
|
Files changed: _includes/sidebar-data-v21.1.json |
|
@thtruo This is just some housekeeping for the logging docs, removing some workarounds that were necessary in order to make the generated docs work on the site. Should also prepare us for upcoming logging updates. |
|
✔️ Netlify Preview 🔨 Explore the source changes: d868316 🔍 Inspect the deploy log: https://app.netlify.com/sites/cockroachdb-docs/deploys/610c50f6a8df120008c8b798 😎 Browse the preview: https://deploy-preview-11018--cockroachdb-docs.netlify.app |
There was a problem hiding this comment.
Cleanup looks good @taroface ! I also appreciate seeing some language change from passive sentences to active ones!
Reviewed 5 of 5 files at r1, all commit messages.
Reviewable status:complete! 0 of 0 LGTMs obtained (waiting on @taroface)
68506: util/log,docs/generated: update crdb-v2 example formatting r=taroface a=taroface The `crdb-v2` log examples in the autogen docs were not appearing correctly when embedded on the [public docs page](https://www.cockroachlabs.com/docs/v21.1/log-formats.html#examples). As a workaround, that doc is currently using a manually altered copy of the `logformats.md` doc. This change should fix the formatting issues and enable us to embed the generated doc (see: cockroachdb/docs#11018). Release note: none 68540: backupccl: add option to display descriptor ids to SHOW BACKUP r=rhu713 a=rhu713 Previously there weren't any descriptor ID information displayed by SHOW BACKUP. These IDs provide useful information during triage and general debugging. To address this, a WITH option debug_ids was added to populate additional columns in SHOW BACKUP with descriptor IDS of all objects along with the IDs of its database and parent schema. Release note (enterprise change): Descriptor IDs of every object are now visible in SHOW BACKUP, along with the descriptor IDs of the object's database and parent schema. SHOW BACKUP will display these IDs if the `WITH debug_ids` option is specified. Co-authored-by: taroface <[email protected]> Co-authored-by: Rui Hu <[email protected]>
Fixes #10551.
remote_includeonlog-formats.md, pending the fix in util/log,docs/generated: update crdb-v2 example formatting cockroach#68506log-sinks.mdbecause I realized the content in the generated doc is largely redundant withconfigure-logs.md. I folded some additional information from the generated doc intoconfigure-logs.md.configure-logs.mdfor feature clarity.