Azure / azure-sdk-for-java

This repository is for active development of the Azure SDK for Java. For consumers of the SDK we recommend visiting our public developer docs at https://docs.microsoft.com/java/azure/ or our versioned developer docs at https://azure.github.io/azure-sdk-for-java.
MIT License
2.35k stars 1.99k forks source link

[BUG] Storage v8.x README links are broken to v12 and javadocs #20137

Closed CaymanTurtleBeach closed 3 years ago

CaymanTurtleBeach commented 3 years ago

Describe the bug The links to 'Reference' in the table for Java storage libraries don't work (https://github.com/Azure/azure-storage-java). The e-mail address carefully encoded in the document that explains the need for V12.x is wrong (the link from the above page does go to the document). The effort that went into creating the document, and the potential goodwill it might have engendered, is completely squandered when basic information links don't work. This is so emblematic of my experiences over 3+ years of attempting serious development on Azure (functions, VMs, Spring Boot servers). Does anyone, anywhere, within Microsoft check anything any time? It seems all that Microsoft does is throw words together and publish them; accuracy, utility, usability be damned.

As an aside, which I have complained about in the past with respect to V8.x libraries, why does MS make Javadocs so hard to find (I have yet to find it for V12). Javadoc means something to Java programmers. Is it so hard to use that exact word to link to Javadoc documentation?? Every other phrase (link) with documentation in it points to MS pablum that may or may not be useful, but definitely is not Javadoc.

Exception or Stack Trace Add the exception log and stack trace if available

To Reproduce Go to https://github.com/Azure/azure-storage-java (by address, a seemingly top-level location for information about Java libraries) Click the 'Reference' link in the table for V12 libraries - get 404 read the explanatory document. look at the link at the end of the document.

Code Snippet Add the code snippet that causes the issue.

Expected behavior A clear and concise description of what you expected to happen.

Screenshots If applicable, add screenshots to help explain your problem.

Setup (please complete the following information):

Additional context Add any other context about the problem here.

Information Checklist Kindly make sure that you have added all the following information above and checkoff the required fields otherwise we will treat the issuer as an incomplete report

joshfree commented 3 years ago

Thanks for reporting this issue @CaymanTurtleBeach. @rickle-msft from the storage team can follow up with you shortly on the broken links on https://github.com/Azure/azure-storage-java.

For the v12 Javadocs, you can find them either by going to https://docs.microsoft.com/en-us/azure/developer/java/ and clicking "See more..." link on the far right under Azure SDK for Java, OR you can follow this https://aka.ms/azsdk link, click Java, then click the docs link next to any package.

Here's the MSDocs and Javadocs, respectively for Blob Storage (from https://aka.ms/azsdk)

https://docs.microsoft.com/en-us/java/api/overview/azure/storage-blob-readme?view=azure-java-stable

https://azuresdkdocs.blob.core.windows.net/$web/java/azure-storage-blob/12.10.1/index.html

rickle-msft commented 3 years ago

@CaymanTurtleBeach Thank you notifying us about these broken links. I have updated the documents you mentioned to reflect the most recent status

CaymanTurtleBeach commented 3 years ago

Thank you for the links. Does not the sheer number suggest things are a bit complex? In particular, figuring out how to get from top-level pages directly to the detail links you provided.

I do recall stumbling onto the https://azure.github.io/azure-sdk/ page, but I had no idea what MSDOCS or GHDOCS referred to (until last night I had never encountered those two terms), and by that time I was pretty fed up with clicking links and not finding what I needed.

Jack


Jack Copper Managing Director NeuralStudio SEZC

Cayman Enterprise City PO Box 10315, 90 N Church St Grand Cayman KY1-1003 Cayman Islands https://neuralstudio.ai

Direct: +1 (345) 815-3930 Mobile: +1 (345) 925-8459

Mobile: +1 (412) 801-2715 (US and International)

SKYPE: jack-copper


This communication is for use by the intended recipient(s) only and contains information that may be privileged, confidential or copyrighted under applicable law. If you are not an intended recipient, you are hereby formally notified that any use, copying or distribution of this e-mail, in whole or in part, is strictly prohibited. Please notify the sender by return e-mail and delete this e-mail from your system. This e-mail does not constitute a consent to the use of sender's contact information for marketing purposes or for transfers of data to third parties.



From: Josh Free @.> Sent: Friday, March 26, 2021 11:34 AM To: Azure/azure-sdk-for-java @.> Cc: Jack Copper @.>; Mention @.> Subject: Re: [Azure/azure-sdk-for-java] [BUG] Storage v8.x README links are broken to v12 and javadocs (#20137)

Thanks for reporting this issue @CaymanTurtleBeachhttps://github.com/CaymanTurtleBeach. @rickle-msfthttps://github.com/rickle-msft from the storage team can follow up with you shortly on the broken links on https://github.com/Azure/azure-storage-java.

For the v12 Javadocs, you can find them either by going to https://docs.microsoft.com/en-us/azure/developer/java/ and clicking "See more..." link on the far right under Azure SDK for Java, OR you can follow this https://aka.ms/azsdk link, click Java, then click the docs link next to any package.

Here's the MSDocs and Javadocs, respectively for Blob Storage (from https://aka.ms/azsdk)

https://docs.microsoft.com/en-us/java/api/overview/azure/storage-blob-readme?view=azure-java-stable

https://azuresdkdocs.blob.core.windows.net/$web/java/azure-storage-blob/12.10.1/index.html

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHubhttps://github.com/Azure/azure-sdk-for-java/issues/20137#issuecomment-808314832, or unsubscribehttps://github.com/notifications/unsubscribe-auth/ATC2MGQMQZ7IH72C7DNLREDTFSSPHANCNFSM4Z2JSYNQ.

CaymanTurtleBeach commented 3 years ago

@rickle-msft Aren't you one of the developers or architects of the storage libraries? With all the employees MS has, why isn't there someone in the group whose only responsibility every hour, every day, is documentation. I appreciate that you have plenty of development to do.

Jack


Jack Copper Managing Director NeuralStudio SEZC

Cayman Enterprise City PO Box 10315, 90 N Church St Grand Cayman KY1-1003 Cayman Islands https://neuralstudio.ai

Direct: +1 (345) 815-3930 Mobile: +1 (345) 925-8459

Mobile: +1 (412) 801-2715 (US and International)

SKYPE: jack-copper


This communication is for use by the intended recipient(s) only and contains information that may be privileged, confidential or copyrighted under applicable law. If you are not an intended recipient, you are hereby formally notified that any use, copying or distribution of this e-mail, in whole or in part, is strictly prohibited. Please notify the sender by return e-mail and delete this e-mail from your system. This e-mail does not constitute a consent to the use of sender's contact information for marketing purposes or for transfers of data to third parties.



From: Rick Ley @.> Sent: Friday, March 26, 2021 12:44 PM To: Azure/azure-sdk-for-java @.> Cc: Jack Copper @.>; Mention @.> Subject: Re: [Azure/azure-sdk-for-java] [BUG] Storage v8.x README links are broken to v12 and javadocs (#20137)

@CaymanTurtleBeachhttps://github.com/CaymanTurtleBeach Thank you notifying us about these broken links. I have updated the documents you mentioned to reflect the most recent status

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHubhttps://github.com/Azure/azure-sdk-for-java/issues/20137#issuecomment-808363698, or unsubscribehttps://github.com/notifications/unsubscribe-auth/ATC2MGSVYVFQKKQAHBW4IP3TFS2VBANCNFSM4Z2JSYNQ.

gapra-msft commented 3 years ago

Hi @CaymanTurtleBeach

Thank you again for reporting this issue. We understand it can be frustrating when link are broken. If you do hit any more issues in the future, please feel free to open more issues on the page and we are happy to help out.

Closing this particular issue as it looks like it has been resolved. Please reopen in case I'm mistaken.