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

update doc render: avoid multiple index.md; remove redundant schema prefix #146

Closed

Conversation

amyXia1994
Copy link
Contributor

@amyXia1994 amyXia1994 commented Aug 30, 2023

1. Does this PR affect any open issues?(Y/N) and add issue references (e.g. "fix #123", "re #123".):

2. What is the scope of this PR (e.g. component or file name):

pkg/tools/gen/gendoc.go

pkg/tools/gen/templates/doc/packageDoc.gotmpl
pkg/tools/gen/templates/doc/schemaDoc.gotmpl

pkg/tools/gen/testdata/doc/k8s/...
pkg/tools/gen/testdata/doc/pkg/...
pkg/tools/gen/testdata/doc/reimport/...

3. Provide a description of the PR(e.g. more details, effects, motivations or doc link):

update doc render:

  • avoid multiple index.md with the same file name
  • remove redundant schema prefix
  • Affects user behaviors
  • Contains syntax changes
  • Contains variable changes
  • Contains experimental features
  • Performance regression: Consumes more CPU
  • Performance regression: Consumes more Memory
  • Other

4. Are there any breaking changes?(Y/N) and describe the breaking changes(e.g. more details, motivations or doc link):

  • N
  • Y

5. Are there test cases for these changes?(Y/N) select and add more details, references or doc links:

  • Unit test
  • Integration test
  • Benchmark (add benchmark stats below)
  • Manual test (add detailed scripts or steps below)
  • Other

@coveralls
Copy link

coveralls commented Aug 30, 2023

Pull Request Test Coverage Report for Build 6023242803

  • 28 of 30 (93.33%) changed or added relevant lines in 1 file are covered.
  • 1 unchanged line in 1 file lost coverage.
  • Overall coverage increased (+0.08%) to 64.622%

Changes Missing Coverage Covered Lines Changed/Added Lines %
pkg/tools/gen/gendoc.go 28 30 93.33%
Files with Coverage Reduction New Missed Lines %
pkg/tools/gen/gendoc.go 1 68.48%
Totals Coverage Status
Change from base Build 6012221066: 0.08%
Covered Lines: 2539
Relevant Lines: 3929

💛 - Coveralls

@amyXia1994 amyXia1994 requested a review from Peefy August 30, 2023 12:13
@amyXia1994 amyXia1994 closed this Aug 31, 2023
@amyXia1994 amyXia1994 deleted the update/doc-render-template branch August 31, 2023 03:50
@github-actions github-actions bot locked and limited conversation to collaborators Aug 31, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

support Go API for GetSchemaTypeMapping
2 participants