operator-framework / olm-docs

Hugo doc site for https://github.com/operator-framework/operator-lifecycle-manager
10 stars 82 forks source link

content: Fix broken links and internal links not resolving #101

Closed timflannagan closed 3 years ago

timflannagan commented 3 years ago

Update the content/* documentation and update any broken links that the CI linting hack script was exposing:

docker run --rm -v olm-html:/target mtlynch/htmlproofer /target --empty-alt-ignore --http-status-ignore 429 --allow_hash_href
Running ["ScriptCheck", "ImageCheck", "LinkCheck"] on ["/target"] on *.html... 

Checking 149 external links...
Ran on 43 files!

- /target/about/index.html
  *  External link https://sdk.operatorframework.io/docs/installation/install-operator-sdk failed: 404 No error
  *  External link https://sdk.operatorframework.io/docs/installation/install-operator-sdk/ failed: 404 No error
  *  External link https://sdk.operatorframework.io/docs/installation/install-operator-sdk/#compile-and-install-from-master failed: 404 No error
  *  External link https://sdk.operatorframework.io/docs/installation/install-operator-sdk/#install-from-github-release failed: 404 No error
  *  External link https://sdk.operatorframework.io/docs/installation/install-operator-sdk/#install-from-homebrew-macos failed: 404 No error
- /target/docs/tasks/creating-operator-manifests/index.html
  *  internally linking to /docs/Concepts/olm-architecture/dependency-resolution, which does not exist (line 816)
     <a href="/docs/Concepts/olm-architecture/dependency-resolution">Concepts section</a>
htmlproofer 3.15.0 | Error:  HTML-Proofer found 6 failures!

The operator-sdk installation docs have deflated the */installation/install-operator-sdk to */installation which was producing those 404 errors when referencing external links.

The path to the dependency-resolution documentation needed to be updated to use the correct directory from the creating operator manifests documentation path.

anik120 commented 3 years ago

/lgtm thanks for fixing this @timflannagan1