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

Custom API documentation is missing #2204

Closed
kkashilk opened this issue Mar 27, 2023 · 2 comments · Fixed by #2351
Closed

Custom API documentation is missing #2204

kkashilk opened this issue Mar 27, 2023 · 2 comments · Fixed by #2351
Assignees
@sekyondaMeta
Labels
documentation Improvements or additions to documentation

Comments

@kkashilk
Copy link

kkashilk commented Mar 27, 2023 •
edited
Loading

📚 The doc issue

The serving sdk and plugins links are broken here - https://pytorch.org/serve/FAQs.html#how-can-i-add-a-custom-api-to-an-existing-framework

Steps to reproduce the behavior (if applicable):

  1. Go to https://pytorch.org/serve/FAQs.html#how-can-i-add-a-custom-api-to-an-existing-framework
  2. Click on serving sdk or plugins links
  3. See 404 error

Suggest a potential alternative/fix

Add info that's available here - https://github.com/pytorch/serve/tree/master/plugins
@msaroufim msaroufim added the documentation Improvements or additions to documentation label Mar 28, 2023
@lxning
Copy link
Collaborator

lxning commented Mar 28, 2023

@msaroufim i checked the links in FAQ . it works fine.

It seems https://pytorch.org/serve/FAQs.html#how-can-i-add-a-custom-api-to-an-existing-framework needs sync up. could you help?

@sekyondaMeta
Copy link
Contributor

@msaroufim Can you assign this issue to me. I might be able to fix it in the same way I did the others although this is a different issue.

@sekyondaMeta sekyondaMeta self-assigned this May 16, 2023
sekyondaMeta added a commit to sekyondaMeta/serve that referenced this issue May 17, 2023
@sekyondaMeta
FAQs Updates
24a59f4 
Updated a couple of broken links on the FAQ site per issue pytorch#2204
@sekyondaMeta sekyondaMeta mentioned this issue May 18, 2023
Merged
8 tasks
agunapal added a commit that referenced this issue May 22, 2023
@sekyondaMeta @lxning @agunapal
Fixing FAQs doc per issue #2204 (#2351)
4450287 
* Update index.md

Update to fix a broken link in index.md where the trailing .md is cut off from the management_api.md. Added an anchor link to force the .md to show up.

* Update to index.md

Update to index.md to fix several links ending in .md that sphinx is breaking. Added anchor links to each link and a corresponding anchor in the affected doc. Tested locally and seems to be working.

* Update inference_api.md

* Updated typos

Fixed typos and updated wordslist.txt

* Update wordlist.txt

* FAQs Updates

Updated a couple of broken links on the FAQ site per issue #2204

* updates to resolve links

* Update some links in index

Updated some links in index.md to go to the pytorch html page instead of github. This is a nicer fix for the .md sphinx issue

---------

Co-authored-by: sekyonda <7411+sekyonda@users.noreply.ghe.oculus-rep.com>
Co-authored-by: lxning <23464292+lxning@users.noreply.github.com>
Co-authored-by: Ankith Gunapal <agunapal@ischool.Berkeley.edu>
sekyondaMeta added a commit to sekyondaMeta/serve that referenced this issue May 31, 2023
@sekyondaMeta
FAQs Updates
d6d6c41 
Updated a couple of broken links on the FAQ site per issue pytorch#2204
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@sekyondaMeta sekyondaMeta

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Fixing FAQs doc per issue #2204 sekyondaMeta/serve
4 participants
@msaroufim @lxning @kkashilk @sekyondaMeta