Azure / Azure/azure-cli

Customer feedback | SEO | Release notes

Open
#29,497 1 comment 0 reactions 0 assignees View on GitHub
act-observability-squad Service Attention staticwebapp
Dominant language
Python
Stars
4.6k
Forks
3.5k
Avg merge
3d 2h
Merged PRs (30d)
60

Description

### Feedback category
Search / navigation frustration

### Doc link
https://learn.microsoft.com/en-us/cli/azure/release-notes-azure-cli

### Summary
From Learn Customer Feedback, finding the changes of a particular Azure CLI version is difficult when we've grouped our release notes by date, not by version ID. The only way for a customer to find a release ID is `CTRL + F` (Windows) or scrolling indefinitely.

### Suggestion: Improve SEO
Make one of these two changes which will result in our release ID being searchable via Internet search engines, and more easily navigated in our doc:
* **Put the release ID as the H2.** Example 1:
![image](https://github.com/user-attachments/assets/18abc10f-0b4b-4869-a9e9-5444a9b23a62)

* **Put both the relase ID and date both on the H2.** Example 2:
![image](https://github.com/user-attachments/assets/a436d13c-e182-45b1-857f-ce641d117172)

### Current state
* Release IDs are not searchable via an Internet search engine because they are not an H2 header
* This particular example is also causing a recurring azure-docs-cli build error because there are duplicate H2s.
![image](https://github.com/user-attachments/assets/acb6fbc6-e104-4824-9a89-a3837c4ebf33)

### Customer feedback
"
Table of contents lists dates, not versions. Why? `az version` returns version number, not the date of the update. Really hard to navigate
"

### Example of current Internet search results:
![image](https://github.com/user-attachments/assets/06d33c0a-8620-4838-a27b-fa7c2d5ac219)

CCin @dcaro for awareness.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.