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] Update stacks page and add azure 1-click from dashboard docs #3082

Merged
merged 22 commits into from
Oct 17, 2024

Conversation

wjayesh
Copy link
Contributor

@wjayesh wjayesh commented Oct 14, 2024

Describe changes

I implemented the docs page for the azure 1-click deployment on the ZenML Dashboard and modified the stacks page.

  • update outdates info on docs saying we don't support azure
  • add steps to deploy azure stack with 1-click with screenshots
  • update the manage stack components how-to page with info about stacks and roles and permissions
  • moved the implement a custom integration page to Popular Integrations under the How-to section

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)

@github-actions github-actions bot added internal To filter out internal PRs and issues documentation Improvements or additions to documentation labels Oct 14, 2024
@wjayesh wjayesh requested a review from htahir1 October 14, 2024 12:05
Copy link
Contributor

Images automagically compressed by Calibre's image-actions

Compression reduced images by 14.6%, saving 386.45 KB.

Filename Before After Improvement Visual comparison
docs/book/.gitbook/assets/deploy_stack_azure_cloud_shell_terraform_outputs.png 317.97 KB 262.08 KB -17.6% View diff
docs/book/.gitbook/assets/deploy_stack_azure_cloud_shell.png 157.88 KB 136.31 KB -13.7% View diff
docs/book/.gitbook/assets/deploy_stack_azure_dashboard_output.png 268.40 KB 230.58 KB -14.1% View diff
docs/book/.gitbook/assets/deploy_stack_azure_deployment_page.png 270.08 KB 235.63 KB -12.8% View diff
docs/book/.gitbook/assets/deploy_stack_azure_location.png 243.65 KB 213.58 KB -12.3% View diff
docs/book/.gitbook/assets/deploy_stack_azure_resources.png 270.25 KB 231.94 KB -14.2% View diff
docs/book/.gitbook/assets/deploy_stack_selection.png 255.75 KB 217.49 KB -15.0% View diff
docs/book/.gitbook/assets/register_stack_page.png 303.85 KB 257.94 KB -15.1% View diff
docs/book/.gitbook/assets/stack-wizard-cloud-selection.png 255.75 KB 217.49 KB -15.0% View diff
docs/book/.gitbook/assets/stack-wizard-options.png 303.85 KB 257.94 KB -15.1% View diff

315 images did not require optimisation.

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

Copy link
Contributor

@htahir1 htahir1 left a comment

Choose a reason for hiding this comment

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

I left some comments. In addition, heres a few other things:

  • Previously, we always linked to https://docs.zenml.io/user-guide/production-guide/understand-stacks whenever we wanted to talk about stacks. Can you go through the docs and link to this page instead?
  • I think the page you wrote doesn't really have a coherent story IMO. It should be a starting chapter that leads into the "deploy a cloud stack..." etc sections... not sure about this feedback but maybe you can take a step back and think what this section needs as an intro to stacks and this section?

docs/book/toc.md Outdated Show resolved Hide resolved
docs/book/how-to/stack-deployment/README.md Show resolved Hide resolved
docs/book/how-to/stack-deployment/README.md Outdated Show resolved Hide resolved
docs/book/how-to/stack-deployment/README.md Show resolved Hide resolved
docs/book/how-to/stack-deployment/README.md Show resolved Hide resolved
docs/book/how-to/stack-deployment/README.md Outdated Show resolved Hide resolved
Copy link
Contributor

Images automagically compressed by Calibre's image-actions

Compression reduced images by 10.6%, saving 2.69 KB.

Filename Before After Improvement Visual comparison
docs/book/.gitbook/assets/stack_envs.png 25.48 KB 22.79 KB -10.6% View diff

327 images did not require optimisation.

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

@wjayesh
Copy link
Contributor Author

wjayesh commented Oct 16, 2024

@htahir1

Previously, we always linked to https://docs.zenml.io/user-guide/production-guide/understand-stacks whenever we wanted to talk about stacks. Can you go through the docs and link to this page instead?

i think we should still link to that page in the docs because that sort of introduces the stack at a basic level. this new page:
https://github.com/zenml-io/zenml/blob/220e6c1d44efad25873839cfbaabdd0b518f483b/docs/book/how-to/stack-deployment/README.md
talks more about management of stacks.

I think the page you wrote doesn't really have a coherent story IMO. It should be a starting chapter that leads into the "deploy a cloud stack..." etc sections... not sure about this feedback but maybe you can take a step back and think what this section needs as an intro to stacks and this section?

i agree that the first version had headings that felt out of place a bit. but i think content-wise it felt right to me. i have now updated the page (linked above). can you take a look and let me know if it's coherent? my thought was this: the page talks about managing stacks, so it begins with what a stack is and how to view the stack as a way to organize your envs. Then it talks about managing creds for your stacks, and finally how to navigate their deployment -> leading to the deployment pages later

@wjayesh wjayesh requested a review from htahir1 October 16, 2024 07:55
Copy link
Contributor

Images automagically compressed by Calibre's image-actions

Compression reduced images by 5.6%, saving 7.53 KB.

Filename Before After Improvement Visual comparison
docs/book/.gitbook/assets/service_con_workflow.png 133.72 KB 126.19 KB -5.6% View diff

328 images did not require optimisation.

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

Copy link
Contributor

@htahir1 htahir1 left a comment

Choose a reason for hiding this comment

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

Ok i agree with the two points you laid out @wjayesh so lets move on from those. I left new review comments now

docs/book/how-to/stack-deployment/README.md Outdated Show resolved Hide resolved
docs/book/how-to/stack-deployment/README.md Show resolved Hide resolved
Copy link
Contributor

@htahir1 htahir1 left a comment

Choose a reason for hiding this comment

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

Smal nit otherwise approved!

docs/book/how-to/contribute-to-zenml/README.md Outdated Show resolved Hide resolved
@wjayesh wjayesh merged commit c61a084 into develop Oct 17, 2024
10 checks passed
@wjayesh wjayesh deleted the docs/stack-provisioning-strategies branch October 17, 2024 12:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation internal To filter out internal PRs and issues
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants