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

Add Helm and Kubernetes tutorial #864

Merged
merged 12 commits into from
Oct 24, 2023
Merged

Conversation

rynowak
Copy link
Contributor

@rynowak rynowak commented Oct 17, 2023

Thank you for helping make the Radius documentation better!

Please follow this checklist before submitting:

  • Read the contribution guide
  • Commands include options for Linux, MacOS, and Windows within codetabs
  • New file and folder names are globally unique
  • Page references use shortcodes instead of markdown or URL links
  • Images use HTML style and have alternative text
  • Places where multiple code/command options are given have codetabs

In addition, please fill out the following to help reviewers understand this pull request:

Description

Auto-generated description

🤖 Generated by Copilot at ffba503

Summary

🔄🚀📝

Updated the resourceType names in the rad_resource_list command reference to include the dapr prefix. This improves the clarity and consistency of the documentation for users who want to use dapr resources with radius-cli.

dapr prefix adds
clarity for resource types
cutting through the fog

Walkthrough

  • Add dapr prefix to resourceType names for pubSubBrokers, stateStores, and secretStores to indicate compatibility with dapr runtime (link)

Issue reference

@rynowak rynowak requested review from a team as code owners October 17, 2023 18:52
@rynowak rynowak temporarily deployed to latest October 17, 2023 18:52 — with GitHub Actions Inactive
@rynowak rynowak force-pushed the rynowak/kubernetes-interop-tutorial branch from ffba503 to 3fd29bc Compare October 17, 2023 18:53
@rynowak rynowak temporarily deployed to latest October 17, 2023 18:53 — with GitHub Actions Inactive
@rynowak rynowak force-pushed the rynowak/kubernetes-interop-tutorial branch from 3fd29bc to ec7286f Compare October 17, 2023 18:54
@rynowak rynowak temporarily deployed to latest October 17, 2023 18:54 — with GitHub Actions Inactive
@rynowak rynowak changed the base branch from v0.26 to edge October 17, 2023 19:43
@rynowak rynowak force-pushed the rynowak/kubernetes-interop-tutorial branch from ec7286f to 0df1ea5 Compare October 17, 2023 19:48
@rynowak rynowak temporarily deployed to latest October 17, 2023 19:48 — with GitHub Actions Inactive
@rynowak rynowak force-pushed the rynowak/kubernetes-interop-tutorial branch from 0df1ea5 to 631fa03 Compare October 17, 2023 19:53
@rynowak rynowak temporarily deployed to latest October 17, 2023 19:53 — with GitHub Actions Inactive
@rynowak rynowak force-pushed the rynowak/kubernetes-interop-tutorial branch from 631fa03 to d12bb63 Compare October 17, 2023 19:55
@rynowak rynowak temporarily deployed to latest October 17, 2023 19:55 — with GitHub Actions Inactive
@rynowak rynowak force-pushed the rynowak/kubernetes-interop-tutorial branch from d12bb63 to bde97de Compare October 17, 2023 21:05
@rynowak rynowak temporarily deployed to latest October 17, 2023 21:05 — with GitHub Actions Inactive
@rynowak rynowak temporarily deployed to latest October 18, 2023 21:33 — with GitHub Actions Inactive
Copy link
Contributor

@willtsai willtsai left a comment

Choose a reason for hiding this comment

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

Overall this looks really great! A couple of high-level points:

  • Should the headers for each step include the word "step" in them to be consistent with other tutorials? e.g. "## Step 7. Add Connection"
  • I worry that this tutorial is very long, maybe covering too much ground. Would it be a good idea to show only one of Steps 6 and 7? and then at the end you can refer the reader to the other how-tos for adding Radius features to their k8s helm app.

docs/content/tutorials/helm/index.md Outdated Show resolved Hide resolved
docs/content/tutorials/helm/index.md Outdated Show resolved Hide resolved
docs/content/tutorials/helm/index.md Outdated Show resolved Hide resolved
docs/content/tutorials/helm/index.md Outdated Show resolved Hide resolved
docs/content/tutorials/helm/index.md Show resolved Hide resolved
docs/content/tutorials/helm/index.md Outdated Show resolved Hide resolved
docs/content/tutorials/helm/index.md Outdated Show resolved Hide resolved
docs/content/tutorials/helm/index.md Outdated Show resolved Hide resolved
docs/content/tutorials/helm/index.md Outdated Show resolved Hide resolved
docs/content/tutorials/helm/index.md Outdated Show resolved Hide resolved
Copy link
Contributor

@AaronCrawfis AaronCrawfis left a comment

Choose a reason for hiding this comment

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

Flow is looking really good. The steps seems like the right set, in the right order, and the way to "see" each effect seems spot on. Only major concern is how we can handle the Kubernetes secret before Radius. Left a comment there.

docs/content/tutorials/helm/index.md Outdated Show resolved Hide resolved
docs/content/tutorials/helm/index.md Outdated Show resolved Hide resolved
docs/content/tutorials/helm/index.md Outdated Show resolved Hide resolved
docs/content/tutorials/helm/index.md Outdated Show resolved Hide resolved
docs/content/tutorials/helm/index.md Outdated Show resolved Hide resolved
docs/content/tutorials/helm/index.md Outdated Show resolved Hide resolved
docs/content/tutorials/helm/index.md Outdated Show resolved Hide resolved
docs/content/tutorials/helm/index.md Outdated Show resolved Hide resolved
docs/content/tutorials/helm/index.md Outdated Show resolved Hide resolved
docs/content/tutorials/helm/index.md Outdated Show resolved Hide resolved
@willtsai willtsai temporarily deployed to latest October 23, 2023 16:24 — with GitHub Actions Inactive
@willtsai willtsai temporarily deployed to latest October 23, 2023 17:32 — with GitHub Actions Inactive
@willtsai willtsai temporarily deployed to latest October 24, 2023 16:10 — with GitHub Actions Inactive
@willtsai willtsai temporarily deployed to latest October 24, 2023 16:12 — with GitHub Actions Inactive
@github-actions
Copy link

Azure Static Web Apps: Your stage site is ready! Visit it here: https://calm-bush-0cc2a4f1e-864.westus2.3.azurestaticapps.net

@willtsai willtsai temporarily deployed to latest October 24, 2023 16:53 — with GitHub Actions Inactive
@willtsai
Copy link
Contributor

A few issues: At this deployment https://calm-bush-0cc2a4f1e-864.westus2.3.azurestaticapps.net/, the following does not render: image src=“diagram.png” The Tutorial name in the left nav bar ("Helm application") does not match the title of the tutorial ("Use Helm to run your first app"). They should be consistent and say something like "Use Helm to run your first Radius application" "Open Github codespaces button should open codespaces in a different browser tab by default so the reader can switch between a codespaces tab and tutorial tab. When I create a codespace and follow instructions, I get @jonvsm ➜ /workspaces/samples (v0.26) $ cd ./samples/demo @jonvsm ➜ /workspaces/samples/samples/demo (v0.26) $ rad init Failed to read Kubernetes config. Cause: open /home/codespace/.kube/config: no such file or directory.

regarding the opening in new tabs, we will have to make an adjustment to the overall website configs as this is the same behavior as the getting started guide.

@willtsai willtsai temporarily deployed to latest October 24, 2023 16:56 — with GitHub Actions Inactive
Signed-off-by: Will Tsai <[email protected]>
@willtsai willtsai temporarily deployed to latest October 24, 2023 16:56 — with GitHub Actions Inactive
Co-authored-by: Reshma Abdul Rahim <[email protected]>
@willtsai willtsai temporarily deployed to latest October 24, 2023 16:58 — with GitHub Actions Inactive
@github-actions
Copy link

Azure Static Web Apps: Your stage site is ready! Visit it here: https://calm-bush-0cc2a4f1e-864.westus2.3.azurestaticapps.net

@willtsai willtsai temporarily deployed to latest October 24, 2023 16:59 — with GitHub Actions Inactive
@github-actions
Copy link

Azure Static Web Apps: Your stage site is ready! Visit it here: https://calm-bush-0cc2a4f1e-864.westus2.3.azurestaticapps.net

@github-actions
Copy link

Azure Static Web Apps: Your stage site is ready! Visit it here: https://calm-bush-0cc2a4f1e-864.westus2.3.azurestaticapps.net

@willtsai willtsai requested a review from Reshrahim October 24, 2023 17:02
@willtsai
Copy link
Contributor

Overall is looking good. One note: a lot of our how-to guides use ordered lists within the steps. Format similar to:

## Step 1: xxxxx

1. Do this
1. Do that

## Step 2: yyyy

1. Do this
1. Do that

This PR follows a different format that can cause a user to lose their place, without the ordered list:

## Step 1

Do this

Do that

Would it make sense to move to the former format?

addressed

@willtsai willtsai dismissed AaronCrawfis’s stale review October 24, 2023 17:11

I have addressed the feedback and gotten approval from another docs maintainer.

@willtsai willtsai merged commit 0785ff3 into v0.26 Oct 24, 2023
8 checks passed
@willtsai willtsai deleted the rynowak/kubernetes-interop-tutorial branch October 24, 2023 17:11
@willtsai willtsai temporarily deployed to latest October 24, 2023 17:11 — with GitHub Actions Inactive
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants