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

refactor: migrate docs from sphinx to hugo #1872

Merged
merged 1 commit into from
Oct 10, 2023

Conversation

Xunzhuo
Copy link
Member

@Xunzhuo Xunzhuo commented Sep 8, 2023

What type of PR is this?

What this PR does / why we need it:

Which issue(s) this PR fixes:

Preview: https://gateway.xunzhuo.cafe

Fixes: #1752

@codecov
Copy link

codecov bot commented Sep 8, 2023

Codecov Report

Merging #1872 (dc22c43) into main (d4d1073) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main    #1872   +/-   ##
=======================================
  Coverage   65.42%   65.42%           
=======================================
  Files          90       90           
  Lines       13362    13362           
=======================================
  Hits         8742     8742           
  Misses       4082     4082           
  Partials      538      538           

@Xunzhuo Xunzhuo changed the title 📝 Docs Refactor: migrate Docs to Hugo Sep 8, 2023
@zirain
Copy link
Contributor

zirain commented Sep 8, 2023

docy?

@arkodg
Copy link
Contributor

arkodg commented Sep 12, 2023

hey @Xunzhuo can you update https://gateway.xunzhuo.cafe/, its pointing to the older docs

@arkodg
Copy link
Contributor

arkodg commented Sep 12, 2023

thanks for adding this @Xunzhuo !
im a +1 on this, its also recommended by CNCF https://www.cncf.io/blog/2023/01/19/fast-and-effective-tools-for-cncf-and-open-source-project-websites/

@Alice-Lilith
Copy link
Member

+1 I really like the preview link you shared. My only nit right now would be that I'd love to see us replace the blue colour in the docs pages with more of the Envoy pink that you have on the homepage. That should help us both stand out a bit more from other CNCF projects, and look a little more like the main Envoy Proxy docs.

@haq204
Copy link
Contributor

haq204 commented Sep 14, 2023

This is awesome!

@qicz
Copy link
Member

qicz commented Sep 15, 2023

great job!

@Xunzhuo Xunzhuo force-pushed the docs-hugo branch 6 times, most recently from e291106 to 558221e Compare October 8, 2023 09:23
@Xunzhuo Xunzhuo added this to the 0.6.0-rc1 milestone Oct 8, 2023
@Xunzhuo Xunzhuo added priority/high Label used to express the "high" priority level kind/refactor labels Oct 8, 2023
@Xunzhuo Xunzhuo force-pushed the docs-hugo branch 3 times, most recently from 2cf4ab2 to 72dd25a Compare October 8, 2023 13:21
@Xunzhuo Xunzhuo marked this pull request as ready for review October 8, 2023 13:23
@Xunzhuo Xunzhuo requested a review from a team as a code owner October 8, 2023 13:23
@Xunzhuo
Copy link
Member Author

Xunzhuo commented Oct 8, 2023

Hi forks! Checkout latest preview : )

Website: https://gateway.xunzhuo.cafe

Blog: https://gateway.xunzhuo.cafe/blog/2023/10/08/welcome-to-new-website/

Presentations: https://gateway.xunzhuo.cafe/blog/2022/10/28/kubecon-north-america-2022/

Versioned Docs: https://gateway.xunzhuo.cafe/latest/

cc @envoyproxy/gateway-reviewers @envoyproxy/gateway-maintainers @envoyproxy/gateway-steering-committee

@Xunzhuo Xunzhuo force-pushed the docs-hugo branch 6 times, most recently from aeea158 to 1b2d298 Compare October 9, 2023 03:32
@Xunzhuo Xunzhuo force-pushed the docs-hugo branch 11 times, most recently from f92fc50 to 4ce52d0 Compare October 9, 2023 08:35
@Xunzhuo Xunzhuo changed the title Refactor: migrate Docs to Hugo Refactor: migrate Docs from Sphinx to Hugo Oct 9, 2023
@Xunzhuo Xunzhuo force-pushed the docs-hugo branch 5 times, most recently from 663e4fb to 1f0c29d Compare October 9, 2023 11:38
Signed-off-by: bitliu <[email protected]>
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.

Thanks for adding this upgrade ! this will tremendously benefit end users

some small non blocking nits

  1. we may need to play around with the color palette a little more to be closer to https://www.envoyproxy.io (I'll raise a GH issue for this once this merges)
  2. the Compatibility Matrix lives under Blog which may not be the best home for it.
    I'd move it to #ready-to-get-started
  3. By default the website points to latest instead of the last stable version (v0.5.0) , it should instead point to the last stable version (v0.5.0)

@Xunzhuo
Copy link
Member Author

Xunzhuo commented Oct 10, 2023

Will work on a follow up PR : )

@Xunzhuo Xunzhuo merged commit 2be4b4d into envoyproxy:main Oct 10, 2023
20 checks passed
@zirain
Copy link
Contributor

zirain commented Oct 10, 2023

Good job!

@Xunzhuo Xunzhuo changed the title Refactor: migrate Docs from Sphinx to Hugo refactor: migrate docs from sphinx to hugo Oct 13, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/refactor priority/high Label used to express the "high" priority level
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Improve visual representation of the docs website
6 participants