Modifies both antora playbooks to output logs to logs/docs-logs.adoc and logs/widget-logs.adoc respectively. This is built in functionality with antora. Note: this disables logs from being printed in terminal.
Adds a script that looks at the log files and beautifies them so they are more human-readable. The logs are in .adoc formatting so maintainers can preview the file in asciidoc and simply click an xref to go straight to the file.
A new yarn script has been added: yarn local. This will be the default method for maintainers to build the docs locally as it includes yarn build + beautify-logs.py. Moving forward yarn build will only be used for the server or if a maintainer specifically wants to view non-beautified logs.
Note: This script has not been added to any build scripts/workflows. For now, this is meant purely as a local debugging tool for maintainers.
Summary
Script to beautify logs. This PR does 2 things:
logs/docs-logs.adoc
andlogs/widget-logs.adoc
respectively. This is built in functionality with antora. Note: this disables logs from being printed in terminal..adoc
formatting so maintainers can preview the file in asciidoc and simply click an xref to go straight to the file.yarn local
. This will be the default method for maintainers to build the docs locally as it includesyarn build
+beautify-logs.py
. Moving forwardyarn build
will only be used for the server or if a maintainer specifically wants to view non-beautified logs.Note: This script has not been added to any
build
scripts/workflows. For now, this is meant purely as a local debugging tool for maintainers.Related PRs, issues, or features (optional)
Metadata
PR contributor checklist
[x] My PR follows the Kobiton Docs contributor guidelines, meaning:
nav.adoc
file.en-us
) from my URLs.