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.

Sign up for GitHub

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

Jump to bottom

feat: add greptimedb operator api docs #174

Merged
merged 1 commit into from
Sep 4, 2024
Merged

feat: add greptimedb operator api docs #174

merged 1 commit into from
Sep 4, 2024

Conversation

daviderli614
Copy link
Member

@daviderli614 daviderli614 commented Sep 2, 2024 •
edited
Loading

Released issue: #3

We can running 'make docs' to generate api docs.

Preview: https://github.com/GreptimeTeam/greptimedb-operator/blob/8b5b0b2f1f9d2161afdad3dea0b14314aefd1072/docs/api-references/docs.md

Summary by CodeRabbit

  • New Features

    • Introduced a documentation validation step in the CI/CD pipeline to ensure documentation accuracy.
    • Added new templates for generating structured API reference documentation, enhancing usability and clarity.
    • Created comprehensive API reference documentation for the GreptimeDB Operator, detailing resource types and specifications.

  • Improvements

    • Enhanced the documentation generation process with customizable options for ignoring specific fields and types.
    • Improved the structure of documentation templates for better organization and readability.

@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Sep 2, 2024 •
edited
Loading

Walkthrough

The changes introduce enhancements to the CI/CD pipeline by adding documentation checks in the GitHub Actions workflow and the Makefile. New templates and configuration files for API reference documentation are also introduced, allowing for better organization and customization of the documentation process. These updates aim to improve the overall documentation quality and streamline the generation of API references.

Changes

File Path Change Summary
.github/workflows/develop.yaml Added a new job step "Check docs" to execute make check-docs in the CI/CD workflow.
Makefile Introduced check-docs and crd-ref-docs targets; added variables for CRD_REF_DOCS and CRD_REF_DOCS_VERSION. Modified docs target to depend on crd-ref-docs.
docs/api-references/config.yaml Defined processing rules for API references, including sections for ignoring group versions, types, fields, and custom markers.
docs/api-references/docs.md Created API reference documentation for GreptimeDB Operator, detailing resource types and specifications.
docs/api-references/template/gv_details.tpl Added a template for rendering group version details.
docs/api-references/template/gv_list.tpl Added a template for rendering a list of API references.
docs/api-references/template/type.tpl Introduced a template for rendering type documentation, including members and validation rules.
docs/api-references/template/type_members.tpl Defined a template for rendering type member documentation with specific field handling.

Sequence Diagram(s)

sequenceDiagram
    participant Developer
    participant GitHub Actions
    participant Makefile
    participant Documentation

    Developer->>GitHub Actions: Push changes
    GitHub Actions->>Makefile: Execute `make check-docs`
    Makefile->>Documentation: Check for documentation updates
    Documentation-->>Makefile: Prompt to run `make docs` if updates exist
    Makefile->>Documentation: Generate API reference documentation
    Documentation-->>GitHub Actions: Documentation updated
    GitHub Actions-->>Developer: CI/CD process completed
Loading

Poem

🐰 In the meadow where bunnies hop,
New docs and checks make our hearts stop!
With templates and rules, we dance with glee,
A clearer path for all to see.
Hooray for changes, let’s give a cheer,
For better docs, we hold so dear! 🌼

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.
Early access features: disabled

We are currently testing the following features in early access:

  • Anthropic claude-3-5-sonnet for code reviews: Anthropic claims that the new Claude model has stronger code understanding and code generation capabilities than their previous models. Note: Our default code review model was also updated late last week. Please compare the quality of the reviews between the two models by toggling the early access feature.

Note:

  • You can enable or disable early access features from the CodeRabbit UI or by updating the CodeRabbit configuration file.
  • Please join our Discord Community to provide feedback and report issues on the discussion post.

@daviderli614 daviderli614 requested a review from zyy17 September 2, 2024 04:05
coderabbitai[bot]
coderabbitai bot reviewed Sep 2, 2024
View reviewed changes
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 951b022 and 8b5b0b2.

Files selected for processing (8)
  • .github/workflows/develop.yaml (1 hunks)
  • Makefile (3 hunks)
  • docs/api-references/config.yaml (1 hunks)
  • docs/api-references/docs.md (1 hunks)
  • docs/api-references/template/gv_details.tpl (1 hunks)
  • docs/api-references/template/gv_list.tpl (1 hunks)
  • docs/api-references/template/type.tpl (1 hunks)
  • docs/api-references/template/type_members.tpl (1 hunks)
Files skipped from review due to trivial changes (2)
  • docs/api-references/template/gv_list.tpl
  • docs/api-references/template/type_members.tpl
Additional context used
LanguageTool
docs/api-references/docs.md

[uncategorized] ~231-~231: Possible missing comma found.
Context: ...| | | #### GreptimeDBClusterList GreptimeDBClusterList contains a list of GreptimeDBCluster ...

(AI_HYDRA_LEO_MISSING_COMMA)

[grammar] ~494-~494: There seems to be a noun/verb agreement error. Did you mean “defines” or “defined”?
Context: ...ase Underlying type: string Phase define the phase of the cluster or standalone....

(SINGULAR_NOUN_VERB_AGREEMENT)

[grammar] ~504-~504: Did you mean “are”?
Context: ...ing means all the components of cluster is ready.
| | Updating | PhaseUpda...

(SUBJECTVERBAGREEMENT_2)

[grammar] ~514-~514: Possible agreement error. The noun ‘cluster’ seems to be countable; consider using: “pod of clusters”.
Context: ...TemplateSpec defines the template for a pod of cluster. Appears in: - [ComponentSpec](#co...

(A_COLLECTIVE_OF_NN)

[style] ~533-~533: ‘prior to’ might be wordy. Consider a shorter alternative.
Context: .../>Init containers are executed in order prior to containers being started. If any
i...

(EN_WORDINESS_PREMIUM_PRIOR_TO)

[style] ~533-~533: ‘taken into account’ might be wordy. Consider a shorter alternative.
Context: ...ceRequirements of an init container are taken into account during scheduling
by finding the h...

(EN_WORDINESS_PREMIUM_TAKEN_INTO_ACCOUNT)

[style] ~533-~533: Consider replacing this phrase with the adverb “similarly” to avoid wordiness.
Context: ...its are applied to init containers
in a similar fashion.
Init containers cannot currently ...

(IN_A_X_MANNER)

[style] ~639-~639: ‘prior to’ might be wordy. Consider a shorter alternative.
Context: .../>Init containers are executed in order prior to containers being started. If any
i...

(EN_WORDINESS_PREMIUM_PRIOR_TO)

[style] ~639-~639: ‘taken into account’ might be wordy. Consider a shorter alternative.
Context: ...ceRequirements of an init container are taken into account during scheduling
by finding the h...

(EN_WORDINESS_PREMIUM_TAKEN_INTO_ACCOUNT)

[style] ~639-~639: Consider replacing this phrase with the adverb “similarly” to avoid wordiness.
Context: ...its are applied to init containers
in a similar fashion.
Init containers cannot currently ...

(IN_A_X_MANNER)

[uncategorized] ~707-~707: The preposition ‘as’ seems more likely in this position.
Context: ...e, and it must be in the same namespace of the cluster.
The secret must conta...

(AI_HYDRA_LEO_REPLACE_OF_AS)

Markdownlint
docs/api-references/docs.md

396-396: null
Bare URL used

(MD034, no-bare-urls)

397-397: null
Bare URL used

(MD034, no-bare-urls)

400-400: null
Bare URL used

(MD034, no-bare-urls)

401-401: null
Bare URL used

(MD034, no-bare-urls)

403-403: null
Bare URL used

(MD034, no-bare-urls)

532-532: null
Bare URL used

(MD034, no-bare-urls)

533-533: null
Bare URL used

(MD034, no-bare-urls)

534-534: null
Bare URL used

(MD034, no-bare-urls)

538-538: null
Bare URL used

(MD034, no-bare-urls)

540-540: null
Bare URL used

(MD034, no-bare-urls)

638-638: null
Bare URL used

(MD034, no-bare-urls)

639-639: null
Bare URL used

(MD034, no-bare-urls)

640-640: null
Bare URL used

(MD034, no-bare-urls)

644-644: null
Bare URL used

(MD034, no-bare-urls)

646-646: null
Bare URL used

(MD034, no-bare-urls)

50-50: null
Link fragments should be valid

(MD051, link-fragments)

51-51: null
Link fragments should be valid

(MD051, link-fragments)

108-108: null
Link fragments should be valid

(MD051, link-fragments)

144-144: null
Link fragments should be valid

(MD051, link-fragments)

181-181: null
Link fragments should be valid

(MD051, link-fragments)

440-440: null
Link fragments should be valid

(MD051, link-fragments)

499-499: null
Link fragments should be valid

(MD051, link-fragments)

500-500: null
Link fragments should be valid

(MD051, link-fragments)

36-36: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

37-37: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

38-38: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

55-55: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

56-56: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

57-57: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

58-58: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

59-59: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

91-91: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

92-92: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

93-93: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

94-94: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

95-95: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

96-96: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

112-112: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

113-113: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

129-129: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

130-130: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

131-131: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

132-132: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

148-148: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

149-149: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

165-165: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

166-166: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

167-167: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

168-168: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

169-169: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

185-185: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

186-186: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

202-202: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

203-203: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

204-204: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

205-205: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

206-206: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

222-222: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

223-223: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

224-224: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

225-225: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

240-240: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

241-241: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

242-242: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

243-243: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

259-259: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

260-260: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

261-261: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

262-262: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

263-263: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

264-264: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

265-265: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

266-266: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

267-267: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

268-268: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

269-269: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

270-270: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

271-271: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

272-272: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

273-273: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

291-291: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

292-292: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

293-293: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

294-294: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

309-309: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

310-310: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

311-311: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

312-312: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

328-328: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

329-329: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

330-330: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

331-331: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

332-332: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

333-333: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

334-334: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

335-335: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

336-336: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

337-337: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

338-338: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

339-339: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

340-340: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

341-341: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

342-342: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

361-361: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

377-377: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

394-394: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

395-395: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

396-396: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

397-397: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

398-398: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

399-399: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

400-400: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

401-401: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

402-402: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

403-403: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

404-404: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

420-420: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

421-421: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

422-422: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

423-423: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

424-424: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

425-425: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

426-426: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

427-427: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

428-428: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

444-444: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

445-445: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

446-446: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

462-462: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

463-463: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

464-464: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

465-465: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

466-466: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

483-483: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

484-484: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

485-485: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

486-486: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

487-487: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

529-529: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

530-530: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

531-531: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

532-532: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

533-533: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

534-534: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

535-535: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

536-536: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

537-537: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

538-538: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

539-539: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

540-540: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

541-541: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

542-542: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

543-543: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

544-544: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

545-545: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

562-562: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

563-563: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

564-564: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

581-581: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

597-597: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

598-598: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

599-599: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

600-600: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

601-601: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

618-618: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

619-619: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

620-620: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

621-621: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

638-638: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

639-639: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

640-640: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

641-641: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

642-642: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

643-643: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

644-644: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

645-645: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

646-646: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

647-647: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

648-648: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

649-649: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

650-650: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

651-651: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

684-684: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

685-685: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

686-686: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

687-687: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

688-688: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

689-689: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

690-690: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

707-707: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

Additional comments not posted (29)
docs/api-references/config.yaml (1)

1-11: LGTM!

The YAML configuration for the documentation processor looks good:

  • It follows the expected structure for specifying ignored groups, types, and fields.
  • The ignored entities seem reasonable for a typical API reference documentation.
  • The custom marker to hide specific fields from the documentation is a useful feature.
docs/api-references/template/gv_details.tpl (5)

1-2: LGTM!

The code segment correctly defines a new template named "gvDetails" and assigns the template parameter to the variable $gv.

4-6: LGTM!

The code segment correctly renders the group version string and documentation for the API group using the $gv variable.

8-13: LGTM!

The code segment correctly renders the "Resource Types" section if the API group has any resource types. It iterates over the sorted resource types and renders them as a list using the markdownRenderTypeLink function.

15-17: LGTM!

The code segment correctly iterates over the sorted types in the API group and renders each type using the "type" template.

19-19: LGTM!

The code segment correctly ends the "gvDetails" template definition.

docs/api-references/template/type.tpl (1)

1-49: LGTM!

The template file type.tpl follows a well-structured approach to generate comprehensive documentation for a type. It covers important aspects such as the type name, documentation, validation rules, references, and members. The use of conditionals and loops allows for dynamic generation of content based on the properties of the type.

The template also handles rendering of enum values, providing additional information for types with predefined values. The use of helper functions promotes code reusability and maintains consistent formatting of the generated Markdown.

Overall, the template file is well-designed and should effectively generate API reference documentation for types.

.github/workflows/develop.yaml (1)

57-59: LGTM!

The new job step "Check docs" is a great addition to the CI/CD pipeline. It ensures that documentation is validated as part of the development process, which can help maintain the quality and accuracy of project documentation.

Please verify that the make check-docs command is defined in the Makefile and works as expected. You can use the following script to search for the command definition:

Verification successful

Verification Successful: make check-docs Command Defined

The make check-docs command is defined in the Makefile, confirming that the new job step in the GitHub Actions workflow is correctly set up to validate documentation. This ensures that the documentation is checked as part of the development process.

  • Location: Makefile: check-docs: docs ## Check docs
Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify that the `make check-docs` command is defined in the `Makefile`.

# Test: Search for the command definition. Expect: The command definition is found.
rg --type makefile $'check-docs:'

Length of output: 65

Script:

#!/bin/bash
# Description: Verify that the `make check-docs` command is defined in the `Makefile`.

# Test: Search for the command definition. Expect: The command definition is found.
rg --type make $'check-docs:'

Length of output: 68

Makefile (4)

115-119: LGTM!

The new check-docs target is a useful addition. It ensures that the documentation is always up to date by checking for changes in the git repository and prompting the user to run make docs if changes are detected.

194-199: LGTM!

The new variables CRD_REF_DOCS and CRD_REF_DOCS_VERSION are introduced correctly. They specify the installation path and version for the crd-ref-docs tool, which is likely used for generating API reference documentation.

221-223: LGTM!

The new crd-ref-docs target is introduced correctly. It installs the crd-ref-docs tool using the go install command and the version specified by the CRD_REF_DOCS_VERSION variable. This tool is likely used for generating API reference documentation.

225-227: LGTM!

The modifications to the docs target are implemented correctly. It now depends on the crd-ref-docs target to ensure that the tool is installed before generating the API reference documentation. The crd-ref-docs tool is invoked with the necessary arguments to specify the source path, output path, templates directory, and configuration file for the documentation generation process.

docs/api-references/docs.md (17)

1-1: LGTM!

The title accurately describes the content of the document.

3-4: LGTM!

The package name is correct.

10-14: LGTM!

The resource types are clearly defined and follow a consistent naming convention.

20-39: LGTM!

The ComponentSpec type is well-defined with clear field descriptions. The "Appears in" section correctly lists the places where this type is used.

Tools
Markdownlint

36-36: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

37-37: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

38-38: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

41-60: LGTM!

The Condition type captures the essential information about a condition. The "Appears in" section correctly lists the places where this type is used.

Tools
Markdownlint

50-50: null
Link fragments should be valid

(MD051, link-fragments)

51-51: null
Link fragments should be valid

(MD051, link-fragments)

55-55: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

56-56: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

57-57: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

58-58: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

59-59: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

62-76: LGTM!

The ConditionType defines the essential condition types for a GreptimeDB cluster with clear descriptions.

78-97: LGTM!

The DatanodeSpec type is well-defined with fields covering the essential configuration for a datanode component. The "Appears in" section correctly lists the places where this type is used.

Tools
Markdownlint

91-91: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

92-92: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

93-93: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

94-94: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

95-95: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

96-96: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

99-114: LGTM!

The DatanodeStatus type captures the essential status information for a datanode component. The "Appears in" section correctly lists the places where this type is used.

Tools
Markdownlint

108-108: null
Link fragments should be valid

(MD051, link-fragments)

112-112: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

113-113: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

116-133: LGTM!

The FlownodeSpec type is well-defined with fields covering the essential configuration for a flownode component. The "Appears in" section correctly lists the places where this type is used.

Tools
Markdownlint

129-129: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

130-130: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

131-131: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

132-132: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

135-150: LGTM!

The FlownodeStatus type captures the essential status information for a flownode component. The "Appears in" section correctly lists the places where this type is used.

Tools
Markdownlint

144-144: null
Link fragments should be valid

(MD051, link-fragments)

148-148: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

149-149: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

152-170: LGTM!

The FrontendSpec type is well-defined with fields covering the essential configuration for a frontend component, including the service and TLS specifications. The "Appears in" section correctly lists the places where this type is used.

Tools
Markdownlint

165-165: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

166-166: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

167-167: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

168-168: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

169-169: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

172-187: LGTM!

The FrontendStatus type captures the essential status information for a frontend component. The "Appears in" section correctly lists the places where this type is used.

Tools
Markdownlint

181-181: null
Link fragments should be valid

(MD051, link-fragments)

185-185: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

186-186: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

189-207: LGTM!

The GCSStorageProvider type is well-defined with fields covering the essential configuration for using Google Cloud Storage (GCS) as the storage provider. The field descriptions are clear and the "Appears in" section correctly lists the places where this type is used.

Tools
Markdownlint

202-202: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

203-203: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

204-204: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

205-205: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

206-206: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

209-226: LGTM!

The GreptimeDBCluster resource definition follows the standard Kubernetes format with the required fields. The "Appears in" section correctly lists the places where this type is used.

Tools
Markdownlint

222-222: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

223-223: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

224-224: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

225-225: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

228-244: LGTM!

The GreptimeDBClusterList resource definition follows the standard Kubernetes list format with the required fields.

Tools
LanguageTool

[uncategorized] ~231-~231: Possible missing comma found.
Context: ...| | | #### GreptimeDBClusterList GreptimeDBClusterList contains a list of GreptimeDBCluster ...

(AI_HYDRA_LEO_MISSING_COMMA)

Markdownlint

240-240: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

241-241: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

242-242: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

243-243: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

246-274: LGTM!

The GreptimeDBClusterSpec type is well-defined with fields covering the essential configuration for a GreptimeDB cluster. The "Appears in" section correctly lists the places where this type is used.

Tools
Markdownlint

259-259: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

260-260: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

261-261: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

262-262: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

263-263: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

264-264: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

265-265: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

266-266: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

267-267: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

268-268: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

269-269: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

270-270: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

271-271: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

272-272: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

273-273: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

278-295: LGTM!

The GreptimeDBStandalone resource definition follows the standard Kubernetes format with the required fields. The "

Tools
Markdownlint

291-291: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

292-292: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

293-293: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

294-294: Expected: 2; Actual: 4; Too many cells, extra data will be missing
Table column count

(MD056, table-column-count)

zyy17
zyy17 approved these changes Sep 4, 2024
View reviewed changes
Copy link
Collaborator

@zyy17 zyy17 left a comment

Choose a reason for hiding this comment

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

🚀

@zyy17 zyy17 merged commit 2c1e38f into GreptimeTeam:develop Sep 4, 2024
9 checks passed
@daviderli614 daviderli614 deleted the feat/api-docs branch September 5, 2024 14:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

@zyy17 zyy17 zyy17 approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@daviderli614 @zyy17