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 "Tooling" guides section #782

Merged
merged 6 commits into from
Sep 28, 2023
Merged

Add "Tooling" guides section #782

merged 6 commits into from
Sep 28, 2023

Conversation

AaronCrawfis
Copy link
Contributor

This PR adds a section under guides called "Tooling" where the rad CLI and VS Code sections can live. It also adds an overview page for VSCode and renames some of the links to better label the pages.

@AaronCrawfis AaronCrawfis marked this pull request as ready for review September 18, 2023 16:10
@AaronCrawfis AaronCrawfis requested a review from a team as a code owner September 18, 2023 16:10
@AaronCrawfis AaronCrawfis requested a review from a team as a code owner September 22, 2023 00:50
Copy link
Contributor

@Reshrahim Reshrahim left a comment

Choose a reason for hiding this comment

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

This addition is great. Added minor comments

docs/content/guides/tooling/vscode/overview/index.md Outdated Show resolved Hide resolved
{{< alert title="Note" color="secondary" >}}
The Radius Bicep extension is a temporary extension that exists in order to extend the set of Bicep types with the Radius types. When the Bicep project adds extensibility support to their tooling the Radius Bicep extension will be deprecated. Stay tuned for updates.

**The Radius Bicep extension is not compatible with the official Bicep extension.** If you have the official Bicep extension installed you will need to disable or uninstall it before installing the Radius Bicep extension.
Copy link
Contributor

Choose a reason for hiding this comment

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

Can this be a separate warning instead of a note? It can also be part of the how-to guide

@@ -20,9 +20,9 @@ Visit the [rad CLI how-to guide]({{< ref howto-rad-cli >}}) for more information

## Step 2: Install the Radius-Bicep VS Code extension
Copy link
Contributor

Choose a reason for hiding this comment

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

We do surface terraform extensions for terraform recipes in vscode tooling overview page. Should that be included 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.

I don't think so, since it's an optional experience only needed if creating Terraform Recipes. Versus the Radius-Bicep extension that is required in 99% of cases.

type: docs
title: "rad CLI"
linkTitle: "rad CLI"
description: "Documentation on the rad CLI"
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
description: "Documentation on the rad CLI"
description: "rad CLI"

Copy link
Contributor

@jonvsm jonvsm left a comment

Choose a reason for hiding this comment

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

I made several minor editorial changes for you to consider.

@AaronCrawfis AaronCrawfis requested a review from a team as a code owner September 28, 2023 02:13
@AaronCrawfis AaronCrawfis dismissed Reshrahim’s stale review September 28, 2023 02:14

Added comments to review. Always appreciate the feedback and we can definitely address some of the deeper details in follow-up PRs.

@AaronCrawfis AaronCrawfis merged commit 3e83e1b into v0.25 Sep 28, 2023
7 of 8 checks passed
@AaronCrawfis AaronCrawfis deleted the aacrawfi/tooling branch September 28, 2023 02:15
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