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

Add Documentation for MPG SDK generation #23837

Merged
merged 3 commits into from
Dec 18, 2024

Conversation

chidozieononiwu
Copy link
Member

Add documentation for Management Plane Generation of SDKs using TypeSpec

@chidozieononiwu chidozieononiwu self-assigned this Dec 5, 2024
@chidozieononiwu chidozieononiwu changed the title Add Documentation fo r MPG SDK kgeneration Add Documentation fo r MPG SDK generation Dec 5, 2024
@chidozieononiwu chidozieononiwu changed the title Add Documentation fo r MPG SDK generation Add Documentation for MPG SDK generation Dec 5, 2024
@@ -94,3 +94,80 @@ generator –r –v –l=temp –version=v11.2.0-beta C:/azure-rest-api-specs/sp
## Generate Azure SDK for Go profiles
Copy link
Member

Choose a reason for hiding this comment

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

in terms of cleaning up the doc, @raych1 :

  • In which scenarios a service team will want to Generate Azure SDK for Go service packages in bulk ?
  • Because of how processes have changed, section Include a new package in the SDK should be removed too (this was added 7 years ago :| )

Copy link
Member

Choose a reason for hiding this comment

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

@tadelesh can you revisit the above instructions and update them accordingly if they are out of date?

Copy link
Member

Choose a reason for hiding this comment

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

i suggested to remove Generate Azure SDK for Go service packages in bulk, Include a new package in the SDK and Generate Azure SDK for Go profiles. they are all out of date. also, it seems Generate an Azure-SDK-for-Go service package is out of date, but needs @jhendrixMSFT to confirm.

Copy link
Member

Choose a reason for hiding this comment

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

Sorry I don't see this section in the diff. Is the name correct?

Copy link
Member Author

Choose a reason for hiding this comment

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

It's not part of the current diff https://github.com/Azure/azure-sdk-for-go/blob/main/documentation/code-generation.md#generate-an-azure-sdk-for-go-service-package

The question is whether it should be removed in this PR or not.

Copy link
Member

Choose a reason for hiding this comment

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

Got it. Yeah that's also out of date. Really it looks like that entire file needs to be rewritten.

Copy link
Member

@maririos maririos left a comment

Choose a reason for hiding this comment

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

As part of this effort, documentation should be improved to make sure we are guiding our customers to the right/updated process and avoid confusion as much as possible.
I added comments on other sections of the doc that can be removed/improved

Copy link
Member

@maririos maririos left a comment

Choose a reason for hiding this comment

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

Blocking until the document is updated with current information

@@ -94,3 +94,80 @@ generator –r –v –l=temp –version=v11.2.0-beta C:/azure-rest-api-specs/sp
## Generate Azure SDK for Go profiles
Copy link
Member

Choose a reason for hiding this comment

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

i suggested to remove Generate Azure SDK for Go service packages in bulk, Include a new package in the SDK and Generate Azure SDK for Go profiles. they are all out of date. also, it seems Generate an Azure-SDK-for-Go service package is out of date, but needs @jhendrixMSFT to confirm.

documentation/code-generation.md Show resolved Hide resolved
documentation/code-generation.md Outdated Show resolved Hide resolved
documentation/code-generation.md Outdated Show resolved Hide resolved
documentation/code-generation.md Show resolved Hide resolved
@maririos maririos self-requested a review December 10, 2024 15:23
@maririos
Copy link
Member

@chidozieononiwu I have removed my review as @tadelesh helped us figuring out which sections you should delete. When you are back from vacation and update this, I will be on mine. I didn't want to block your PR :)

@chidozieononiwu chidozieononiwu merged commit f32543f into Azure:main Dec 18, 2024
3 of 4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

5 participants