Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

AAP-36632-update: TOC restructure of Ansible Lightspeed User Guide #2790

Merged
merged 10 commits into from
Feb 8, 2025

Conversation

sayjadha
Copy link
Contributor

@sayjadha sayjadha commented Jan 20, 2025

This PR addresses JIRA https://issues.redhat.com/browse/AAP-36632.

Changes made:

@sayjadha sayjadha added Ready for review This PR needs review and approval by members of the docs team Lightspeed Content applies to Ansible Lightspeed labels Feb 5, 2025
You cannot disable collection of operational telemetry data. Operational telemetry data includes only data that is necessary to operate and troubleshoot the service. However, you can disable the collection of Admin Dashboard telemetry data. For more information, see xref:disable-admin-dashboard-telemetry_administering-ansible-lightspeed[Disabling the Admin dashboard telemetry].
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just an ignorable suggestion: - not very important.
The nesting level of these sections is quite deep - 1.4.4.2.5. Maybe consider non-indexed headings for these short sections, or putting them in a Definition list.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I edited the section titles to discrete headings (reference: https://docs.asciidoctor.org/asciidoc/latest/blocks/discrete-headings/). It looks okay in asciidoctor output but a tad bit smaller in ccutil output. If this edit is okay with you, let's see how it renders in the output and then update if required?

lightspeed/modules/proc_install-content-parser.adoc Outdated Show resolved Hide resolved
lightspeed/modules/proc_start-lightspeed-trial.adoc Outdated Show resolved Hide resolved
@jself-sudoku jself-sudoku merged commit 779b771 into ansible:lightspeed-latest Feb 8, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Lightspeed Content applies to Ansible Lightspeed Ready for review This PR needs review and approval by members of the docs team
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants