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:solve the warnings in 'make doc' #806

Merged
merged 2 commits into from
Dec 15, 2022
Merged

Conversation

thredreams
Copy link
Contributor

make doc command generates six warnings:

  • WARNING: duplicate label prerequisites, WARNING: 'myst' reference target not found:
  • WARNING: document isn't included in any toctree
  • index.rst:2: WARNING: Title underline too short.
  • CODE_OF_CONDUCT.md:1: WARNING: Document headings start at H2, not H1 [myst.header]
  • WARNING: Could not lex literal_block as "yaml". Highlighting skipped.
  • WARNING: Could not lex literal_block as "console". Highlighting skipped.

I have solved the last four warnings, but the first two "warnings" have not been solved

The warning1 is because there are many subtitles with the same name, the file link is invalid

The warning2 is that several files have not been determined and added to the directory

The last two warnings cause code block highlighting failure,I'm not sure if my changes are appropriate

Signed-off-by: thredreams 1220474743@qq.com

Signed-off-by: thredreams <1220474743@qq.com>
@thredreams thredreams requested a review from a team as a code owner December 14, 2022 10:33
Signed-off-by: thredreams <1220474743@qq.com>
@codecov-commenter
Copy link

codecov-commenter commented Dec 15, 2022

Codecov Report

Merging #806 (80f302d) into main (c315315) will increase coverage by 0.16%.
The diff coverage is n/a.

❗ Current head 80f302d differs from pull request most recent head 4a925b2. Consider uploading reports for the commit 4a925b2 to get more accurate results

@@            Coverage Diff             @@
##             main     #806      +/-   ##
==========================================
+ Coverage   62.43%   62.59%   +0.16%     
==========================================
  Files          46       46              
  Lines        6154     6154              
==========================================
+ Hits         3842     3852      +10     
+ Misses       2071     2064       -7     
+ Partials      241      238       -3     
Impacted Files Coverage Δ
internal/provider/kubernetes/controller.go 51.25% <0.00%> (+0.96%) ⬆️
internal/provider/kubernetes/helpers.go 74.19% <0.00%> (+4.03%) ⬆️

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

Copy link
Contributor

@arkodg arkodg left a comment

Choose a reason for hiding this comment

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

LGTM ! thanks for fixing these warnings

@arkodg arkodg merged commit 9cfbacf into envoyproxy:main Dec 15, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants