kobiton / docs

The content for Kobiton Docs.
https://docs.kobiton.com
3 stars 1 forks source link

Bug: fix beautify script #130

Closed internetisaiah closed 1 year ago

internetisaiah commented 1 year ago

Summary

The beautify-logs.py script was slicing Antora's "pretty" logs with the assumption it knew where the maintainer was storing the git repository, so the links in the File column were breaking for some users.

The following changes have been made:

  1. Antora playbooks now output logs in JSON format. This makes string slicing easier/more accurate.
  2. The beautify script now creates the links in the File column by removing the text in "workspace": from "file":, then adds AsciiDoc xref syntax.

For example:

Related PRs, issues, or features (optional)

Metadata

PR contributor checklist