search

operator-framework / olm-docs

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

Docs rewrite #147

Closed anik120 closed 3 years ago

anik120 commented 3 years ago

This PR overhauls the Getting started and the Core tasks section of the documentation. It also adds previously missing documentation on CatalogSource polling feature and information on CatalogSource spec.secrets field. Closes #145 #108

openshift-ci-robot commented 3 years ago

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: anik120

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: - ~~[OWNERS](https://github.com/operator-framework/olm-docs/blob/master/OWNERS)~~ [anik120] Approvers can indicate their approval by writing `/approve` in a comment Approvers can cancel approval by writing `/approve cancel` in a comment
anik120 commented 3 years ago

The link checker is failing with the following error: 

htmlproofer 3.15.0 | Error:  HTML-Proofer found 4 failures!
  *  External link https://github.com/operator-framework/olm-docs/edit/master/content/en/docs/Concepts/olm-architecture/operator-catalog/creating-an-update-graph.md failed: 404 No error
- /target/docs/tasks/creating-an-index/index.html
  *  External link https://github.com/operator-framework/olm-docs/edit/master/content/en/docs/Tasks/creating-an-index.md failed: 404 No error
- /target/docs/tasks/install-operator-with-olm/index.html
  *  internally linking to channel-def, which does not exist (line 678)
     <a href="channel-def">channel</a>
- /target/docs/tasks/make-index-available-on-cluster/index.html
  *  External link https://github.com/operator-framework/olm-docs/edit/master/content/en/docs/Tasks/make-index-available-on-cluster.md failed: 404 No error

This is probably because these are new docs being introduced so once these docs become available on the site the next PR will not see the same error messages.