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

[Storage] Updates to the Storage Overview page in reference docs #4728

Closed
HarshaNalluru opened this issue Aug 9, 2019 · 16 comments · Fixed by MicrosoftDocs/azure-docs-sdk-node#672
Assignees
Labels
Client This issue points to a problem in the data-plane of the library. Docs Storage Storage Service (Queues, Blobs, Files)

Comments

@HarshaNalluru
Copy link
Member

Following docs refer to azure-storage package.
https://review.docs.microsoft.com/en-us/javascript/api/overview/azure/storage?view=azure-node-preview&branch=master

Should be updated to V10 storage packages (and V12) (Update https://github.com/MicrosoftDocs/azure-docs-sdk-node/blob/master/docs-ref-services/storage.md)

@HarshaNalluru HarshaNalluru added Client This issue points to a problem in the data-plane of the library. Storage Storage Service (Queues, Blobs, Files) labels Aug 9, 2019
@triage-new-issues triage-new-issues bot removed the triage label Aug 9, 2019
@ramya-rao-a
Copy link
Contributor

@maggiepint, @kaerm Can either of you pick this up?

@ramya-rao-a ramya-rao-a changed the title [Storage] Azure Storage modules for Node.js - Docs [Storage] Azure Storage modules for Node.js - Docs to be updated to v12 Nov 5, 2019
@ramya-rao-a ramya-rao-a assigned kaerm and aagup and unassigned aagup Nov 17, 2019
@ramya-rao-a
Copy link
Contributor

Update:

@ramya-rao-a ramya-rao-a changed the title [Storage] Azure Storage modules for Node.js - Docs to be updated to v12 [Storage] Updates to the Storage Overview page in reference docs Nov 17, 2019
@ramya-rao-a
Copy link
Contributor

Also, all the samples link in the overview page are broken leading to 404

Screen Shot 2019-11-17 at 3 23 00 PM

@kaerm
Copy link
Contributor

kaerm commented Nov 18, 2019

Thanks! The content team is aware of it and should be getting to it soon

@ramya-rao-a ramya-rao-a added this to the [2019] December milestone Nov 19, 2019
@ramya-rao-a
Copy link
Contributor

Any updates on this @kaerm?

@kaerm
Copy link
Contributor

kaerm commented Dec 6, 2019

Content team is busy updating other documents but I believe @maggiepint volunteered for that one

@ramya-rao-a
Copy link
Contributor

@kaerm, @maggiepint The above samples links continue to lead to 404

@ramya-rao-a
Copy link
Contributor

@HarshaNalluru Let's fix this on our own :)
Below are some pointers:

@ramya-rao-a ramya-rao-a assigned HarshaNalluru and unassigned maggiepint and kaerm Jan 15, 2020
@ramya-rao-a
Copy link
Contributor

On second thoughts, it seems redundant to have code snippets both here and maintain them on the package readmes.

How about having a 1 line description under the Client and the Management headers. Then add the list of packages available as links. The links should go to the npm package.

@kaerm
Copy link
Contributor

kaerm commented Jan 15, 2020

shouldn't the links go to our README? Maybe the best way is to copy the table that Java has https://github.com/Azure/azure-docs-sdk-java/blob/master/docs-ref-services/storage.md

could be in a form of simple links or having individual storage libraries (queue, blob) listed for each row

@ramya-rao-a
Copy link
Contributor

The npm package link is our readme.
For example: https://www.npmjs.com/package/@azure/storage-blob

I like the table of available libraries, but I would very much like to avoid having any code snippets at this leve

@kaerm
Copy link
Contributor

kaerm commented Jan 15, 2020

Right, I know. I am definitely happy with not maintaining code but it would be good to have links to npm, samples, QS, source

@HarshaNalluru
Copy link
Member Author

HarshaNalluru commented Jan 16, 2020

image

How does it look? Opened a draft PR here - MicrosoftDocs/azure-docs-sdk-node#672

Disclaimer: I don't have the links for the #ToBeAdded placeholders.

@ramya-rao-a
Copy link
Contributor

I would skip the column for the source code.
Source code link is available from the npm landing page.

Is the getting started meant for links to Quick starts?

Change column header NPM link to Package or NPM package

@kaerm
Copy link
Contributor

kaerm commented Jan 16, 2020

Added comments in the PR

@HarshaNalluru
Copy link
Member Author

HarshaNalluru commented Jan 16, 2020

Is the getting started meant for links to Quick starts?

@ramya-rao-a, yes. You'd like a rename?
Moreover... Currently, it has been written only for the blob package.

Now..
image

Updated rest of the feedback in the PR, let's continue over there.
PR - MicrosoftDocs/azure-docs-sdk-node#672

@github-actions github-actions bot locked and limited conversation to collaborators Apr 12, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Client This issue points to a problem in the data-plane of the library. Docs Storage Storage Service (Queues, Blobs, Files)
Projects
None yet
5 participants