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

Fix code formatting for data capture getting started #2726

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

utzcoz
Copy link
Contributor

@utzcoz utzcoz commented Nov 17, 2024

IMPORTANT: All PRs must be linked to an issue (except for extremely trivial and straightforward changes).

Straightforward changes for documentation format, so it doesn't attach any issue.

Description

Mkdocs doesn't support fenced code block in number list,
so this CL changes number list to unordered lists and
removes indent for fenced code block to make it work.

This Cl also fixes running error of build-docs.bash on Ubuntu 22.04 that I faced
by updating setuptools before building mkdocs.

Alternative(s) considered
Not.

Type
Documentation

Screenshots (if applicable)

Checklist

  • I have read and acknowledged the Code of conduct.
  • I have read the Contributing page.
  • I have signed the Google Individual CLA, or I am covered by my company's Corporate CLA.
  • I have discussed my proposed solution with code owners in the linked issue(s) and we have agreed upon the general approach.
  • I have run ./gradlew spotlessApply and ./gradlew spotlessCheck to check my code follows the style guide of this project.
  • I have run ./gradlew check and ./gradlew connectedCheck to test my changes locally.
  • I have built and run the demo app(s) to verify my change fixes the issue and/or does not break the demo app(s).

The default setuptools installed by pipenv has compatibility
issue foir some Ubuntu 24.04, and this CL adds a new
command to update setuptools to latest version to ensure
mkdocs and its dependency installation work without errors.

Signed-off-by: utzcoz <utzcoz@outlook.com>
Mkdocs doesn't support fenced code block in number list,
so this CL changes number list to unordered lists and
removes indent for fenced code block to make it work.

Signed-off-by: utzcoz <utzcoz@outlook.com>
@utzcoz utzcoz requested a review from a team as a code owner November 17, 2024 05:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: New
Development

Successfully merging this pull request may close these issues.

1 participant