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

Sanitize docs for release references #837

Merged
merged 5 commits into from
Oct 13, 2023
Merged

Sanitize docs for release references #837

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
0ba0ece
Add how-to guide on local dev recipes (#822)
Reshrahim Oct 12, 2023
1ca9ef5
Sanitize docs for release references
Reshrahim Oct 12, 2023
5f32830
Revert spelling fix
Reshrahim Oct 12, 2023
075421e
Merge branch 'v0.26' into re/sanitize
Reshrahim Oct 13, 2023
5b1eba1
Apply suggestions from code review
Reshrahim Oct 13, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion docs/content/community/contributing/contributing-docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -204,8 +204,10 @@ Front-matter should be completed with all fields including type, title, linkTitl
- `categories` should be one of the following:
- Concept
- Overview
- Reference application
- Tutorial
- How-To
- Reference
- Schema
- `tags` should be a comma-separated list of metadata tags.

As per the [styling conventions](#styling-conventions), titles should only capitalize the first word and proper nouns, with the exception of "How-To:"
Expand Down
2 changes: 1 addition & 1 deletion docs/content/guides/operations/control-plane/howto-postman/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ Next, you'll need to get the control plane API endpoint and use Postman to inter
1. Set the URL to the following, which will [retrieve all your resource groups]({{< ref api-ucp >}}):

```
<your-cluster-control-plane>/apis/api.ucp.dev/v1alpha3/planes/radius/local/resourcegroups?api-version=2022-09-01-privatepreview
<your-cluster-control-plane>/apis/api.ucp.dev/v1alpha3/planes/radius/local/resourcegroups?api-version=2023-10-01-preview
Copy link
Contributor

Choose a reason for hiding this comment

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

Good catch, thanks!

```

<img src="postman-url.png" width=900px alt="Screenshot of Postman with filled out URL" >
Expand Down
2 changes: 1 addition & 1 deletion docs/content/guides/operations/versioning.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,6 @@ category: "Overview"

## Overview

Radius is currently in an early alpha preview and does not offer backward compatibility with previous releases. Breaking changes may happen between releases and we recommend doing a fresh installation of the latest version of Radius after every release.
Radius does not currently offer backward compatibility with previous releases. Breaking changes may happen between releases and we recommend doing a fresh installation of the latest version of Radius after every release.

We are working on the versioning strategy and will be introducing a versioning policy in the future.
2 changes: 1 addition & 1 deletion docs/content/tutorials/eshop/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,6 @@ Adding Radius to the eShop on containers application allows teams to:
- Easily manage configuration and credentials between infrastructure and services, all within the app model
- Simplify deployment with Bicep and Azure Resource Manager (ARM)

{{< button text="View eShop reference app in samples" githubRepo="samples" githubPath="samples/eshop" color="success" size="btn-lg" >}}
{{< button text="View eShop sample" githubRepo="samples" githubPath="samples/eshop" color="success" size="btn-lg" >}}

*Visit the [GitHub docs]({{< ref github >}}) if you need access to the organization*