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.

Sign up for GitHub

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

Jump to bottom

Documentation Link for orag-go sdk is broken in the readme file #437

Closed
khanjasir90 opened this issue Feb 10, 2023 · 7 comments · Fixed by #438
Closed

Documentation Link for orag-go sdk is broken in the readme file #437

khanjasir90 opened this issue Feb 10, 2023 · 7 comments · Fixed by #438
Labels
documentation Improvements or additions to documentation

Comments

@khanjasir90
Copy link
Contributor

khanjasir90 commented Feb 10, 2023 •
edited
Loading

The documentation link for the oras-go sdk is broken and gives response of 404 page not found.
Link to the broken link in readme
@khanjasir90
Copy link
Contributor Author

@shizhMSFT i'll fix this up!

@shizhMSFT
Copy link
Contributor

Can you reference the code in the issue description?

@shizhMSFT shizhMSFT added the question Further information is requested label Feb 10, 2023
@khanjasir90
Copy link
Contributor Author

@shizhMSFT i have updated the issue description with the reference link to the broken docs url

@shizhMSFT
Copy link
Contributor

Thank @khanjasir90 for finding this. Since v2 succeeds the v1, the doc for v1 is no long available. Therefore, we can safely remove that line.

oras-go/README.md

Line 48 in 4a09c4d

- [oras.land/client_libraries/go](https://oras.land/client_libraries/go/): Documentation for the ORAS Go library

@khanjasir90
Copy link
Contributor Author

@shizhMSFT cool will do that! btw is there any link to the v2 sdk so that we can add it to the readme file

@shizhMSFT
Copy link
Contributor

Yes, it's there.

@TerryHowe
Copy link
Member

Might want to have a best practice in the docs site that if you move a file, provide a redirect

@khanjasir90 khanjasir90 mentioned this issue Feb 10, 2023
Merged
@shizhMSFT shizhMSFT added documentation Improvements or additions to documentation and removed question Further information is requested labels Feb 11, 2023
shizhMSFT pushed a commit that referenced this issue Feb 11, 2023
@khanjasir90
fix: broken go-sdk link in readme (#438)
f194a1e 
fix: #437 
Description: Updated link of oras-go in readme.md file

Signed-off-by: khanjasir90 <khanmohdjasir@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

fix: broken go-sdk link in readme khanjasir90/oras-go
3 participants
@TerryHowe @shizhMSFT @khanjasir90