OLM docs in the repo project

[camilamacedo86]

Feature Request

Is your feature request related to a problem? Please describe.

Shows that the docs has been another repo: https://github.com/operator-framework/olm-docs. However, should not an RFE/Issue also be merged with its docs? Is not it doing harder the work to contribute with the docs? Following some problems faced with:

• Shows harder ask for docs in the review since is required to do another PR for another repo and then, if something needs to be reverted instead of the doc changes be reverted with the changes made then is required to remember and find the specific pr in another place.
• Shows very confuse for contributors required to know that should open an issue for the docs in another place instead of its repo.
• It is not possible to create relative paths for the code when they need to be referenced in the docs for it be aligned with the release versions automatically.
• The docs are not aligned with the releases and then, it is hard to know how something works for some specific release since it has only the latest versions.

Describe the solution you'd like

I think would be easier to keep the docs maintained and feed the docs if they are in the project repo such as it are provided in SDK. In this way, the above-raised scenarios would be also solved. See https://github.com/operator-framework/operator-sdk/tree/master/website.

Also, it might help to promote and encourage contributions on the docs as well.

[camilamacedo86]

/kind document

[openshift-ci-robot]

@camilamacedo86: The label(s) kind/document cannot be applied, because the repository doesn't have them

In response to this:

/kind document

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.

[camilamacedo86]

After speaking with @anik Bhattacharjee.
Shows that it is the plan in short/medium term already.
so, I am closing this one.