Docs for stack registration + deployment wizards #2814

htahir1 · 2024-06-28T10:06:17Z

Describe changes

Early draft of the docs for the stack registration + deployment wizards. Gitbook space here. Feel free to leave early comments but don't do a full review until this is marked as ready for review.

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-06-28T10:06:22Z

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

github-actions · 2024-07-08T11:45:46Z

Images automagically compressed by Calibre's image-actions ✨

Compression reduced images by 47.1%, saving 88.92 KB.

Filename	Before	After	Improvement	Visual comparison
`docs/book/.gitbook/assets/deploy_stack_aws_cloudformation_intro.png`	188.88 KB	99.96 KB	-47.1%	View diff

244 images did not require optimisation.

Update required: Update image-actions configuration to the latest version before 1/1/21. See README for instructions.

htahir1

Some reviews

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

docs/book/how-to/stack-deployment/register-a-cloud-stack.md

Co-authored-by: Hamza Tahir <hamza@zenml.io>

* Adding some context for stack registration * Adding some context for stack registration * Adding some context for stack registration * Adding some context for stack registration * Adding some context for stack registration * Adding some context for stack registration * Adding some context for stack registration * Adding some context for stack registration * Adding some context for stack registration * Adding some context for stack registration * Adding some context for stack registration * Adding some context for stack registration * Adding some context for stack registration * Adding some context for stack registration * Adding some context for stack registration * Adding some context for stack registration * Adding some context for stack registration * Adding some context for stack registration * Adding some context for stack registration * Adding some context for stack registration * Adding some context for stack registration * Adding some context for stack registration * Adding some context for stack registration * Adding some context for stack registration * Adding some context for stack registration * Adding some context for stack registration * Adding some context for stack registration * Adding some context for stack registration * Adding some context for stack registration * Adding some context for stack registration * Updated README * Updated README * Updated README * Updated README * Updated README * Updated README * Updated README * various docs changes * typo * first draft before polishing * minor fixes * new screenshots * changing the order * rephrasing * minor fixes * Optimised images with calibre/image-actions * more screenshots and finishing up the page * some links * Optimised images with calibre/image-actions * forgotten breakpoint * updating the readme * register page * minor changes * minor changes * changing the description * Update docs/book/how-to/stack-deployment/deploy-a-cloud-stack.md Co-authored-by: Hamza Tahir <hamza@zenml.io> * added to the warning * adding permission to aws cloudformation * Document AWS permissions * new gif * slight prephrasing * warning regarding the deployed instance * rephrasing --------- Co-authored-by: Baris Can Durak <bariscandurak@hotmail.com> Co-authored-by: Barış Can Durak <36421093+bcdurak@users.noreply.github.com> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Stefan Nica <stefan@zenml.io> (cherry picked from commit 9060c52)

* Adding some context for stack registration * Adding some context for stack registration * Adding some context for stack registration * Adding some context for stack registration * Adding some context for stack registration * Adding some context for stack registration * Adding some context for stack registration * Adding some context for stack registration * Adding some context for stack registration * Adding some context for stack registration * Adding some context for stack registration * Adding some context for stack registration * Adding some context for stack registration * Adding some context for stack registration * Adding some context for stack registration * Adding some context for stack registration * Adding some context for stack registration * Adding some context for stack registration * Adding some context for stack registration * Adding some context for stack registration * Adding some context for stack registration * Adding some context for stack registration * Adding some context for stack registration * Adding some context for stack registration * Adding some context for stack registration * Adding some context for stack registration * Adding some context for stack registration * Adding some context for stack registration * Adding some context for stack registration * Adding some context for stack registration * Updated README * Updated README * Updated README * Updated README * Updated README * Updated README * Updated README * various docs changes * typo * first draft before polishing * minor fixes * new screenshots * changing the order * rephrasing * minor fixes * Optimised images with calibre/image-actions * more screenshots and finishing up the page * some links * Optimised images with calibre/image-actions * forgotten breakpoint * updating the readme * register page * minor changes * minor changes * changing the description * Update docs/book/how-to/stack-deployment/deploy-a-cloud-stack.md Co-authored-by: Hamza Tahir <hamza@zenml.io> * added to the warning * adding permission to aws cloudformation * Document AWS permissions * new gif * slight prephrasing * warning regarding the deployed instance * rephrasing --------- Co-authored-by: Baris Can Durak <bariscandurak@hotmail.com> Co-authored-by: Barış Can Durak <36421093+bcdurak@users.noreply.github.com> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Stefan Nica <stefan@zenml.io> (cherry picked from commit 9060c52) Co-authored-by: Hamza Tahir <hamza@zenml.io>

htahir1 added 15 commits June 28, 2024 10:50

Adding some context for stack registration

5416232

Adding some context for stack registration

ab34534

Adding some context for stack registration

1f36635

Adding some context for stack registration

c58e9da

Adding some context for stack registration

ba1c4fa

Adding some context for stack registration

a78ef16

Adding some context for stack registration

10c1f3a

Adding some context for stack registration

ff8da5d

Adding some context for stack registration

ad1ade0

Adding some context for stack registration

63884ba

Adding some context for stack registration

b045af4

Adding some context for stack registration

10b2c4a

Adding some context for stack registration

6fc475b

Adding some context for stack registration

6024c1d

Adding some context for stack registration

7f3129e

htahir1 requested review from stefannica, avishniakov and bcdurak June 28, 2024 10:06

github-actions bot added the internal To filter out internal PRs and issues label Jun 28, 2024

htahir1 added 10 commits June 28, 2024 13:40

Adding some context for stack registration

eb5b4ec

Adding some context for stack registration

0a500f2

Adding some context for stack registration

ce04fb8

Adding some context for stack registration

e59cec6

Adding some context for stack registration

007ea6a

Adding some context for stack registration

52f231a

Adding some context for stack registration

dec7380

Adding some context for stack registration

496873e

Adding some context for stack registration

ba89a47

Adding some context for stack registration

7dce659

bcdurak added 8 commits July 8, 2024 13:49

forgotten breakpoint

cc39f0f

new rephrasing

f96f884

merged develop in

5880817

updating the readme

70fb1f1

register page

dc13d9a

minor changes

b5f8fdb

minor changes

83b80b9

changing the description

463f669

htahir1 commented Jul 9, 2024

View reviewed changes

docs/book/how-to/stack-deployment/deploy-a-cloud-stack.md Show resolved Hide resolved

htahir1 commented Jul 9, 2024

View reviewed changes

docs/book/how-to/stack-deployment/register-a-cloud-stack.md Show resolved Hide resolved

bcdurak and others added 12 commits July 9, 2024 13:58

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

f341253

Co-authored-by: Hamza Tahir <hamza@zenml.io>

added to the warning

496ecca

merged

8c2b312

merged develop

d2bf9ab

adding permission to aws cloudformation

1ffbfcd

Document AWS permissions

f114a95

new gif

0854f30

merge

d2ed871

slight prephrasing

741a84e

warning regarding the deployed instance

10cb3c1

rephrasing

5af1398

Merge branch 'develop' into doc/1clickdeploymentandstackwizard

9a9d2e9

bcdurak self-requested a review July 9, 2024 13:18

bcdurak approved these changes Jul 9, 2024

View reviewed changes

bcdurak merged commit 9060c52 into develop Jul 9, 2024
8 checks passed

bcdurak deleted the doc/1clickdeploymentandstackwizard branch July 9, 2024 13:43

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Docs for stack registration + deployment wizards #2814

Docs for stack registration + deployment wizards #2814

htahir1 commented Jun 28, 2024

coderabbitai bot commented Jun 28, 2024 •

edited

Loading

Review skipped

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

Documentation and Community

github-actions bot commented Jul 8, 2024

htahir1 left a comment

Docs for stack registration + deployment wizards #2814

Docs for stack registration + deployment wizards #2814

Conversation

htahir1 commented Jun 28, 2024

Describe changes

Pre-requisites

Types of changes

coderabbitai bot commented Jun 28, 2024 • edited Loading

Review skipped

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

Documentation and Community

github-actions bot commented Jul 8, 2024

htahir1 left a comment

Choose a reason for hiding this comment

coderabbitai bot commented Jun 28, 2024 •

edited

Loading

CodeRabbit Configration File (`.coderabbit.yaml`)