Fix code formatting for data capture getting started #2726
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 <[email protected]>
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 <[email protected]>
jingtang10
reviewed
Nov 27, 2024
jingtang10
approved these changes
Nov 27, 2024
|
@jingtang10 Thanks for your reviewing. Looks like it requires your approval to make CI passed. |
|
Hi @jingtang10 Could you help to approve and merge it? Thanks. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.bashon Ubuntu 22.04 that I facedby updating setuptools before building mkdocs.
Alternative(s) considered
Not.
Type
Documentation
Screenshots (if applicable)
Checklist
./gradlew spotlessApplyand./gradlew spotlessCheckto check my code follows the style guide of this project../gradlew checkand./gradlew connectedCheckto test my changes locally.