search

opendatahub-io / opendatahub.io

http://opendatahub.io/
Creative Commons Attribution Share Alike 4.0 International
2 stars 47 forks source link

By default, it will not enable any component #186

Closed adelton closed 1 year ago

adelton commented 1 year ago

The 2.X installation instructions at https://opendatahub.io/docs/quick-installation-new-operator/ say about the Create DataScienceCluster operation:

in the components section, by clicking > it expands currently supported core components. To enable any component, specifically tick the box in each component section. By default, it will not enable any component.

However, with the 2.1.0 operator that I get from the OperatorHub today, I see the following enabled by default:

Should the documentation be updated, or is it incorrect that by default in the form view, these four are enabled?

VaishnaviHire commented 1 year ago

The default example ensures that the core components are set to enabled. Users can then opt out of installing those.

Note: The documentation for DatasciencCluster will be updated for ODH 1.10 release to reflect latest API changes - https://github.com/opendatahub-io/opendatahub-operator#example-datasciencecluster

adelton commented 1 year ago

So do you say that the installation instructions are not correct in stating "By default, it will not enable any component"?

Updates of the documentation for other releases seem like a separate topic. It might be useful to start staging documentation updates for that in draft pull requests though.

VaishnaviHire commented 1 year ago

Yep, I think a better wording would be The default example set core components as enabled. Users can unset the values if needed during the creation of DataScienceCluster.

However, we do want to also note, that by default if for a component the value for enabled is not set, it is set to be false.

Regarding the upcoming release, created a tracking issue https://github.com/opendatahub-io/opendatahub.io/issues/191

adelton commented 1 year ago

I've added https://github.com/opendatahub-io/opendatahub.io/pull/192 to fix the "by default, nothing is enabled" problem.

adelton commented 1 year ago

However, we do want to also note, that by default if for a component the value for enabled is not set, it is set to be false.

In the form view, there is no fiddling with the enabled text value.

If you think it makes sense to amend the YAML view section, please do it in separate PR. That section might also use a fresh screenshot to show all the components that the user can expect to find in the YAML by default, so there might be more work to be done for that case.

adelton commented 1 year ago

With https://github.com/opendatahub-io/opendatahub.io/pull/192 merged, this issue is resolved.