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

[Documentation] link typo corrected #8071

Merged
merged 4 commits into from
Jun 25, 2024
Merged

[Documentation] link typo corrected #8071

merged 4 commits into from
Jun 25, 2024

Conversation

mdacoca
Copy link
Contributor

@mdacoca mdacoca commented Jun 24, 2024

Motivation and context

How has this been tested?

Checklist

  • I submit my changes into the develop branch
  • I have created a changelog fragment
  • I have updated the documentation accordingly
  • I have added tests to cover my changes
  • I have linked related issues (see GitHub docs)
  • I have increased versions of npm packages if it is necessary
    (cvat-canvas,
    cvat-core,
    cvat-data and
    cvat-ui)

License

  • I submit my code changes under the same MIT License that covers the project.
    Feel free to contact the maintainers if that's a concern.

Summary by CodeRabbit

  • Documentation
    • Updated descriptions for the Solo and Team plans on CVAT.ai, including refined details about collaboration, limitations, and pricing.

@mdacoca mdacoca added the documentation Documentation should be updated label Jun 24, 2024
Copy link
Contributor

coderabbitai bot commented Jun 24, 2024

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

The changes to the subscription-management.md file involve refining the descriptions for the Solo and Team plans on CVAT.ai. These updates detail enhanced aspects of collaboration, define certain limitations more clearly, and provide clarity on the pricing for each plan.

Changes

File Path Change Summary
site/content/en/docs/enterprise/...management.md Updated descriptions for Solo and Team plans, detailing collaboration, limitations, and pricing

Poem

Amidst the lines of code, a change so bright,
Solo and Team plans now gleam in the light.
Collaboration shines, limitations defined,
Pricing clear, with value aligned.
Rejoice in the update, oh developers dear,
For CVAT steps ahead, the path made clear! 🌟


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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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.

@mdacoca mdacoca changed the title link typo corrected [Documentation] link typo corrected Jun 24, 2024
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

Outside diff range and nitpick comments (9)
site/content/en/docs/enterprise/subscription-management.md (9)

Line range hint 8-8: Consider rephrasing to avoid split infinitive.

The phrase "how to effectively manage" uses a split infinitive which can be stylistically awkward. Consider revising to "how to manage effectively."


Line range hint 92-92: Consistency in directional descriptions.

Consider adding hyphens to compound modifiers such as "top-right corner" for consistency and improved readability across the document.

- top right corner
+ top-right corner

Also applies to: 125-125, 161-161, 207-207, 292-292, 317-317


Line range hint 127-127: Possible typo in navigation instruction.

The phrase "Go to the Billing Information > Update Information" might be missing a word between "to" and "the". It should likely be "Go to the Billing Information section > Update Information."

- Go to the **Billing Information** > **Update Information**
+ Go to the **Billing Information** section > **Update Information**

Line range hint 134-134: Consider adding a comma for clarity.

The phrase "which in the case of CVAT.ai, is [Stripe]" might benefit from a comma after "CVAT.ai" to improve readability.

- which in the case of CVAT.ai, is [Stripe]
+ which, in the case of CVAT.ai, is [Stripe]

Line range hint 192-192: Simplify expression for clarity.

The phrase "At the moment" could be simplified to "Currently" to make the sentence more concise and direct.

- At the moment this method of payment
+ Currently, this method of payment

Line range hint 235-235: Clarify change plan condition.

The phrase "If for some reason you want to change your plan" could be simplified to "If you want to change your plan" to remove unnecessary words and make the instruction clearer.

- If for some reason you want to change your plan
+ If you want to change your plan

Line range hint 257-257: Simplify expression for brevity.

The phrase "taking into account the amount of money" could be shortened to "considering the amount of money" for brevity and clarity.

- taking into account the amount of money
+ considering the amount of money

Line range hint 260-260: Add comma for grammatical correctness.

The sentence "your subscription will be renewed and the start date will be reset to the day" is missing a comma before "and" which connects two independent clauses.

- your subscription will be renewed and the start date will be reset to the day
+ your subscription will be renewed, and the start date will be reset to the day

Line range hint 294-294: Remove unnecessary comma after 'please'.

The phrase "Please, fill out the feedback form" includes an unnecessary comma after "Please." It could be removed for grammatical correctness.

- Please, fill out the feedback form
+ Please fill out the feedback form
Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between a53e2bf and ce29a93.

Files selected for processing (1)
  • site/content/en/docs/enterprise/subscription-management.md (1 hunks)
Additional context used
LanguageTool
site/content/en/docs/enterprise/subscription-management.md

[style] ~8-~8: Style-wise, it’s not ideal to insert an adverb (‘effectively’) in the middle of an infinitive construction (‘to manage’). Try moving the adverb to avoid split infinitives. (SPLIT_INFINITIVE)
Context: ... --- This article provides tips on how to effectively manage your CVAT subscriptions, including tracking expenses and cancel...


[uncategorized] ~92-~92: Consider adding a hyphen. (TOP_LEFT_CORNER)
Context: ...anization** account. 3. Navigate to the top right corner, next to the nickname, click ...


[uncategorized] ~125-~125: Consider adding a hyphen. (TOP_LEFT_CORNER)
Context: ...upcoming invoices from CVAT.ai? In the top right corner, near the nickname, click on the...


[uncategorized] ~127-~127: “to the” seems less likely than “to”. (AI_HYDRA_LEO_CP_TO_THE_TO)
Context: ...plan. You will see the Stripe page. Go to the Billing Information > **Update Info...


[uncategorized] ~134-~134: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ...f the payment processing platform used, which in the case of CVAT.ai, is [Stripe](htt...


[uncategorized] ~161-~161: Consider adding a hyphen. (TOP_LEFT_CORNER)
Context: ...# Where can I find my invoices? In the top right corner, near the nickname, click on the...


[style] ~192-~192: For conciseness, consider replacing this expression with an adverb. (AT_THE_MOMENT)
Context: ...# Paying with bank transfer > Note At the moment this method of payment > works only wit...


[uncategorized] ~207-~207: Consider adding a hyphen. (TOP_LEFT_CORNER)
Context: ...w to change the payment method? In the top right corner, near the nickname, click on the...


[typographical] ~235-~235: Consider wrapping this idiom with two commas if you want to put a strong emphasize on it. (FOR_WHATEVER_REASON_COMMA)
Context: ...or both Solo and Team plans. If for some reason you want to change your plan, you need ...


[style] ~257-~257: ‘taking into account’ might be wordy. Consider a shorter alternative. (EN_WORDINESS_PREMIUM_TAKING_INTO_ACCOUNT)
Context: ...in the Quantity field (if updated), taking into account the amount of money that was not spent ...


[uncategorized] ~260-~260: Use a comma before “and” if it connects two independent clauses (unless they are closely connected and short). (COMMA_COMPOUND_SENTENCE_2)
Context: ...yment, your subscription will be renewed and the start date will be reset to the day...


[uncategorized] ~292-~292: Consider adding a hyphen. (TOP_LEFT_CORNER)
Context: ...l any plan? To cancel the plan, in the top right corner, near the nickname, click on the...


[typographical] ~294-~294: A comma between “please” and the verb is normally not needed. If you want to signal a pause, consider using an em dash instead. (PLEASE_UNNECESSARY_COMMA)
Context: ...e arrow> manage plan > Cancel plan Please, fill out the feedback form, to help us impro...


[uncategorized] ~317-~317: Consider adding a hyphen. (TOP_LEFT_CORNER)
Context: ...renew your CVAT.ai subscription, in the top right corner, near the nickname, click on the...

Additional comments not posted (2)
site/content/en/docs/enterprise/subscription-management.md (2)

54-54: Clarification on the Solo plan description.

The updated description of the Solo plan clarifies that while it allows the creation of an organization and access for up to 2 members, these are intended for trial purposes only and come with the limitations of the Free plan. This is a significant clarification that helps set the right expectations for users.


54-54: Enhanced collaboration details for the Team plan.

The updated description for the Team plan emphasizes the collaborative nature of the plan and clearly outlines the billing structure based on the number of team members. This update is beneficial for transparency and helps users understand the cost implications of adding more team members.
[APROVED]

Copy link

sonarcloud bot commented Jun 24, 2024

@bsekachev bsekachev merged commit b84f174 into develop Jun 25, 2024
14 checks passed
@bsekachev bsekachev deleted the ma/link-update branch June 26, 2024 06:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Documentation should be updated
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants