search

operator-framework / olm-docs

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

README,hack: Update the linting script and add instructions for running locally #100

Closed timflannagan closed 3 years ago

timflannagan commented 3 years ago

Update the hack/ci/lint-check.sh script and expose an environment variable that injects extra container run options. This is particularly useful in the case you want to run this as a privileged container, or you want to disable any selinux permissions.

Update the README and give a brief description of what the linting script is trying to accomplish and add a note about disabling selinux permissions if you're getting permission denied errors when attempting to mount the volume when building the site.

timflannagan commented 3 years ago

CC @anik120

timflannagan commented 3 years ago

/test all

openshift-ci-robot commented 3 years ago

@timflannagan1: No presubmit jobs available for operator-framework/olm-docs@master

In response to [this](https://github.com/operator-framework/olm-docs/pull/100#issuecomment-770012275): >/test all Instructions for interacting with me using PR comments are available [here](https://git.k8s.io/community/contributors/guide/pull-requests.md). If you have questions or suggestions related to my behavior, please file an issue against the [kubernetes/test-infra](https://github.com/kubernetes/test-infra/issues/new?title=Prow%20issue:) repository.
anik120 commented 3 years ago

@timflannagan1 regarding the guidelines for running the link checker locally, we have a contribution guideline here: https://github.com/operator-framework/olm-docs/tree/master/content/en/docs/contribution-guidelines

Having two different source for contribution guidelines, one as the repo README, and one as the website contribution-guidelines looks like will lead us into the familiar road of information discrepancy.

It's probably time to update the README to just state what OF and OLM are about, what this repo is for (doc site for OLM), and then finally a link to https://github.com/operator-framework/olm-docs/tree/master/content/en/docs/contribution-guidelines from the repo README, where the changes introduced by this PR should go.