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

docs(aws): Update AWS docs to keep consistency with Docker docs #11284

Merged
merged 2 commits into from
Sep 26, 2024

Conversation

AColocho
Copy link
Contributor

@AColocho AColocho commented Sep 1, 2024

Checklist

  • [x ] The PR conforms to DataHub's Contributing Guideline (particularly Commit Message Format)
  • Links to related issues (if applicable)
  • Tests for the changes have been added/updated (if applicable)
  • Docs related to the changes have been added/updated (if applicable). If a new feature has been added a Usage Guide has been added for the same.
  • For any breaking change/potential downtime/deprecation/big changes an entry has been made in Updating DataHub

Summary by CodeRabbit

  • Documentation
    • Updated guidance on Docker image tagging for the datahub-frontend service.
    • Recommended using specific version tags for production deployments instead of "latest" or "debug".
    • Added a note to reinforce best practices for image tagging in deployment scenarios.

Copy link
Contributor

coderabbitai bot commented Sep 1, 2024

Important

Review skipped

Auto 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 documentation for the datahub-frontend service in aws.md has been updated to change the Docker image tag from "latest" to "head". This adjustment reflects a new tagging strategy that discourages the use of unsupported tags like "latest" and "debug", advocating instead for specific version tags for production deployments. A note has been added to reinforce these best practices.

Changes

Files Change Summary
docs/deploy/aws.md Updated Docker image tag from "latest" to "head" and added a note against using unsupported tags.

Poem

In the meadow, hopping light,
A change was made, oh what a sight!
From "latest" to "head," we cheer,
For tagging wise, we hold so dear.
With version tags, we'll leap and play,
In our happy, code-filled way! 🐇✨


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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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.

@github-actions github-actions bot added docs Issues and Improvements to docs community-contribution PR or Issue raised by member(s) of DataHub Community labels Sep 1, 2024
@AColocho
Copy link
Contributor Author

AColocho commented Sep 1, 2024

@coderabbitai review

Copy link
Contributor

coderabbitai bot commented Sep 1, 2024

Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

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: 1

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between a7fc7f5 and fa86632.

Files selected for processing (1)
  • docs/deploy/aws.md (2 hunks)
Additional context used
LanguageTool
docs/deploy/aws.md

[uncategorized] ~157-~157: Possible missing comma found.
Context: ...use latest or debug tags for any of the image as those are not supported and present ...

(AI_HYDRA_LEO_MISSING_COMMA)


[uncategorized] ~157-~157: A comma is probably missing here.
Context: ...specific for versions like v0.8.40. For production we recommend using version specific tag...

(MISSING_COMMA_AFTER_INTRODUCTORY_PHRASE)


[uncategorized] ~157-~157: When ‘version-specific’ is used as a modifier, it is usually spelled with a hyphen.
Context: ...8.40. For production we recommend using version specific tags not head. You need to request a c...

(SPECIFIC_HYPHEN)

Additional comments not posted (1)
docs/deploy/aws.md (1)

141-141: Update Docker Image Tag Recommendation

The change from the Docker image tag "latest" to "head" is noted. This is a significant update as it directs users to use a more stable version of the Docker image, which is crucial for avoiding potential issues with the "latest" tag that might not be stable. Ensure that this change is clearly communicated in the update logs or change notes to inform users of the rationale behind this change.

docs/deploy/aws.md Outdated Show resolved Hide resolved
@hsheth2 hsheth2 added the merge-pending-ci A PR that has passed review and should be merged once CI is green. label Sep 11, 2024
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
@hsheth2 hsheth2 changed the title DOCS: Update AWS docs to keep consistency with Docker docs docs(aws): Update AWS docs to keep consistency with Docker docs Sep 25, 2024
@anshbansal anshbansal merged commit 3366cdf into datahub-project:master Sep 26, 2024
26 checks passed
sleeperdeep pushed a commit to sleeperdeep/datahub that referenced this pull request Dec 17, 2024
…hub-project#11284)

Co-authored-by: Harshal Sheth <hsheth2@gmail.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
community-contribution PR or Issue raised by member(s) of DataHub Community docs Issues and Improvements to docs merge-pending-ci A PR that has passed review and should be merged once CI is green.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants