Skip to content

Commit

Permalink
Markdownify content when using edge and latest shortcodes (#899)
Browse files Browse the repository at this point in the history
* Merge edge to v0.26 (#838)

* Add how-to guide on local dev recipes  (#822)

* 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]>

* Standardize pre-reqs for all how-tos (#836)

* Standardixe pre-reqs for all how-tos

* Update docs/content/guides/author-apps/azure/howto-azure-resources/index.md

---------

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

* Sanitize docs for release references (#837)

* Add how-to guide on local dev recipes  (#822)

* 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]>

* Sanitize docs for release references

* Revert spelling fix

* Apply suggestions from code review

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

---------

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

* Add Codespace docs

Signed-off-by: Aaron Crawfis <[email protected]>

* Update instructions for `How To Configure AWS Provider` (#839)

* Fixing a typo from the rad install kubernetes command (#846)

* Update pull_request_template.md (#844)

* Update steps after port forward to view the contents of /tmpdir (#847)

Update steps after port forward to view the contents of /tmpdir

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

* Updating the initialization verification doc (#843)

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

* Update index.md with '<container_name>' instead of 'frontend' (#848)

In commend to 'inspect container logs' update current value 'frontend' with a more generic '<container_name>' similar to other commands in the document

* Updating How To Connect Dependencies doc (#850)

* Multi-cloud and OSS concept doc (#821)

* 1st draft of multi-cloud and OSS concept doc

* Fixing spelling errors

* Apply suggestions from code review

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

* Update to correct open-source spelling

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

* Changing doc weight to 100 per Aaron.

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

* Apply break after header

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

* Correct spelling error for "application"

Co-authored-by: Ryan Nowak <[email protected]>

* Add blank line after heading

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

* Add blank line after heading

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

* Include Helm charts in description of deployment assets

Co-authored-by: Ryan Nowak <[email protected]>

* Amazon S3 is not valid Dapr state store, so use DynamoDB instead

Co-authored-by: Ryan Nowak <[email protected]>

* More substantial changes based on Nowak's feedback

* Updating en-custom.txt spelling

* Put the "Concept:" in quotes to prevent build errors

Co-authored-by: Ryan Nowak <[email protected]>

* Get more specific about publicly available

Co-authored-by: Ryan Nowak <[email protected]>

* Update docs/content/concepts/multi-cloud-concept/index.md

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

* Spellcheck

---------

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

* Update index.md (#854)

Updating local dev recipes docs to use correct pod name

* Update link to initialize page (#853)

* Update link

Signed-off-by: Aaron Crawfis <[email protected]>

* Update vscode link

Signed-off-by: Aaron Crawfis <[email protected]>

---------

Signed-off-by: Aaron Crawfis <[email protected]>

* Update copy logic (#855)

Signed-off-by: Aaron Crawfis <[email protected]>

* Fix code formatting (#856)

* Add how to guide on Secret stores (#834)

* Add supported resource types

* Add how-to secret store

* Split into two howto-s

* Fix ref

* Updates

* Apply suggestions from code review

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

* Adddress feedback

* Address feedback

---------

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

* Fix installation instructions

Signed-off-by: Aaron Crawfis <[email protected]>

* Add pre-requisites

Signed-off-by: Aaron Crawfis <[email protected]>

* Update api-ucp.md (#859)

* Update index.md (#858)

* Update index.md

Update to verify Helm installation

* nit

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

* Spellcheck

Signed-off-by: Aaron Crawfis <[email protected]>

---------

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

* Update title

Signed-off-by: Aaron Crawfis <[email protected]>

* Add docs to install Radius Bicep extension from VSCode marketplace (#865)

* Add docs to install Radius Bicep extension from VSCode marketplace

* Revert wrong upd

* Revert upd to initialize

* Update docs/shared-content/installation/install-radius/initialize-radius.md

* Update docs/shared-content/installation/vscode-bicep/install-vscode-bicep.md

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

---------

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

* Update get.radapp.dev references (#866)

* Switch to radapp.io

Signed-off-by: Aaron Crawfis <[email protected]>

* add link to blog (#875)

Signed-off-by: Will Tsai <[email protected]>

* Remove clarity AAD integration

Signed-off-by: Aaron Crawfis <[email protected]>

* Downmerge 10-18-2023 (#878)

* Adding "Why Radius?" concept doc (#827)

* Adding "Why Radius?" concept doc

* Apply suggestions from code review

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

* More feedback

* third draft

---------

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

* Update rad CLI documentation (#868)

* Autogenerate rad CLI reference docs

* Spellcheck

---------

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

* Autogenerate rad CLI reference docs (#872)

Co-authored-by: rad-ci-bot <[email protected]>

* Autogenerate rad CLI reference docs (#873)

Co-authored-by: rad-ci-bot <[email protected]>

* Autogenerate rad CLI reference docs (#874)

Co-authored-by: rad-ci-bot <[email protected]>

* Upmerge 10-18-2023 (#877)

* Merge edge to v0.26 (#838)

* Add how-to guide on local dev recipes  (#822)

* 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]>

* Standardize pre-reqs for all how-tos (#836)

* Standardixe pre-reqs for all how-tos

* Update docs/content/guides/author-apps/azure/howto-azure-resources/index.md

---------

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

* Sanitize docs for release references (#837)

* Add how-to guide on local dev recipes  (#822)

* 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]>

* Sanitize docs for release references

* Revert spelling fix

* Apply suggestions from code review

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

---------

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

* Add Codespace docs

Signed-off-by: Aaron Crawfis <[email protected]>

* Update instructions for `How To Configure AWS Provider` (#839)

* Fixing a typo from the rad install kubernetes command (#846)

* Update pull_request_template.md (#844)

* Update steps after port forward to view the contents of /tmpdir (#847)

Update steps after port forward to view the contents of /tmpdir

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

* Updating the initialization verification doc (#843)

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

* Update index.md with '<container_name>' instead of 'frontend' (#848)

In commend to 'inspect container logs' update current value 'frontend' with a more generic '<container_name>' similar to other commands in the document

* Updating How To Connect Dependencies doc (#850)

* Multi-cloud and OSS concept doc (#821)

* 1st draft of multi-cloud and OSS concept doc

* Fixing spelling errors

* Apply suggestions from code review

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

* Update to correct open-source spelling

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

* Changing doc weight to 100 per Aaron.

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

* Apply break after header

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

* Correct spelling error for "application"

Co-authored-by: Ryan Nowak <[email protected]>

* Add blank line after heading

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

* Add blank line after heading

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

* Include Helm charts in description of deployment assets

Co-authored-by: Ryan Nowak <[email protected]>

* Amazon S3 is not valid Dapr state store, so use DynamoDB instead

Co-authored-by: Ryan Nowak <[email protected]>

* More substantial changes based on Nowak's feedback

* Updating en-custom.txt spelling

* Put the "Concept:" in quotes to prevent build errors

Co-authored-by: Ryan Nowak <[email protected]>

* Get more specific about publicly available

Co-authored-by: Ryan Nowak <[email protected]>

* Update docs/content/concepts/multi-cloud-concept/index.md

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

* Spellcheck

---------

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

* Update index.md (#854)

Updating local dev recipes docs to use correct pod name

* Update link to initialize page (#853)

* Update link

Signed-off-by: Aaron Crawfis <[email protected]>

* Update vscode link

Signed-off-by: Aaron Crawfis <[email protected]>

---------

Signed-off-by: Aaron Crawfis <[email protected]>

* Update copy logic (#855)

Signed-off-by: Aaron Crawfis <[email protected]>

* Fix code formatting (#856)

* Add how to guide on Secret stores (#834)

* Add supported resource types

* Add how-to secret store

* Split into two howto-s

* Fix ref

* Updates

* Apply suggestions from code review

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

* Adddress feedback

* Address feedback

---------

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

* Fix installation instructions

Signed-off-by: Aaron Crawfis <[email protected]>

* Add pre-requisites

Signed-off-by: Aaron Crawfis <[email protected]>

* Update api-ucp.md (#859)

* Update index.md (#858)

* Update index.md

Update to verify Helm installation

* nit

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

* Spellcheck

Signed-off-by: Aaron Crawfis <[email protected]>

---------

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

* Update title

Signed-off-by: Aaron Crawfis <[email protected]>

* Add docs to install Radius Bicep extension from VSCode marketplace (#865)

* Add docs to install Radius Bicep extension from VSCode marketplace

* Revert wrong upd

* Revert upd to initialize

* Update docs/shared-content/installation/install-radius/initialize-radius.md

* Update docs/shared-content/installation/vscode-bicep/install-vscode-bicep.md

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

---------

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

* Update get.radapp.dev references (#866)

* Switch to radapp.io

Signed-off-by: Aaron Crawfis <[email protected]>

* add link to blog (#875)

Signed-off-by: Will Tsai <[email protected]>

* Remove clarity AAD integration

Signed-off-by: Aaron Crawfis <[email protected]>

* revert config changes

* revert config changes

---------

Signed-off-by: Aaron Crawfis <[email protected]>
Signed-off-by: Aaron Crawfis <[email protected]>
Signed-off-by: Will Tsai <[email protected]>
Co-authored-by: Aaron Crawfis <[email protected]>
Co-authored-by: Jonathan Smith <[email protected]>
Co-authored-by: Karishma Chawla <[email protected]>
Co-authored-by: Vishwanath Hiremath <[email protected]>
Co-authored-by: Shalabh Mohan Shrivastava <[email protected]>
Co-authored-by: Lakshmi Javadekar <[email protected]>
Co-authored-by: Yetkin Timocin <[email protected]>
Co-authored-by: Ryan Waite <[email protected]>
Co-authored-by: Ryan Nowak <[email protected]>
Co-authored-by: Shruthi Kumar <[email protected]>
Co-authored-by: Will <[email protected]>

* Revert config changes

---------

Signed-off-by: Aaron Crawfis <[email protected]>
Signed-off-by: Aaron Crawfis <[email protected]>
Signed-off-by: Will Tsai <[email protected]>
Co-authored-by: Ryan Nowak <[email protected]>
Co-authored-by: Jonathan Smith <[email protected]>
Co-authored-by: Ryan Waite <[email protected]>
Co-authored-by: rad-ci-bot <[email protected]>
Co-authored-by: rad-ci-bot <[email protected]>
Co-authored-by: Aaron Crawfis <[email protected]>
Co-authored-by: Karishma Chawla <[email protected]>
Co-authored-by: Vishwanath Hiremath <[email protected]>
Co-authored-by: Shalabh Mohan Shrivastava <[email protected]>
Co-authored-by: Lakshmi Javadekar <[email protected]>
Co-authored-by: Yetkin Timocin <[email protected]>
Co-authored-by: Shruthi Kumar <[email protected]>
Co-authored-by: Will <[email protected]>

* Add auto-generated reference docs shortcode (#880)

* Create script to create reference pages

* Switch to shortcode for Bicep

* Update script

* Update docs

* Add shortcode

Signed-off-by: Aaron Crawfis <[email protected]>

* Remove generated docs

Signed-off-by: Aaron Crawfis <[email protected]>

---------

Signed-off-by: Aaron Crawfis <[email protected]>

* Order concept docs (#879)

* Fix image name

Signed-off-by: Aaron Crawfis <[email protected]>

* trailing slash config (#887)

* Switch to auto

Signed-off-by: Aaron Crawfis <[email protected]>

* Revert trailingSlash

Signed-off-by: Aaron Crawfis <[email protected]>

* Switch back to always

Signed-off-by: Aaron Crawfis <[email protected]>

* Switch to never

Signed-off-by: Aaron Crawfis <[email protected]>

* Set to always

Signed-off-by: Aaron Crawfis <[email protected]>

* Omit trailing slashes

Signed-off-by: Aaron Crawfis <[email protected]>

* Use trailingSlash always

Signed-off-by: Aaron Crawfis <[email protected]>

* Remove trailingSlashes

Signed-off-by: Aaron Crawfis <[email protected]>

* Fix trailing slash

Signed-off-by: Aaron Crawfis <[email protected]>

* Revert update

Signed-off-by: Aaron Crawfis <[email protected]>

* Fix frontend name for new-app tutorial (#890)

* Fix frontend name

Signed-off-by: Aaron Crawfis <[email protected]>

* Fix frontend name

Co-authored-by: Saverio Proto <[email protected]>
Signed-off-by: Aaron Crawfis <[email protected]>

---------

Signed-off-by: Aaron Crawfis <[email protected]>
Co-authored-by: Saverio Proto <[email protected]>

* corrected typo, sharing => sharding (#891)

* Spelling

Signed-off-by: Aaron Crawfis <[email protected]>

* Add redirect for radapp.dev (#895)

Signed-off-by: Aaron Crawfis <[email protected]>

* Markdownify content for edge and latest shortcodes

* Markdownify content

* Update docs/shared-content/installation/vscode-bicep/install-vscode-bicep.md

* Markdownify content

* Rebase edge

* Rebase edge

* remove yml

* Add breaks

---------

Signed-off-by: Aaron Crawfis <[email protected]>
Signed-off-by: Aaron Crawfis <[email protected]>
Signed-off-by: Will Tsai <[email protected]>
Co-authored-by: Aaron Crawfis <[email protected]>
Co-authored-by: Jonathan Smith <[email protected]>
Co-authored-by: Karishma Chawla <[email protected]>
Co-authored-by: Vishwanath Hiremath <[email protected]>
Co-authored-by: Shalabh Mohan Shrivastava <[email protected]>
Co-authored-by: Lakshmi Javadekar <[email protected]>
Co-authored-by: Yetkin Timocin <[email protected]>
Co-authored-by: Ryan Waite <[email protected]>
Co-authored-by: Ryan Nowak <[email protected]>
Co-authored-by: Shruthi Kumar <[email protected]>
Co-authored-by: Will <[email protected]>
Co-authored-by: rad-ci-bot <[email protected]>
Co-authored-by: rad-ci-bot <[email protected]>
Co-authored-by: Saverio Proto <[email protected]>
Co-authored-by: castlec <[email protected]>
  • Loading branch information
16 people authored Oct 26, 2023
1 parent eeb1dcc commit 3f1f7a0
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 11 deletions.
4 changes: 2 additions & 2 deletions docs/layouts/shortcodes/edge.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
{{ $content := .Inner }}

{{ if eq $version "edge" }}
{{ $content }}
{{ (print "\n" $content "\n") | markdownify }}
{{ else }}
To try out an unstable release visit the [edge docs](https://edge.docs.radapp.io).
{{ (print "\n" "To try out an unstable release visit the [edge docs](https://edge.docs.radapp.io)." "\n") | markdownify }}
{{ end }}
4 changes: 2 additions & 2 deletions docs/layouts/shortcodes/latest.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
{{ $content := .Inner }}

{{ if ne $version "edge" }}
{{ $content }}
{{ (print "\n" $content "\n") | markdownify }}
{{ else }}
To try out a stable release visit the [latest docs](https://docs.radapp.io).
{{ (print "\n" "To try out a stable release visit the [latest docs](https://docs.radapp.io)." "\n") | markdownify }}
{{ end }}
Original file line number Diff line number Diff line change
Expand Up @@ -3,23 +3,23 @@ Visual Studio Code offers the best authoring experience for Radius and Bicep. Do
{{< alert title="Disable the official Bicep extension" color="warning" >}}
You can only have one VSCode Bicep extension installed at a time. To build on Radius, you will need to uninstall the official Bicep and use only the Radius Bicep extension.
{{< /alert >}}

{{< latest >}}
1. To install the Radius Bicep extension, search for Radius Bicep in the Extensions tab in VSCode or in the [Visual Studio marketplace](https://marketplace.visualstudio.com/items?itemName=ms-azuretools.rad-vscode-bicep&ssr=false#overview)

<img src="/installation/vscode-bicep/images/radius-bicep.png" alt="Screenshot of Radius Bicep extension in VSCode Marketplace " width=500px>
<img src="/installation/vscode-bicep/images/radius-bicep.png" alt="Screenshot of Radius Bicep extension in VSCode Marketplace " width=500px><br></br>

2. Select Install

To verify you've installed the extension, open any file with the .bicep file extension and start [authoring Radius application]({{< ref author-apps >}}) to verify the auto-complete and other validation features.

{{< /latest >}}
{{< edge >}}
1. Visit the [GitHub Actions runs](https://github.com/radius-project/bicep/actions/workflows/radius-build.yml?query=event%3Apush+branch%3Abicep-extensibility)
2. Click on the latest successful run
3. Scroll down to Artifacts and download `release`
4. Extract the archive and Install the `rad-vscode-bicep.vsix` file:
In VSCode, manually install the extension using the *Install from VSIX* command in the Extensions view command drop-down.

<img src="/installation/vscode-bicep/images/vsix-install.png" alt="Screenshot of installing a vsix extension" width=400>
<img src="/installation/vscode-bicep/images/vsix-install.png" alt="Screenshot of installing a vsix extension" width=400><br>

You can also import this extension on the [command-line](https://code.visualstudio.com/docs/editor/extension-gallery#_install-from-a-vsix) with:

Expand All @@ -28,7 +28,6 @@ To verify you've installed the extension, open any file with the .bicep file ext
```
If you're on macOS, make sure to [setup the `code` alias](https://code.visualstudio.com/docs/setup/mac#_launching-from-the-command-line).

5. If running on Windows Subsystem for Linux (WSL), make sure to install the extension in WSL as well:

<img src="/installation/vscode-bicep/images/wsl-extension.png" alt="Screenshot of installing a vsix extension in WSL" width=400>
5. If running on Windows Subsystem for Linux (WSL), make sure to install the extension in WSL as well:<br>
<img src="/installation/vscode-bicep/images/wsl-extension.png" alt="Screenshot of installing a vsix extension in WSL" width=400>
{{< /edge >}}

0 comments on commit 3f1f7a0

Please sign in to comment.