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

Fix broken and/or missing links in the documentation #1743

Merged
merged 33 commits into from
May 19, 2020
Merged

Fix broken and/or missing links in the documentation #1743

merged 33 commits into from
May 19, 2020

Conversation

ozturkberkay
Copy link
Contributor

Hi,

This PR fixes many broken links across the documentation. Sorry for the unnecessary amounts of commits, I did not expect such amount of broken links when I started; the list just kept getting bigger :)

Note: There are still many other broken links in the documentation. These are the ones I could fix.

@ozturkberkay
Fix index links
e29f9ea 
Fixes the link for online community calls.
@ozturkberkay
Fix quickstart links
1debe5c 
Fixes missing and broken links.
@ozturkberkay
Fix install links and formatting
18f4a51 
Fixes links and makes tiny formatting adjustments.
@ozturkberkay
Fix and format PVC with TFJob example
9824784 
Fixes the broken notebook.
@ozturkberkay
Fix servers overview formatting
53ba389 
Applies a minor replacement to a redundant text.
@ozturkberkay
Fix language_wrappers links and formatting
8880b96 
Fixes minor link and formatting issues.
@ozturkberkay
Fix python_wrapping_s2i links
0cdeb9c 
Fixes broken links.
@ozturkberkay
Fix python_wrapping_s2i custom metrics link
d82259b 
Fixes the link to custom metrics API.
@ozturkberkay
Fix python_wrapping_docker links
03e1450 
Fixes broken links.
@ozturkberkay
Fix seldon_client links
0eaa6fd 
Fixes broken link to Seldon Core examples.
@ozturkberkay
Fix java/README links
2494a92 
Fixes a broken link to skeleton code.
@ozturkberkay
Fix R README links
2b6507b 
Fixes broken links to skeleton codes.
@ozturkberkay
Fix ambassador links
a811fd7 
Fixes a link to Ambassador docs.
@ozturkberkay
Fix routers links
76c73d3 
Fixes a broken link to internal API.
@ozturkberkay
Fix mlflow notebook links
deb89da 
Fixes broken links and formatting errors in `mlflow_server_ab_test_ambassador.ipynb`.
@ozturkberkay
Fix sagemaker notebook links
ebdf4d7 
Fixes broken links.
@ozturkberkay
Fix tfserving notebook links
246fc7b 
Fixes broken links.
@ozturkberkay
Fix nvidia_mnist notebook links
692af12 
Fixes broken links.
@ozturkberkay
Fix openvino notebook links
f113773 
Fixes broken links.
@ozturkberkay
Fix openvino_imagenet_ensemble notebook links
530ca8e 
Fixes broken links and formatting.
@ozturkberkay
Fix h2o_model notebook links
7223b16 
Fixes broken links and formatting.
@ozturkberkay
Fix alibi-detect-combiner notebook links
f997fc9 
Replaces relative links with full URLs to allow access from the documentation.
@ozturkberkay
Fix alibaba_cloud_ack_deep_mnist notebook links
4cbe524 
Fixes the broken link to docs.
@ozturkberkay
Fix explainer_examples notebook links
dfb6a72 
Fixes broken links and formatting.
@ozturkberkay
Fix autoscaling_example links
21f0aaf 
Fixes broken links.
@ozturkberkay
Fix sig-mlops-jenkins-classic README links
8f712c5 
Making sure links can be accessed via online docs.
@ozturkberkay
Fix seldon_custom_server_README notebook links
97dffa2 
Fixes broken links.
@ozturkberkay
Fix ambassador_canary notebook links
5b303c5 
Fixes broken links.
@ozturkberkay
Fix ambassador_shadow notebook links
6672fe3 
Fixes broken links.
@ozturkberkay
Fix ambassador_headers links
b8bd2e7 
Fixes broken links.
@ozturkberkay
Fix ambassador_custom notebook links
8e130f9 
Fixes broken links.
@ozturkberkay
Fix canary notebook links
1c9227a 
Fixes broken links.
@ozturkberkay
Fix blog links.
886692d 
Fixes broken links.
@review-notebook-app
Copy link

Check out this pull request on  ReviewNB

You'll be able to see Jupyter notebook diff and discuss changes. Powered by ReviewNB.

@seldondev
Copy link
Collaborator

Hi @ozturkberkay. Thanks for your PR.

I'm waiting for a SeldonIO member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@ozturkberkay
Copy link
Contributor Author

/assign @cliveseldon

@ozturkberkay ozturkberkay changed the title Doc fixes Fix broken and/or missing links in the documentation Apr 26, 2020
@ukclivecox
Copy link
Contributor

Thanks @ozturkberkay this is really great.
Will add comments inline.

ukclivecox
ukclivecox suggested changes Apr 26, 2020
View reviewed changes
doc/source/python/python_wrapping_docker.md
@@ -200,9 +200,9 @@ class MyModel(object):
return [{"type": "COUNTER", "key": "mycounter", "value": 1}]
```

For more details on custom metrics and the format of the metric dict see [here](../custom_metrics.md).
For more details on custom metrics and the format of the metric dict see [here](https://docs.seldon.io/projects/seldon-core/en/latest/analytics/analytics.html#custom-metrics).
Copy link
Contributor

Choose a reason for hiding this comment

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

Can we try to ensure all internal docs links remain relative as that ensures they will link to the same version when published wheras the above external link would move people to the latest version.

@adriangonz adriangonz mentioned this pull request May 7, 2020
Closed
@axsaucedo axsaucedo mentioned this pull request May 19, 2020
Closed
@axsaucedo
Copy link
Contributor

We decided to merge this and open #1851 to address the issue with relative links
/approve

@axsaucedo axsaucedo merged commit 990a565 into SeldonIO:master May 19, 2020
@seldondev
Copy link
Collaborator

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: axsaucedo

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@seldondev
Copy link
Collaborator

failed to trigger Pull Request pipeline

  • failed to create agent
  • failed to calculate in repo config
  • failed to load trigger config for repository SeldonIO/seldon-core for ref 886692d
  • failed to find any lighthouse configuration files in repo SeldonIO/seldon-core at sha 886692d
  • failed to process repo SeldonIO/seldon-core refref 886692d
  • failed to list files in directory /var/tmp/gitrepo660600678/.lighthouse
  • open /var/tmp/gitrepo660600678/.lighthouse
  • no such file or directory

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@RafalSkolasinski RafalSkolasinski RafalSkolasinski left review comments

@ukclivecox ukclivecox ukclivecox requested changes

Assignees
No one assigned
Labels
approved needs-ok-to-test size/L
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@ozturkberkay @seldondev @ukclivecox @axsaucedo @RafalSkolasinski