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

[Release Planner] Links to language generation tutorials #9223

Open
ronniegeraghty opened this issue Oct 21, 2024 · 6 comments
Open

[Release Planner] Links to language generation tutorials #9223

ronniegeraghty opened this issue Oct 21, 2024 · 6 comments
Assignees
Labels
Central-EngSys This issue is owned by the Engineering System team. Engagement Experience

Comments

@ronniegeraghty
Copy link
Member

Current Situation

In the Release Planner's Data Plane SDK readiness app, the Generate SDKs page has a step to "Generate the SDK for " step.
This step has a link to the instructions for how to generate the library in that language.
Image
However, this link doesn't go right to the instructions. It goes to the Eng Hub page on Develop client libraries (SDK). Then on this page you need to click the link for the languages instructions on generating libraries:
Image

Problem

It is easy for users of the Release Planner to get lost when going between the release planner links and Eng Hub links.

Proposed solution

The release planner links directly to the language's instruction on generating libraries, rather than stopping through the Eng Hub docs.

@github-actions github-actions bot added the needs-triage Workflow: This is a new issue that needs to be triaged to the appropriate team. label Oct 21, 2024
@github-actions github-actions bot removed the needs-triage Workflow: This is a new issue that needs to be triaged to the appropriate team. label Oct 21, 2024
@maririos maririos self-assigned this Oct 21, 2024
@maririos maririos added the Central-EngSys This issue is owned by the Engineering System team. label Oct 21, 2024
@maririos
Copy link
Member

@ronniegeraghty

The release planner links directly to the language's instruction on generating libraries, rather than stopping through the Eng Hub docs.

The reason we did that is so we don't have duplication in both places. and to keep it in sync. I can see though, how it is more hoops for the users.
This will be true too for testing and generating samples.

Would you still suggest for us to follow the link directly strategy for those 3 areas?

@ronniegeraghty
Copy link
Member Author

Would you still suggest for us to follow the link directly strategy for those 3 areas?

I think so.

@maririos
Copy link
Member

@praveenkuttappan any objections to this plan?

@praveenkuttappan
Copy link
Member

I think it's fine to do it but we need to add information about "Before we begin" to be listed in release planner.

You read our repository branches strategy.
You are familiarized with the Azure SDK Architecture design guidelines.```

@maririos
Copy link
Member

I think it's fine to do it but we need to add information about "Before we begin" to be listed in release planner.

You read our repository branches strategy.
You are familiarized with the Azure SDK Architecture design guidelines.```

Ohhh interesting. Reading that section, it looks like it should belong in as part of the prerequisites checks instead of generation SDK task itself.
As we look into improving the process, lets contemplate this too.

@maririos
Copy link
Member

Done for code generation, tests, and samples. I am using the same links as the ones provided in Eng Hub

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Central-EngSys This issue is owned by the Engineering System team. Engagement Experience
Projects
Status: 🐝 Dev
Status: Done in Dev
Development

No branches or pull requests

3 participants