Fix numerous doc issues #651
Conversation
Signed-off-by: Anatolii Bazko <[email protected]>
tolusha
requested review from
AndrienkoAleksandr,
flacatus,
mmorhun and
nickboldt
as code owners
pkg/apis/org/v1/che_types.go
Outdated
| // +optional | ||
| DevfileRegistryURL string `json:"devfileRegistryURL"` | ||
| // Public URL to the Plugin registry | ||
| // Public URL to the Plugin registry. |
There was a problem hiding this comment.
Maybe "Plugin" should start with lowercase too?
| // If both are defined, `serverExposureStrategy` takes precedence. | ||
| // Strategy for ingress creation. Options are: `multi-host` (host is explicitly provided in ingress), | ||
| // `single-host` (host is provided, path-based rules) and `default-host` (no host is provided, path-based rules). | ||
| // Defaults to `multi-host` Deprecated in favor of `serverExposureStrategy` in the `server` section, |
There was a problem hiding this comment.
Defaults to
multi-host
Should this sentence end with point '.' ?
There was a problem hiding this comment.
To be honest I don't know. I applied suggested changes from https://github.com/tolusha/che-docs/pull/4/commits
pkg/apis/org/v1/che_types.go
Outdated
| // correspondly to auto-detection result. | ||
| // This property allows users to directly login with their Openshift user through the Openshift login, | ||
| // and have their workspaces created under personal OpenShift namespaces. | ||
| // Enabled by default on OpenShift. This will allow users to directly login with their OpenShift user through the OpenShift login, |
There was a problem hiding this comment.
I think we have mecanism to auto-enable oauth. By default property is an empty.
pkg/apis/org/v1/che_types.go
Outdated
| // Password of the proxy server | ||
| // Only use when proxy configuration is required | ||
| // (see also the `proxyURL`, `proxyUser` and `proxySecret` fields). | ||
| // Password of the proxy server Only use when proxy configuration is required (see also the `proxyURL`, `proxyUser` and `proxySecret` fields). |
There was a problem hiding this comment.
Password of the proxy server
Should be '.' in the end of the sentences?
pkg/apis/org/v1/che_types.go
Outdated
| // +optional | ||
| ProxyURL string `json:"proxyURL,omitempty"` | ||
| // Port of the proxy server. Only use when configuring a proxy is required. | ||
| // (see also the `proxyURL` and `nonProxyHosts` fields). | ||
| // Port of the proxy server. Only use when configuring a proxy is required. (see also the `proxyURL` and `nonProxyHosts` fields). |
There was a problem hiding this comment.
(see also the
proxyURLandnonProxyHostsfields).
Looks strange. Maybe:
See also the `proxyURL` and `nonProxyHosts` fields.
pkg/apis/org/v1/che_types.go
Outdated
| // Defines if a user is able to specify Kubernetes namespace (or OpenShift project) different from the default. | ||
| // It's NOT RECOMMENDED to configured true without OAuth configured. This property is also used by the OpenShift infra. | ||
| // Defines that a user is allowed to specify Kubernetes namespace, or OpenShift project, different from the default. | ||
| // It's NOT RECOMMENDED to be configured true without OpenShift OAuth configured. The OpenShift infrastructure also uses this property. |
There was a problem hiding this comment.
It's NOT RECOMMENDED to be configured true without OpenShift OAuth configured.
Maybe we should change this sentence, because it uses 'configured' two times. Maybe:
It's NOT RECOMMENDED to set true value without OpenShift OAuth configured.
Codecov Report
@@ Coverage Diff @@
## master #651 +/- ##
=======================================
Coverage 27.65% 27.65%
=======================================
Files 43 43
Lines 4672 4672
=======================================
Hits 1292 1292
Misses 3209 3209
Partials 171 171 Continue to review full report at Codecov.
|
Signed-off-by: Anatolii Bazko <[email protected]>
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: AndrienkoAleksandr, tolusha The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
|
New changes are detected. LGTM label has been removed. |
Signed-off-by: Anatolii Bazko [email protected]
What does this PR do?
Fix numerous doc issues
it is a prerequisite for eclipse-che/che-docs#1803
What issues does this PR fix or reference?
https://issues.redhat.com/browse/RHDEVDOCS-2216
PR Checklist
As the author of this Pull Request I made sure that:
What issues does this PR fix or referenceandHow to test this PRcompletedReviewers
Reviewers, please comment how you tested the PR when approving it.