pelorus icon indicating copy to clipboard operation
pelorus copied to clipboard

Consider using openAPIV3Schema to generate config options / clean up README files

Open mpryc opened this issue 2 years ago • 1 comments

          We do switch to the Opeator based installation. All supported by the operator options are now documented and available via docs:
  • https://pelorus.readthedocs.io/en/latest/GettingStarted/configuration/PelorusCore/
  • https://pelorus.readthedocs.io/en/latest/GettingStarted/configuration/ExporterDeploytime/
  • https://pelorus.readthedocs.io/en/latest/GettingStarted/configuration/ExporterCommittime/
  • https://pelorus.readthedocs.io/en/latest/GettingStarted/configuration/ExporterFailure/

We will be reviewing and removing unnecessary README files from the source code, so we have only one set of configuration options.

Also our operator uses openAPIV3Schema to define our options and best would be to auto-generate the docs from that part, but this isn't something this issue is for: https://github.com/konveyor/pelorus/blob/master/pelorus-operator/config/crd/bases/charts.pelorus.konveyor.io_pelorus.yaml#L17

Closing as this is not relevant for the current operator.

Originally posted by @mpryc in https://github.com/konveyor/pelorus/issues/234#issuecomment-1401803185

mpryc avatar Jan 24 '23 11:01 mpryc

related to https://github.com/dora-metrics/pelorus/issues/884

mateusoliveira43 avatar Apr 05 '23 18:04 mateusoliveira43