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.

Sign up for GitHub

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

Jump to bottom

Add how-to guide on Connect to dependencies #807

Merged
merged 26 commits into from
Oct 12, 2023
Merged

Add how-to guide on Connect to dependencies #807

merged 26 commits into from
Oct 12, 2023

Conversation

Reshrahim
Copy link
Contributor

@Reshrahim Reshrahim commented Oct 4, 2023 •
edited by ghost
Loading

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

This PR adds a how-to guide on connecting to dependencies. Will create another PR to create a separate how-to use containers in Radius that covers basics, setting env vars, volumes etc.

Auto-generated description

🤖 Generated by Copilot at 21d0583

Summary

📝🧩🔧

This pull request updates the container guides to use a mongo database dependency instead of manual environment variables. It renames and modifies the existing app-mongodb.bicep file, simplifies the howto-environment-variables guide, and adds a new howto-connect-dependencies guide with its own bicep snippets.

Oh we're the bicep crew and we know what to do
We write the code that makes the app run smooth
We add and change and rename with a mongo twist
And we document it all in a markdown list

Walkthrough

  • Add a new how-to guide on connecting to dependencies using connections (link)
    • Include a snippet of the app and container definition without the mongo database and the connection (link)
      • Remove the manual environment variables from the container definition (link)
      • Update the comment markers for the mongo database resource definition (link, link)
    • Update the weight and the slug of the guide (link)
    • Update the introduction of the guide to remove the reference to connections (link)
    • Remove the steps related to adding and connecting to the mongo database (link)

Issue reference

Fixes: #706

@Reshrahim Reshrahim requested review from a team as code owners October 4, 2023 19:39
@github-actions
Copy link

github-actions bot commented Oct 4, 2023 •
edited
Loading

Azure Static Web Apps: Your stage site is ready! Visit it here: https://wonderful-plant-020417a1e-807.westus2.azurestaticapps.net
Password: Radiu$1234

@github-actions
Copy link

github-actions bot commented Oct 5, 2023 •
edited
Loading

Azure Static Web Apps: Your stage site is ready! Visit it here: https://wonderful-plant-020417a1e-807.westus2.azurestaticapps.net
Password: Radiu$1234

@github-actions
Copy link

github-actions bot commented Oct 5, 2023 •
edited
Loading

Azure Static Web Apps: Your stage site is ready! Visit it here: https://wonderful-plant-020417a1e-807.westus2.azurestaticapps.net
Password: Radiu$1234

@Reshrahim Reshrahim requested a review from AaronCrawfis October 5, 2023 02:52
AaronCrawfis
AaronCrawfis suggested changes Oct 9, 2023
View reviewed changes
docs/content/guides/author-apps/containers/howto-connect-dependencies/index.md Outdated Show resolved Hide resolved
docs/content/guides/author-apps/containers/howto-connect-dependencies/index.md Outdated Show resolved Hide resolved
docs/content/guides/author-apps/containers/howto-connect-dependencies/index.md Outdated Show resolved Hide resolved
docs/content/guides/author-apps/containers/howto-connect-dependencies/index.md Outdated Show resolved Hide resolved
docs/content/guides/author-apps/containers/howto-connect-dependencies/index.md Outdated Show resolved Hide resolved
docs/content/guides/author-apps/containers/howto-environment-variables/index.md Outdated Show resolved Hide resolved
docs/content/guides/author-apps/containers/howto-connect-dependencies/connections.png Outdated Show resolved Hide resolved
@github-actions
Copy link

github-actions bot commented Oct 10, 2023 •
edited
Loading

Azure Static Web Apps: Your stage site is ready! Visit it here: https://wonderful-plant-020417a1e-807.westus2.azurestaticapps.net
Password: Radiu$1234

@github-actions
Copy link

github-actions bot commented Oct 10, 2023 •
edited
Loading

Azure Static Web Apps: Your stage site is ready! Visit it here: https://wonderful-plant-020417a1e-807.westus2.azurestaticapps.net
Password: Radiu$1234

@github-actions
Copy link

github-actions bot commented Oct 11, 2023 •
edited
Loading

Azure Static Web Apps: Your stage site is ready! Visit it here: https://wonderful-plant-020417a1e-807.westus2.azurestaticapps.net
Password: Radiu$1234

@github-actions
Copy link

github-actions bot commented Oct 12, 2023 •
edited
Loading

Azure Static Web Apps: Your stage site is ready! Visit it here: https://wonderful-plant-020417a1e-807.westus2.azurestaticapps.net
Password: Radiu$1234

@github-actions
Copy link

github-actions bot commented Oct 12, 2023 •
edited
Loading

Azure Static Web Apps: Your stage site is ready! Visit it here: https://wonderful-plant-020417a1e-807.westus2.azurestaticapps.net
Password: Radiu$1234

@github-actions
Copy link

github-actions bot commented Oct 12, 2023 •
edited
Loading

Azure Static Web Apps: Your stage site is ready! Visit it here: https://wonderful-plant-020417a1e-807.westus2.azurestaticapps.net
Password: Radiu$1234

AaronCrawfis
AaronCrawfis approved these changes Oct 12, 2023
View reviewed changes
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.

Overall looks great! Couple small formatting suggestions

docs/content/guides/author-apps/containers/howto-connect-dependencies/index.md

## Step 1: View the container definition

Open the `app.bicep` and view the [container]({{< ref "guides/author-apps/containers" >}}):
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Open the `app.bicep` and view the [container]({{< ref "guides/author-apps/containers" >}}):
Create a file named `app.bicep` and add a [container]({{< ref "guides/author-apps/containers" >}}):

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 user would create a Radius environment as part of the prereqs where they select yes to set up the app. So the app.bicep will have the demo container definition

docs/content/guides/author-apps/containers/howto-connect-dependencies/index.md Outdated Show resolved Hide resolved
docs/content/guides/author-apps/containers/howto-connect-dependencies/index.md Outdated Show resolved Hide resolved
docs/content/guides/author-apps/containers/howto-connect-dependencies/index.md Outdated Show resolved Hide resolved
...ntent/guides/author-apps/containers/howto-connect-dependencies/snippets/app-with-redis.bicep Show resolved Hide resolved
...ntent/guides/author-apps/containers/howto-connect-dependencies/snippets/app-with-redis.bicep Outdated Show resolved Hide resolved
@Reshrahim Reshrahim temporarily deployed to latest October 12, 2023 16:26 — with GitHub Actions Inactive
@Reshrahim Reshrahim enabled auto-merge (squash) October 12, 2023 16:28
@Reshrahim Reshrahim temporarily deployed to latest October 12, 2023 16:29 — with GitHub Actions Inactive
@Reshrahim Reshrahim merged commit d9be7b5 into edge Oct 12, 2023
7 checks passed
@Reshrahim Reshrahim deleted the reshma/con branch October 12, 2023 16:29
@Reshrahim Reshrahim temporarily deployed to edge October 12, 2023 16:29 — with GitHub Actions Inactive
@github-actions
Copy link

github-actions bot commented Oct 12, 2023 •
edited
Loading

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@rynowak rynowak rynowak left review comments

@AaronCrawfis AaronCrawfis AaronCrawfis approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@Reshrahim @rynowak @AaronCrawfis