Skip to content

[Feat] Updated the Azure Tutorial page in the Layer5 Docs#1045

Open
banana-three-join wants to merge 1 commit into
layer5io:masterfrom
banana-three-join:feature/banana-three-join/azure-resources-tutorial
Open

[Feat] Updated the Azure Tutorial page in the Layer5 Docs#1045
banana-three-join wants to merge 1 commit into
layer5io:masterfrom
banana-three-join:feature/banana-three-join/azure-resources-tutorial

Conversation

@banana-three-join
Copy link
Copy Markdown
Contributor

Notes for Reviewers

This PR fixes #1044

Signed commits

  • Yes, I signed my commits.

Signed-off-by: Lenox Wiltshire <lenoxwiltshire@gmail.com>
Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request updates the Azure deployment tutorials for Kanvas by adding descriptive images and refining the step-by-step instructions for deploying the Azure Service Operator and Storage Accounts. The review feedback focuses on improving the clarity and flow of the documentation, specifically by correcting grammatical phrasing, reducing redundancy in configuration steps, and ensuring consistent step numbering.

[Start From Template](../images/deploy-azure-resources-with-meshery/start-from-template.png)
2. Search for the **Azure Service Operator** design.
[Search Azure Operator](../images/deploy-azure-resources-with-meshery/search-azure-operator.png)
3. Once found, click on the **Azure Service Operator** design, after that, click on **Clone** to add it to your canvas.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

medium

The phrasing 'after that' is slightly redundant. Using 'then' makes the instruction more concise and improves the flow of the sentence.

Suggested change
3. Once found, click on the **Azure Service Operator** design, after that, click on **Clone** to add it to your canvas.
3. Once found, click on the **Azure Service Operator** design, then click **Clone** to add it to your canvas.

* **Azure Portal**: Confirm the new Storage Account appears in your specified resource group.


1. Click on **Components** and start by searching **Azure Storage** and putting the **Storage Account** to design area.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

medium

The phrasing 'putting the Storage Account to design area' is grammatically incomplete. It should be 'to the design area' or 'onto the design area' for better clarity.

Suggested change
1. Click on **Components** and start by searching **Azure Storage** and putting the **Storage Account** to design area.
1. Click on **Components**, search for **Azure Storage**, and add the **Storage Account** to the design area.

3. Click **Clone** to add it to your canvas.
4. Configure the following properties:

1. Click on **Components** and start by searching **Azure Storage** and putting the **Storage Account** to design area.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

medium

The phrasing 'putting the Storage Account to design area' is grammatically incomplete. It should be 'to the design area' or 'onto the design area' for better clarity.

Suggested change
1. Click on **Components** and start by searching **Azure Storage** and putting the **Storage Account** to design area.
1. Click on **Components**, search for **Azure Storage**, and add the **Storage Account** to the design area.

Comment on lines +113 to +115
2. Configure the **Storage Account** to fit your needs.
[Config Storage Account](../images/deploy-azure-storage-account-with-meshery/config-storage-account.png)
3. Configure the following properties:
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

medium

Steps 2 and 3 are redundant as they both describe configuring the Storage Account. Merging them into a single step improves the flow of the tutorial.

Suggested change
2. Configure the **Storage Account** to fit your needs.
[Config Storage Account](../images/deploy-azure-storage-account-with-meshery/config-storage-account.png)
3. Configure the following properties:
2. Configure the **Storage Account** to fit your needs, specifically the following properties:
[Config Storage Account](../images/deploy-azure-storage-account-with-meshery/config-storage-account.png)

* `accessTier` (`Hot` or `Cool`)
5. Click **Actions → Deploy**.

4. Click **Actions → Deploy**.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

medium

This step should be renumbered to 3 to maintain the correct sequence after merging the previous steps.

Suggested change
4. Click **Actions → Deploy**.
3. Click **Actions → Deploy**.

@github-actions
Copy link
Copy Markdown

🚀 Preview deployment: https://layer5io.github.io/docs/pr-preview/pr-1045/

Note: Preview may take a moment (GitHub Pages deployment in progress). Please wait and refresh. Track deployment here

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Docs] Update the content of the Azure tutorials in the Layer5 Docs

1 participant