Skip to content

Cleans-Up Docs#640

Merged
Xunzhuo merged 1 commit intoenvoyproxy:mainfrom
danehans:docs_remove_ver_details
Nov 5, 2022
Merged

Cleans-Up Docs#640
Xunzhuo merged 1 commit intoenvoyproxy:mainfrom
danehans:docs_remove_ver_details

Conversation

@danehans
Copy link
Copy Markdown
Contributor

@danehans danehans commented Oct 21, 2022

This PR simplifies the docs interface by:

  • Removing the Envoy and Gateway API versions used. This is what the compatibility matrix is for.
  • Adds links to ref'd Envoy Proxy and Gateway API.
  • Expands the index to provide a brief introduction to the project.
  • Removes the intro/index.rst and reference to it since this page was redundant with the docs homepage.
  • Moves the note about EG being under active dev to the bottom of the docs homepage.

Signed-off-by: danehans daneyonhansen@gmail.com

@danehans danehans requested a review from a team as a code owner October 21, 2022 18:00
@danehans danehans added the documentation Improvements or additions to documentation label Oct 21, 2022
@danehans danehans added this to the 0.3.0-rc.1 milestone Oct 21, 2022
Alice-Lilith
Alice-Lilith previously approved these changes Oct 21, 2022
@Alice-Lilith
Copy link
Copy Markdown
Member

Seems like a small lint error, but otherwise lgtm

Copy link
Copy Markdown
Member

@Xunzhuo Xunzhuo left a comment

Choose a reason for hiding this comment

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

https://github.com/envoyproxy/gateway/blob/main/docs/conf.py#L35

Dont forget to remove the '+ fullversion' at the end. This is not ready too.

From:
copyright = 'Envoy Gateway Project Authors | GitHub | ' + fullversion

Too:
copyright = 'Envoy Gateway Project Authors | GitHub '

Others LGTM.

@Xunzhuo
Copy link
Copy Markdown
Member

Xunzhuo commented Oct 22, 2022

I suggest waiting for #639, after getting that merged, I think most of changes in this PR will not be needed.

@danehans
Copy link
Copy Markdown
Contributor Author

Marking as Draft due to #640 (comment).

@danehans danehans marked this pull request as draft October 24, 2022 05:00
Signed-off-by: danehans <daneyonhansen@gmail.com>
@danehans danehans force-pushed the docs_remove_ver_details branch from ac33802 to 7c87b0f Compare November 4, 2022 15:51
@danehans danehans marked this pull request as ready for review November 4, 2022 15:52
@danehans
Copy link
Copy Markdown
Contributor Author

danehans commented Nov 4, 2022

@Xunzhuo this PR still has changes that differ from #639. I rebased and updated so PTAL.

@codecov-commenter
Copy link
Copy Markdown

codecov-commenter commented Nov 4, 2022

Codecov Report

Merging #640 (7c87b0f) into main (976366f) will decrease coverage by 0.19%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##             main     #640      +/-   ##
==========================================
- Coverage   63.59%   63.40%   -0.20%     
==========================================
  Files          47       47              
  Lines        5749     5749              
==========================================
- Hits         3656     3645      -11     
- Misses       1868     1877       +9     
- Partials      225      227       +2     
Impacted Files Coverage Δ
internal/provider/kubernetes/gatewayclass.go 70.28% <0.00%> (-5.08%) ⬇️
internal/provider/kubernetes/gateway.go 49.68% <0.00%> (-0.86%) ⬇️

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

Copy link
Copy Markdown
Member

@Xunzhuo Xunzhuo left a comment

Choose a reason for hiding this comment

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

Looks good!

@Xunzhuo Xunzhuo merged commit 54d44d5 into envoyproxy:main Nov 5, 2022
@danehans danehans deleted the docs_remove_ver_details branch November 7, 2022 19:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants