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

Fix dead links in docs and add linter #2538

Merged
merged 20 commits into from
Oct 9, 2020

Conversation

adriangonz
Copy link
Contributor

What this PR does / why we need it:
Fix most warnings thrown by Sphinx, some dead links, and upgrade the versions of the docs' dependencies. This PR also adds a /docs command which runs some linters on the docs and also crawls all external links to verify they are working.

Which issue(s) this PR fixes:

Fixes #1760

Special notes for your reviewer:

  • The external link crawling is a bit heavy, so we probably can't run it on every PR. That's why I've split into a separate /docs command.
  • I've replaced all links between notebooks outside of the /doc folder for absolute links to the Seldon Core docs. This is to work around a limitation on nbsphinx-link.
  • I've removed all notebooks' static assets from the /doc folder to use instead the extra-media key on the nblink file.

Does this PR introduce a user-facing change?:

NONE

@review-notebook-app
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@adriangonz adriangonz changed the title Docs housekeeping Fix dead links in docs and add linter Oct 8, 2020
@seldondev
Copy link
Collaborator

Thu Oct 8 16:47:08 UTC 2020
The logs for [lint] [2] will show after the pipeline context has finished.
https://github.com/SeldonIO/seldon-core/blob/gh-pages/jenkins-x/logs/SeldonIO/seldon-core/PR-2538/2.log

impatient try
jx get build logs SeldonIO/seldon-core/PR-2538 --build=2

@seldondev
Copy link
Collaborator

Thu Oct 8 16:47:23 UTC 2020
The logs for [pr-build] [1] will show after the pipeline context has finished.
https://github.com/SeldonIO/seldon-core/blob/gh-pages/jenkins-x/logs/SeldonIO/seldon-core/PR-2538/1.log

impatient try
jx get build logs SeldonIO/seldon-core/PR-2538 --build=1

@seldondev
Copy link
Collaborator

Thu Oct 8 16:59:13 UTC 2020
The logs for [pr-build] [3] will show after the pipeline context has finished.
https://github.com/SeldonIO/seldon-core/blob/gh-pages/jenkins-x/logs/SeldonIO/seldon-core/PR-2538/3.log

impatient try
jx get build logs SeldonIO/seldon-core/PR-2538 --build=3

@seldondev
Copy link
Collaborator

Thu Oct 8 16:59:17 UTC 2020
The logs for [lint] [4] will show after the pipeline context has finished.
https://github.com/SeldonIO/seldon-core/blob/gh-pages/jenkins-x/logs/SeldonIO/seldon-core/PR-2538/4.log

impatient try
jx get build logs SeldonIO/seldon-core/PR-2538 --build=4

@adriangonz
Copy link
Contributor Author

/test docs

@seldondev
Copy link
Collaborator

Thu Oct 8 17:06:08 UTC 2020
The logs for [pr-build] [5] will show after the pipeline context has finished.
https://github.com/SeldonIO/seldon-core/blob/gh-pages/jenkins-x/logs/SeldonIO/seldon-core/PR-2538/5.log

impatient try
jx get build logs SeldonIO/seldon-core/PR-2538 --build=5

@seldondev
Copy link
Collaborator

Thu Oct 8 17:06:08 UTC 2020
The logs for [lint] [6] will show after the pipeline context has finished.
https://github.com/SeldonIO/seldon-core/blob/gh-pages/jenkins-x/logs/SeldonIO/seldon-core/PR-2538/6.log

impatient try
jx get build logs SeldonIO/seldon-core/PR-2538 --build=6

@seldondev
Copy link
Collaborator

Thu Oct 8 17:09:13 UTC 2020
The logs for [docs] [7] will show after the pipeline context has finished.
https://github.com/SeldonIO/seldon-core/blob/gh-pages/jenkins-x/logs/SeldonIO/seldon-core/PR-2538/7.log

impatient try
jx get build logs SeldonIO/seldon-core/PR-2538 --build=7

@adriangonz
Copy link
Contributor Author

/cc @cliveseldon @axsaucedo @RafalSkolasinski

@axsaucedo
Copy link
Contributor

This is great! Looks good! Seems there may need to be a small change on the image as build looks like pandoc is missing, but other than that looks great!

@adriangonz
Copy link
Contributor Author

@axsaucedo good spot! I've now pushed a new version of the image.

@seldondev
Copy link
Collaborator

Fri Oct 9 11:17:10 UTC 2020
The logs for [pr-build] [8] will show after the pipeline context has finished.
https://github.com/SeldonIO/seldon-core/blob/gh-pages/jenkins-x/logs/SeldonIO/seldon-core/PR-2538/8.log

impatient try
jx get build logs SeldonIO/seldon-core/PR-2538 --build=8

@seldondev
Copy link
Collaborator

Fri Oct 9 11:17:22 UTC 2020
The logs for [lint] [9] will show after the pipeline context has finished.
https://github.com/SeldonIO/seldon-core/blob/gh-pages/jenkins-x/logs/SeldonIO/seldon-core/PR-2538/9.log

impatient try
jx get build logs SeldonIO/seldon-core/PR-2538 --build=9

@adriangonz
Copy link
Contributor Author

/test docs

@seldondev
Copy link
Collaborator

Fri Oct 9 11:20:16 UTC 2020
The logs for [docs] [10] will show after the pipeline context has finished.
https://github.com/SeldonIO/seldon-core/blob/gh-pages/jenkins-x/logs/SeldonIO/seldon-core/PR-2538/10.log

impatient try
jx get build logs SeldonIO/seldon-core/PR-2538 --build=10

@adriangonz
Copy link
Contributor Author

/test docs

@seldondev
Copy link
Collaborator

Fri Oct 9 13:02:35 UTC 2020
The logs for [lint] [12] will show after the pipeline context has finished.
https://github.com/SeldonIO/seldon-core/blob/gh-pages/jenkins-x/logs/SeldonIO/seldon-core/PR-2538/12.log

impatient try
jx get build logs SeldonIO/seldon-core/PR-2538 --build=12

@seldondev
Copy link
Collaborator

Fri Oct 9 13:02:50 UTC 2020
The logs for [pr-build] [11] will show after the pipeline context has finished.
https://github.com/SeldonIO/seldon-core/blob/gh-pages/jenkins-x/logs/SeldonIO/seldon-core/PR-2538/11.log

impatient try
jx get build logs SeldonIO/seldon-core/PR-2538 --build=11

@seldondev
Copy link
Collaborator

Fri Oct 9 13:03:52 UTC 2020
The logs for [docs] [13] will show after the pipeline context has finished.
https://github.com/SeldonIO/seldon-core/blob/gh-pages/jenkins-x/logs/SeldonIO/seldon-core/PR-2538/13.log

impatient try
jx get build logs SeldonIO/seldon-core/PR-2538 --build=13

@axsaucedo
Copy link
Contributor

/approve

@axsaucedo
Copy link
Contributor

@adriangonz seems there are some merge conflicts, but other than that should be good to go

@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

Fri Oct 9 16:27:38 UTC 2020
The logs for [lint] [15] will show after the pipeline context has finished.
https://github.com/SeldonIO/seldon-core/blob/gh-pages/jenkins-x/logs/SeldonIO/seldon-core/PR-2538/15.log

impatient try
jx get build logs SeldonIO/seldon-core/PR-2538 --build=15

@seldondev
Copy link
Collaborator

Fri Oct 9 16:27:53 UTC 2020
The logs for [pr-build] [14] will show after the pipeline context has finished.
https://github.com/SeldonIO/seldon-core/blob/gh-pages/jenkins-x/logs/SeldonIO/seldon-core/PR-2538/14.log

impatient try
jx get build logs SeldonIO/seldon-core/PR-2538 --build=14

@seldondev seldondev merged commit 2e62a3a into SeldonIO:master Oct 9, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Fix broken documentation links
3 participants