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.

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

Fix godocs autoformatting from upgrading to go 1.19 #111701

Closed
Jefftree opened this issue Aug 4, 2022 · 8 comments · Fixed by #114559
Closed

Fix godocs autoformatting from upgrading to go 1.19 #111701

Jefftree opened this issue Aug 4, 2022 · 8 comments · Fixed by #114559
Assignees
Labels
help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. kind/bug Categorizes issue or PR as related to a bug. needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. sig/docs Categorizes an issue or PR as relevant to SIG Docs.

Comments

@Jefftree
Copy link
Member

Jefftree commented Aug 4, 2022

What happened?

Reference Comment: #111254 (comment)

Based on the diff: https://github.com/kubernetes/kubernetes/pull/111254/files, there are a couple areas where indentations are turned into paragraphs, indentations are turning regular comments into code blocks, etc.

I think there are a couple things we need to do (could be in separate PRs):

  1. Scan the original PR (see above) and fix the indentations in places where a paragraph is not supposed to occur. A good example is https://github.com/dims/kubernetes/blob/a9593d634c6a053848413e600dadbf974627515f/cmd/kube-apiserver/app/testing/testserver.go#L96-L99
  2. Some indentations should be changed into lists, eg: https://github.com/dims/kubernetes/blob/a9593d634c6a053848413e600dadbf974627515f/pkg/apis/core/types.go#L3222-L3226
  3. Unrelated to the previous PR, scan the k8s types and reformat bullet points using * to use -. go1.19 does not recognize * as bullet points. For example: https://github.com/dims/kubernetes/blob/a9593d634c6a053848413e600dadbf974627515f/staging/src/k8s.io/api/core/v1/types.go#L495-L496
  4. Ensure our swagger doc generation properly supports the new list format Keep the list style for generated swagger doc #111505

I hope this roughly captures the intent of the comment by liggitt.
/cc @liggitt
/cc @dims

/help

What did you expect to happen?

See above

How can we reproduce it (as minimally and precisely as possible)?

See above

Anything else we need to know?

No response

Kubernetes version

$ kubectl version
# paste output here

Cloud provider

OS version

# On Linux:
$ cat /etc/os-release
# paste output here
$ uname -a
# paste output here

# On Windows:
C:\> wmic os get Caption, Version, BuildNumber, OSArchitecture
# paste output here

Install tools

Container runtime (CRI) and version (if applicable)

Related plugins (CNI, CSI, ...) and versions (if applicable)

@Jefftree Jefftree added the kind/bug Categorizes issue or PR as related to a bug. label Aug 4, 2022
@k8s-ci-robot
Copy link
Contributor

@Jefftree:
This request has been marked as needing help from a contributor.

Guidelines

Please ensure that the issue body includes answers to the following questions:

  • Why are we solving this issue?
  • To address this issue, are there any code changes? If there are code changes, what needs to be done in the code and what places can the assignee treat as reference points?
  • Does this issue have zero to low barrier of entry?
  • How can the assignee reach out to you for help?

For more details on the requirements of such an issue, please see here and ensure that they are met.

If this request no longer meets these requirements, the label can be removed
by commenting with the /remove-help command.

In response to this:

What happened?

Reference Comment: #111254 (comment)

Based on the diff: https://github.com/kubernetes/kubernetes/pull/111254/files, there are a couple areas where indentations are turned into paragraphs, indentations are turning regular comments into code blocks, etc.

I think there are a couple things we need to do (could be in separate PRs):

  1. Scan the original PR (see above) and fix the indentations in places where a paragraph is not supposed to occur. A good example is https://github.com/dims/kubernetes/blob/a9593d634c6a053848413e600dadbf974627515f/cmd/kube-apiserver/app/testing/testserver.go#L96-L99
  2. Some indentations should be changed into lists, eg: https://github.com/dims/kubernetes/blob/a9593d634c6a053848413e600dadbf974627515f/pkg/apis/core/types.go#L3222-L3226
  3. Unrelated to the previous PR, scan the k8s types and reformat bullet points using * to use -. go1.19 does not recognize * as bullet points. For example: https://github.com/dims/kubernetes/blob/a9593d634c6a053848413e600dadbf974627515f/staging/src/k8s.io/api/core/v1/types.go#L495-L496
  4. Ensure our swagger doc generation properly supports the new list format Keep the list style for generated swagger doc #111505

I hope this roughly captures the intent of the comment by liggitt.
/cc @liggitt
/cc @dims

/help

What did you expect to happen?

See above

How can we reproduce it (as minimally and precisely as possible)?

See above

Anything else we need to know?

No response

Kubernetes version

$ kubectl version
# paste output here

Cloud provider

OS version

# On Linux:
$ cat /etc/os-release
# paste output here
$ uname -a
# paste output here

# On Windows:
C:\> wmic os get Caption, Version, BuildNumber, OSArchitecture
# paste output here

Install tools

Container runtime (CRI) and version (if applicable)

Related plugins (CNI, CSI, ...) and versions (if applicable)

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@k8s-ci-robot k8s-ci-robot added help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. needs-sig Indicates an issue or PR lacks a `sig/foo` label and requires one. labels Aug 4, 2022
@k8s-ci-robot
Copy link
Contributor

@Jefftree: This issue is currently awaiting triage.

If a SIG or subproject determines this is a relevant issue, they will accept it by applying the triage/accepted label and provide further guidance.

The triage/accepted label can be added by org members by writing /triage accepted in a comment.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@k8s-ci-robot k8s-ci-robot added the needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. label Aug 4, 2022
@yangjunmyfm192085
Copy link
Contributor

/assgin @sanwishe

@Jefftree
Copy link
Member Author

/sig docs

@k8s-ci-robot k8s-ci-robot added sig/docs Categorizes an issue or PR as relevant to SIG Docs. and removed needs-sig Indicates an issue or PR lacks a `sig/foo` label and requires one. labels Aug 17, 2022
@flynnhandley
Copy link

/assign

@Darshnadas
Copy link

/assign

@Darshnadas
Copy link

I won't be able to work on this, due to other work commitments. Hence, unassigning myself, anyone feel free to take upon this issue.

@liggitt
Copy link
Member

liggitt commented Dec 18, 2022

Created #114559 to resolve this

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. kind/bug Categorizes issue or PR as related to a bug. needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. sig/docs Categorizes an issue or PR as relevant to SIG Docs.
Projects
None yet
6 participants