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

Minor updates to how-to guide on gateways #851

Closed
wants to merge 8 commits into from
Closed

Conversation

Reshrahim
Copy link
Contributor

@Reshrahim Reshrahim commented Oct 16, 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 1c62b20

Summary

🔎🚀🛠️

Updated the gateway tutorial and the installation guide in the docs. The gateway tutorial now has a more consistent and clear example code and instructions. The installation guide now includes a step to create and set a Kubernetes cluster.

Sing, O Muse, of the skillful coder who changed the tutorial
To make it easier for the learners of the azure container
Who first renamed the section and the file of app.bicep
And then added a new step for the cluster of Kubernetes

Walkthrough

  • Simplify the gateway tutorial by renaming and updating the first step (link)
  • Rename the container resource and the gateway rule destination to match the image name (link, link)
  • Add a new step to create and set a Kubernetes cluster before installing Radius (link)

Issue reference

Reshrahim and others added 5 commits October 12, 2023 17:45
* Add supported resource types

* Add how-to guideto use local dev recipes

* Apply suggestions from code review

Co-authored-by: Jonathan Smith <[email protected]>

* Update docs/content/guides/recipes/howto-dev-recipes/index.md

* Adddress feedback

* Address feedback

* Apply suggestions from code review

Co-authored-by: Aaron Crawfis <[email protected]>

* Minor tweaks

* minor tweaks

---------

Co-authored-by: Jonathan Smith <[email protected]>
Co-authored-by: Aaron Crawfis <[email protected]>
* Standardixe pre-reqs for all how-tos

* Update docs/content/guides/author-apps/azure/howto-azure-resources/index.md
@Reshrahim Reshrahim requested review from a team as code owners October 16, 2023 20:11
@Reshrahim Reshrahim temporarily deployed to latest October 16, 2023 20:11 — with GitHub Actions Inactive
@@ -16,9 +16,9 @@ This guide will walk you through how to setup a gateway for routing internet tra
- [Radius Bicep VSCode extension]({{< ref "installation#step-2-install-the-radius-bicep-vs-code-extension" >}})
- [Radius environment]({{< ref "installation#step-3-initialize-the-radius-control-plane-and-the-radius-environment" >}})

## Step 1: Define a container
## Step 1: View the container
Copy link
Contributor

Choose a reason for hiding this comment

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

hmm without explicitly telling the user to run rad init and select "yes" to scaffold an application I think "Define a container" works better, along with "in a new file".

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The pre-requisite step Radius environment does cover the step to select yes and set up the application. Either we go with that or make env creation a separate step here

Copy link
Contributor Author

Choose a reason for hiding this comment

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

closing as we decided to make how-tos standalone and not operate with the assumption of user scaffolding an application via rad init

@Reshrahim Reshrahim closed this Oct 16, 2023
@Reshrahim Reshrahim temporarily deployed to latest October 16, 2023 21:36 — 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.

3 participants