Document terraform stack deployment modules #2898

stefannica · 2024-07-31T14:36:48Z

Describe changes

Document our newly implemented Terraform stack deployment modules.

Sync-ed with: https://app.gitbook.com/o/-MCl1Hlw9oU4xibZ-ymf/s/sSi8uXbe2nPYIyiHcpxS/how-to/stack-deployment/deploy-a-cloud-stack-with-terraform

Pre-requisites

Please ensure you have done the following:

I have read the CONTRIBUTING.md document.
If my change requires a change to docs, I have updated the documentation accordingly.
I have added tests to cover my changes.
I have based my new branch on develop and the open PR is targeting develop. If your branch wasn't based on develop read Contribution guide on rebasing branch to develop.
If my changes require changes to the dashboard, these changes are communicated/requested.

Types of changes

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to change)
Other (add details above)

coderabbitai · 2024-07-31T14:36:54Z

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.

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

docs/book/component-guide/artifact-stores/azure.md

docs/book/component-guide/artifact-stores/gcp.md

docs/book/component-guide/artifact-stores/s3.md

docs/book/how-to/stack-deployment/deploy-a-cloud-stack-with-terraform.md

Co-authored-by: Alex Strick van Linschoten <[email protected]>

htahir1

So in general i like this but I feel like there is too much information sort of "dumped" here. The art of writing docs is also to make it consumable and easily digestible for the user. While this is super structured chunks like this can be very daunting for users:

This is when somebody is doing the production guide and it is repeated many places where I feel it comes as a jarring 3-option choice. Before the callout was a single sentence. We should keep it that way, and add the terraform option

That's my feedback :-) Let me know if you'd like to be more specific but I generally think a fresh look at this with the lens of a user who as limited time would help here!

stefannica · 2024-08-01T08:26:19Z

So in general i like this but I feel like there is too much information sort of "dumped" here. The art of writing docs is also to make it consumable and easily digestible for the user. While this is super structured chunks like this can be very daunting for users:
This is when somebody is doing the production guide and it is repeated many places where I feel it comes as a jarring 3-option choice. Before the callout was a single sentence. We should keep it that way, and add the terraform option
That's my feedback :-) Let me know if you'd like to be more specific but I generally think a fresh look at this with the lens of a user who as limited time would help here!

Alright, fair point. How's this ?

htahir1 · 2024-08-01T08:35:18Z

@stefannica id rather say replace "easy cloud deployment wizard" and "easy cloud registration wizard" with "in-browser stack deployment wizard" and "stack registration wizard"

strickvl

LGTM from my side, though agree that giving people simpler choices (or just one choice) + less text to read is probably the way to go.

stefannica · 2024-08-01T09:44:27Z

@stefannica id rather say replace "easy cloud deployment wizard" and "easy cloud registration wizard" with "in-browser stack deployment wizard" and "stack registration wizard"

@htahir1 done

htahir1

LGTM! Please do backport!

* Document terraform stack deployment modules * Apply suggestions from code review Co-authored-by: Alex Strick van Linschoten <[email protected]> * Fix links * Simplified hints * Updated wizard names --------- Co-authored-by: Alex Strick van Linschoten <[email protected]>

stefannica · 2024-08-01T11:06:56Z

LGTM! Please do backport!

@htahir1 backported: https://docs.zenml.io/how-to/stack-deployment/deploy-a-cloud-stack-with-terraform

stefannica requested review from strickvl and htahir1 July 31, 2024 14:36

github-actions bot added internal To filter out internal PRs and issues documentation Improvements or additions to documentation labels Jul 31, 2024

Document terraform stack deployment modules

a84c5d9

stefannica force-pushed the docs/terraform-stack-modules branch from 21158b0 to a84c5d9 Compare July 31, 2024 14:37

strickvl requested changes Jul 31, 2024

View reviewed changes

stefannica and others added 2 commits July 31, 2024 22:44

Apply suggestions from code review

10a7f9e

Co-authored-by: Alex Strick van Linschoten <[email protected]>

Fix links

d755848

stefannica requested a review from strickvl July 31, 2024 20:48

htahir1 requested changes Jul 31, 2024

View reviewed changes

Simplified hints

d01113a

stefannica requested a review from htahir1 August 1, 2024 08:26

strickvl approved these changes Aug 1, 2024

View reviewed changes

Updated wizard names

e28f2ff

htahir1 approved these changes Aug 1, 2024

View reviewed changes

stefannica merged commit cb4c7ac into develop Aug 1, 2024
7 checks passed

stefannica deleted the docs/terraform-stack-modules branch August 1, 2024 11:00

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Document terraform stack deployment modules #2898

Document terraform stack deployment modules #2898

Uh oh!

stefannica commented Jul 31, 2024 •

edited

Loading

Uh oh!

coderabbitai bot commented Jul 31, 2024

Review skipped

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

htahir1 left a comment

Uh oh!

stefannica commented Aug 1, 2024

Uh oh!

htahir1 commented Aug 1, 2024

Uh oh!

strickvl left a comment

Uh oh!

stefannica commented Aug 1, 2024

Uh oh!

htahir1 left a comment

Uh oh!

Uh oh!

stefannica commented Aug 1, 2024

Uh oh!

Uh oh!

Document terraform stack deployment modules #2898

Document terraform stack deployment modules #2898

Uh oh!

Conversation

stefannica commented Jul 31, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Describe changes

Pre-requisites

Types of changes

Uh oh!

coderabbitai bot commented Jul 31, 2024

Review skipped

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

htahir1 left a comment

Choose a reason for hiding this comment

Uh oh!

stefannica commented Aug 1, 2024

Uh oh!

htahir1 commented Aug 1, 2024

Uh oh!

strickvl left a comment

Choose a reason for hiding this comment

Uh oh!

stefannica commented Aug 1, 2024

Uh oh!

htahir1 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

stefannica commented Aug 1, 2024

Uh oh!

Uh oh!

stefannica commented Jul 31, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)