Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Trim down CRD descriptions #1735

Merged
merged 2 commits into from
Jan 21, 2023
Merged

Trim down CRD descriptions #1735

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
92b05c5
Trim down CRD descriptions
tenzen-y Jan 21, 2023
d2aefbc
400 characters
tenzen-y Jan 21, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Image URL to use all building/pushing image targets
IMG ?= kubeflow/training-operator:latest
# CRD generation options
CRD_OPTIONS ?= "crd:generateEmbeddedObjectMeta=true"
CRD_OPTIONS ?= "crd:generateEmbeddedObjectMeta=true,maxDescLen=300"
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@johnugeorge I tried to set 300 characters. How about generated CRD descriptions?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see that there are some minor unintended line breaks. https://github.com/kubeflow/training-operator/pull/1735/files#diff-f68a63b0953eb712985f398c6c8ae96093830f251ec4ced3865cbe46d41550b3L934 This doesn't seem to be a major concern. Good to go

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I increased it to 400 characters. The unintended line breaks that you pointed out are resolved.


# Get the currently used golang install path (in GOPATH/bin, unless GOBIN is set)
ifeq (,$(shell go env GOBIN))
Expand Down
1,146 changes: 194 additions & 952 deletions manifests/base/crds/kubeflow.org_mpijobs.yaml
View file
Open in desktop

Large diffs are not rendered by default.

1,146 changes: 194 additions & 952 deletions manifests/base/crds/kubeflow.org_mxjobs.yaml
View file
Open in desktop

Large diffs are not rendered by default.

1,162 changes: 197 additions & 965 deletions manifests/base/crds/kubeflow.org_paddlejobs.yaml
View file
Open in desktop

Large diffs are not rendered by default.

1,162 changes: 197 additions & 965 deletions manifests/base/crds/kubeflow.org_pytorchjobs.yaml
View file
Open in desktop

Large diffs are not rendered by default.

1,146 changes: 194 additions & 952 deletions manifests/base/crds/kubeflow.org_tfjobs.yaml
View file
Open in desktop

Large diffs are not rendered by default.

1,146 changes: 194 additions & 952 deletions manifests/base/crds/kubeflow.org_xgboostjobs.yaml
View file
Open in desktop

Large diffs are not rendered by default.