Add how-to guide on application deletion #655

Reshrahim · 2023-07-24T19:06:48Z

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

Part 2 of #650 covers the Radius application deletion.

Auto-generated description

`🤖 Generated by Copilot at 3f4645d`

Summary

🚚📝🗑️

This pull request adds a new section to the docs called Deploying applications with pages for the rad deploy, rad run, and rad app delete commands. It also renames the Developing applications section to Authoring applications and moves the Developer environments page to the new section. Finally, it adjusts the weights of some sections and pages to change the order of the sidebar menu.

rad commands shine
Deploying apps in autumn
Docs reflect new terms

Walkthrough

Rename "Developing applications" section to "Authoring applications" (link)
Add new section "Deploying applications" with metadata and description (link)
Add new pages to "Deploying applications" section with content and examples for rad deploy, rad run, and rad app delete commands (link, link)
Move "Developer environments" page from "Authoring applications" section to "Deploying applications" section and change its weight (link)
Adjust the weights of "Community", "Contributing", "Operating environments", and "Reference" sections to reorder the sidebar menu (link, link, link, link)

Issue reference

Fixes #654

…into reshma/deploy

github-actions · 2023-07-24T19:10:02Z

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

github-actions · 2023-08-10T21:44:47Z

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

github-actions · 2023-08-10T22:18:55Z

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

AaronCrawfis

Looking good, couple small wording tweaks

docs/content/deploy-apps/delete-applications/index.md

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

github-actions · 2023-08-14T14:46:06Z

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

github-actions · 2023-08-14T14:46:20Z

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

github-actions · 2023-08-14T14:47:12Z

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

github-actions · 2023-08-14T14:48:37Z

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

github-actions · 2023-08-14T14:56:12Z

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

docs/content/deploy-apps/deploy-applications/index.md

github-actions · 2023-08-14T15:07:47Z

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

…into reshma/delete

github-actions · 2023-08-14T18:27:01Z

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

docs/content/deploy-apps/delete-applications/index.md

github-actions · 2023-08-14T20:18:11Z

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

github-actions · 2023-08-14T20:25:45Z

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

github-actions · 2023-08-14T20:54:58Z

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

docs/content/deploy-apps/delete-applications/index.md

AaronCrawfis · 2023-08-14T21:10:06Z

docs/content/deploy-apps/delete-applications/index.md

+rad app delete <appname>
+```
+
+This will delete the following resources from the default Radius environment


Suggested change

This will delete the following resources from the default Radius environment

This will delete:

I don't think we need to call out the behavior of the default environment. If a user deployed their application to a non-default environment they already will know to set that flag. Plus any error message would guide them to the right behavior.

Retaining the environment part for completion.

AaronCrawfis · 2023-08-14T21:12:30Z

docs/content/deploy-apps/delete-applications/index.md

+
+This will delete the following resources from the default Radius environment
+
+1. All the resources created by Radius on the Kubernetes cluster under the `default-<app-name>` namespace


Suggested change

1. All the resources created by Radius on the Kubernetes cluster under the `default-<app-name>` namespace

1. All managed resources created from Radius resources (_containers, gateways, etc._)

The namespace would only be default-<app-name> if the environment is setup with the default Kubernetes namespace. We can omit that detail and focus on the managed resources created by Radius.

Are we referencing Radius resources as managed resources?

Yeah I was going back and forth on this. The term we use in the codebase is "rendered resources", but I had gotten feedback that readers may not want to use that term. Was trying to find a term that better describes what's happening without introducing a new "branded" term. Lemme see if I can reword this a little, as I want to describe what's happening without another proper adverb in Radius

docs/content/deploy-apps/delete-applications/index.md

github-actions · 2023-08-16T13:22:05Z

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

github-actions · 2023-08-16T13:23:42Z

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

Reshrahim and others added 14 commits July 21, 2023 14:28

Adding a deploying application section

dcb02a5

add deploy applications page

925d166

Merge branch 'edge' into reshma/deploy

325e82a

Address feedback

6a34d27

Merge branch 'reshma/deploy' of https://github.com/project-radius/docs …

8b4a572

…into reshma/deploy

Address feedback

34c00d2

Fix typo

0067b74

Fix typo

526b998

Removing the eg o/p

bce157b

Address comments

e2bf749

Address comments

098c00f

Fix space

a3eb2c0

Add a page on deletion

4328bef

Fix weight

3f4645d

Reshrahim requested a review from a team as a code owner July 24, 2023 19:06

Reshrahim changed the base branch from v0.23 to edge July 24, 2023 19:07

Reshrahim added the do-not-merge Do not merge this PR label Jul 24, 2023

Reshrahim removed the do-not-merge Do not merge this PR label Aug 10, 2023

Merge branch 'edge' into reshma/delete

c95a0fb

Add how to guide on delete application

c23ec90

Reshrahim changed the title ~~Add a page on application deletion~~ Add how-to guide on application deletion Aug 10, 2023

AaronCrawfis suggested changes Aug 11, 2023

View reviewed changes

Reshrahim and others added 5 commits August 14, 2023 10:42

Update docs/content/deploy-apps/delete-applications/index.md

f74600e

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

Update docs/content/deploy-apps/delete-applications/index.md

39e9ec4

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

Update docs/content/deploy-apps/delete-applications/index.md

9f671b9

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

Update docs/content/deploy-apps/delete-applications/index.md

572d97e

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

Update docs/content/deploy-apps/delete-applications/index.md

7fdff3d

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

Add text on existing resource

58f80e8

Reshrahim requested a review from AaronCrawfis August 14, 2023 14:52

Reshrahim commented Aug 14, 2023

View reviewed changes

docs/content/deploy-apps/deploy-applications/index.md Show resolved Hide resolved

Update docs/content/deploy-apps/deploy-applications/index.md

d4c8fba

Reshrahim added 2 commits August 14, 2023 14:22

Update the delete command

f12b1f1

Merge branch 'reshma/delete' of https://github.com/project-radius/docs …

f37cde8

…into reshma/delete

Reshrahim linked an issue Aug 14, 2023 that may be closed by this pull request

Verify and document the deletion behavior for a Radius application #654

Closed

AaronCrawfis suggested changes Aug 14, 2023

View reviewed changes

docs/content/deploy-apps/delete-applications/index.md Outdated Show resolved Hide resolved

Fix codetab formatting

dd2bb32

Code tab fix

74e6732

change steps as headers

0ce1d25

AaronCrawfis suggested changes Aug 14, 2023

View reviewed changes

Reshrahim and others added 2 commits August 16, 2023 09:13

Address feedbac

2c55577

Merge branch 'edge' into reshma/delete

e51d4db

AaronCrawfis approved these changes Aug 16, 2023

View reviewed changes

Reshrahim merged commit 2dcd1d5 into edge Aug 16, 2023
8 checks passed

Reshrahim deleted the reshma/delete branch August 16, 2023 13:25

Reshrahim mentioned this pull request Aug 16, 2023

add instructions for deleting Kubernetes resources #445

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add how-to guide on application deletion #655

Add how-to guide on application deletion #655

Reshrahim commented Jul 24, 2023 •

edited

Loading

github-actions bot commented Jul 24, 2023 •

edited

Loading

github-actions bot commented Aug 10, 2023 •

edited

Loading

github-actions bot commented Aug 10, 2023 •

edited

Loading

AaronCrawfis left a comment

github-actions bot commented Aug 14, 2023 •

edited

Loading

github-actions bot commented Aug 14, 2023 •

edited

Loading

github-actions bot commented Aug 14, 2023 •

edited

Loading

github-actions bot commented Aug 14, 2023 •

edited

Loading

github-actions bot commented Aug 14, 2023 •

edited

Loading

github-actions bot commented Aug 14, 2023 •

edited

Loading

github-actions bot commented Aug 14, 2023 •

edited

Loading

github-actions bot commented Aug 14, 2023 •

edited

Loading

github-actions bot commented Aug 14, 2023 •

edited

Loading

github-actions bot commented Aug 14, 2023 •

edited

Loading

AaronCrawfis Aug 14, 2023

Reshrahim Aug 16, 2023

AaronCrawfis Aug 14, 2023

Reshrahim Aug 16, 2023

AaronCrawfis Aug 16, 2023

github-actions bot commented Aug 16, 2023 •

edited

Loading

github-actions bot commented Aug 16, 2023 •

edited

Loading

	This will delete the following resources from the default Radius environment
	This will delete:


		This will delete the following resources from the default Radius environment

		1. All the resources created by Radius on the Kubernetes cluster under the `default-<app-name>` namespace

	1. All the resources created by Radius on the Kubernetes cluster under the `default-<app-name>` namespace
	1. All managed resources created from Radius resources (_containers, gateways, etc._)

Add how-to guide on application deletion #655

Add how-to guide on application deletion #655

Conversation

Reshrahim commented Jul 24, 2023 • edited Loading

Description

Auto-generated description

🤖 Generated by Copilot at 3f4645d

Summary

Walkthrough

Issue reference

github-actions bot commented Jul 24, 2023 • edited Loading

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

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

AaronCrawfis left a comment

Choose a reason for hiding this comment

github-actions bot commented Aug 14, 2023 • edited Loading

github-actions bot commented Aug 14, 2023 • edited Loading

github-actions bot commented Aug 14, 2023 • edited Loading

github-actions bot commented Aug 14, 2023 • edited Loading

github-actions bot commented Aug 14, 2023 • edited Loading

github-actions bot commented Aug 14, 2023 • edited Loading

github-actions bot commented Aug 14, 2023 • edited Loading

github-actions bot commented Aug 14, 2023 • edited Loading

github-actions bot commented Aug 14, 2023 • edited Loading

github-actions bot commented Aug 14, 2023 • edited Loading

AaronCrawfis Aug 14, 2023

Choose a reason for hiding this comment

Reshrahim Aug 16, 2023

Choose a reason for hiding this comment

AaronCrawfis Aug 14, 2023

Choose a reason for hiding this comment

Reshrahim Aug 16, 2023

Choose a reason for hiding this comment

AaronCrawfis Aug 16, 2023

Choose a reason for hiding this comment

github-actions bot commented Aug 16, 2023 • edited Loading

github-actions bot commented Aug 16, 2023 • edited Loading

Reshrahim commented Jul 24, 2023 •

edited

Loading

`🤖 Generated by Copilot at 3f4645d`

github-actions bot commented Jul 24, 2023 •

edited

Loading

github-actions bot commented Aug 10, 2023 •

edited

Loading

github-actions bot commented Aug 10, 2023 •

edited

Loading

github-actions bot commented Aug 14, 2023 •

edited

Loading

github-actions bot commented Aug 14, 2023 •

edited

Loading

github-actions bot commented Aug 14, 2023 •

edited

Loading

github-actions bot commented Aug 14, 2023 •

edited

Loading

github-actions bot commented Aug 14, 2023 •

edited

Loading

github-actions bot commented Aug 14, 2023 •

edited

Loading

github-actions bot commented Aug 14, 2023 •

edited

Loading

github-actions bot commented Aug 14, 2023 •

edited

Loading

github-actions bot commented Aug 14, 2023 •

edited

Loading

github-actions bot commented Aug 14, 2023 •

edited

Loading

github-actions bot commented Aug 16, 2023 •

edited

Loading

github-actions bot commented Aug 16, 2023 •

edited

Loading