Skip to content
This repository has been archived by the owner on Nov 1, 2022. It is now read-only.

Fix link-checking and a number of links #347

Merged
merged 3 commits into from
Apr 29, 2020
Merged

Fix link-checking and a number of links #347

merged 3 commits into from
Apr 29, 2020

Conversation

dholbach
Copy link
Member

@dholbach dholbach commented Mar 30, 2020 •
edited
Loading

  • Improve link checking
  • fix a number of links
  • update theme

@dholbach dholbach added the docs Issue or PR related to documentation label Mar 30, 2020
@dholbach dholbach mentioned this pull request Mar 30, 2020
Merged
@dholbach
Copy link
Member Author

dholbach commented Apr 3, 2020

@stefanprodan @hiddeco Not sure how to proceed here. Shall I split the PR into 1) fixed links and 2) link checking and we take some more time to figure out the broken links in the 404 document?

@hiddeco
Copy link
Member

hiddeco commented Apr 3, 2020

Yes, please split the PR so we can take the proper time to address the CI-part.

@dholbach dholbach mentioned this pull request Apr 3, 2020
Merged
@dholbach
Copy link
Member Author

dholbach commented Apr 3, 2020

Moved fixing the links to #356

@dholbach dholbach force-pushed the fix-links branch 3 times, most recently from 5459f81 to 544853f Compare April 7, 2020 15:56
@dholbach dholbach force-pushed the fix-links branch 2 times, most recently from 736ff63 to 267ecc5 Compare April 14, 2020 06:31
@dholbach
Copy link
Member Author

@hiddeco @stefanprodan I'm getting closer on finishing this. To me it somehow looks like the 404.html site generation is busted.

@dholbach dholbach force-pushed the fix-links branch 2 times, most recently from eca1a42 to ba2c78e Compare April 28, 2020 14:21
@dholbach
Copy link
Member Author

The tests pass now, but https://test-helm-op.readthedocs.io/en/latest/missing is still busted. :-(

@dholbach
Copy link
Member Author

To confirm locally:

pip3 install -r docs/requirements.txt
mkdocs build -c -s && firefox site/404.html

@dholbach dholbach marked this pull request as ready for review April 28, 2020 15:29
@dholbach dholbach changed the title Fix link-checking Fix link-checking and a number of links Apr 28, 2020
@dholbach dholbach requested a review from hiddeco April 28, 2020 15:30
@dholbach
Copy link
Member Author

I suggest merging this - it's been sitting there long enough. It's an improvement - let's take a look at the 404 separately.

hiddeco
hiddeco reviewed Apr 28, 2020
View reviewed changes
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Daniel Holbach added 2 commits April 29, 2020 09:56
fix link-checking (follow fluxcd/flux#2956)
d364b89 
	move back to upstream GH action
	update pymdown-extensions
	update to mkdocs-material 5: https://squidfunk.github.io/mkdocs-material/releases/5/#how-to-upgrade
	fix links
	follow fluxcd/flux#3006
	parallelise checking
try out dropping site_url
e11078d
@dholbach
Copy link
Member Author

Thanks for the review @hiddeco !

@dholbach dholbach requested a review from hiddeco April 29, 2020 07:59
@dholbach dholbach merged commit 4f9616e into master Apr 29, 2020
@dholbach dholbach deleted the fix-links branch April 29, 2020 08:46
@hiddeco hiddeco added this to the 1.1.0 milestone May 21, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@hiddeco hiddeco hiddeco approved these changes

@stefanprodan stefanprodan Awaiting requested review from stefanprodan

Assignees
No one assigned
Labels
docs Issue or PR related to documentation
Projects
None yet
Milestone
1.1.0
Development

Successfully merging this pull request may close these issues.
2 participants
@dholbach @hiddeco