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

Port Hugo theme to Hextra for the website #2897

Merged
merged 23 commits into from
Sep 22, 2023

Conversation

zelfroster
Copy link
Contributor

What does this change

Changes the hugo theme to Hextra for Porter website.

What issue does it fix

Closes #2885

Checklist

  • Did you write tests?
  • Did you write documentation?
  • Did you change porter.yaml or a storage document record? Update the corresponding schema file.
  • If this is your first pull request, please add your name to the bottom of our Contributors list. Thank you for making Porter better! 🙇‍♀️

Reviewer Checklist

  • Comment with /azp run test-porter-release if a magefile or build script was modified
  • Comment with /azp run porter-integration if it's a non-trivial PR

@zelfroster zelfroster marked this pull request as draft September 9, 2023 20:53
@zelfroster
Copy link
Contributor Author

@schristoff The theme porting has almost finished, I am fixing the internal links. Way too many need fix 😵, Also, I am running mage -v Docs to build docs and everything works fine, but idk why netlify build is failing. Please help me on that 😅

docs/go.mod Outdated Show resolved Hide resolved
@schristoff
Copy link
Member

Hey!

This is looking amazing. A couple of comments:

  • Is there anyway we can make the Porter logo in the left hand corner larger - and the favicon is currently the Hextra logo (we would love to have it the Porter logo!)?
  • It would be cool if we could change the colors to align more with the Porter colors, especially with the white themed website. But we can work on this later!
  • Can we delete the "Why Porter" section on the front page, and just have the "What is Porter" and "When Porter"
  • Lastly, I've found some icons for the "When Porter" section for each section. If you could add these, it would be greatly appreciated! If not, let me know :) (I'll add the new porter emojis into here too)

I am so excited for this redesign thank you for doing all this work

@zelfroster
Copy link
Contributor Author

zelfroster commented Sep 21, 2023

Is there anyway we can make the Porter logo in the left hand corner larger - and the favicon is currently the Hextra logo (we would love to have it the Porter logo!)?

I increased logo size, but the favicon doesn't seem to work as specified in their docs. I will open a issue in hextra.

It would be cool if we could change the colors to align more with the Porter colors, especially with the white themed website. But we can work on this later!

hextra allows changing the hue via custom.css file and I have changed it to the red color in the porter Logo and the site now looks like this, not sure if that looks good or bad 😅.

Can we delete the "Why Porter" section on the front page, and just have the "What is Porter" and "When Porter"

Done 👍🏼

Lastly, I've found some icons for the "When Porter" section for each section. If you could add these, it would be greatly appreciated! If not, let me know :) (I'll add the new porter emojis into here too)

Done 👍🏼

I am so excited for this redesign thank you for doing all this work

Thanks <3 : )

@schristoff
Copy link
Member

Okay, we're almost there!
Here's my last final nitpicks:

  • The main tagline (Your application, and everything you need to deploy, together 💖) has this blue highlight and so it's not readable. I think we just need to switch it from highlight to text color or something
  • I ran Google Lighthouse over the Netlify page to see where we could help make the page more accessible. Two big takeaways was bigger font, and contrast between font color and background. I think by making the font larger and have more weight (be bolder) this will satisfy that.
  • I need to make a white version of the icons so when people turn on dark mode at the bottom of the page they don't go away (I'll do that by EOD)
  • Should the "when would I use Porter" also be in a little box like "Why Porter"? 🤷🏻 Up to hearing your opinion
  • I am 100% cool with the footer at the bottom saying "Powered by Hextra" but it should also have our existing footer which is like:
[We are a Cloud Native Computing Foundation Sandbox Project. ](https://www.cncf.io/)We are a Cloud Native Computing Foundation Sandbox Project
© The Porter Authors 2023
© 2023 The Linux Foundation. All rights reserved. The Linux Foundation has registered trademarks and uses trademarks. For a list of trademarks of The Linux Foundation, please see the [Trademark Usage](https://www.linuxfoundation.org/trademark-usage) page.

I think that's it, then we can merge this big PR and iterate on it from here! :)

@zelfroster
Copy link
Contributor Author

The main tagline (Your application, and everything you need to deploy, together 💖) has this blue highlight and so it's not readable. I think we just need to switch it from highlight to text color or something

Extremely sorry, I forgot we need to add CSS for different browsers (chromium browser specifically) as well.
In firefox, It looks fine
image
In brave, chrome, chromium etc, looks bad
1695322984_Sep22_00:33:04

I will fix it.


I ran Google Lighthouse over the Netlify page to see where we could help make the page more accessible. Two big takeaways was bigger font, and contrast between font color and background. I think by making the font larger and have more weight (be bolder) this will satisfy that.

Hmm, Are you talking about overall font for the website, or just the homepage? I think you are talking about these probably..
1695323239_Sep22_00:37:19


I need to make a white version of the icons so when people turn on dark mode at the bottom of the page they don't go away (I'll do that by EOD)

I have converted these the icons provided by you to SVG's for ease of use. I can make a white version for them.


Should the "when would I use Porter" also be in a little box like "Why Porter"? 🤷🏻 Up to hearing your opinion

I actually did that earlier, but then everything below and above it looked the same. But I can change the colors and then they might look good. I will try to add red gradient. Let's see.
Also, Have you looked at the docs pages? Please check them as I have changed the accent color of the whole website.


I am 100% cool with the footer at the bottom saying "Powered by Hextra" but it should also have our existing footer which is like:

[We are a Cloud Native Computing Foundation Sandbox Project. ](https://www.cncf.io/)We are a Cloud Native Computing Foundation Sandbox Project
© The Porter Authors 2023
© 2023 The Linux Foundation. All rights reserved. The Linux Foundation has registered trademarks and uses trademarks. For a list of trademarks of The Linux Foundation, please see the [Trademark Usage](https://www.linuxfoundation.org/trademark-usage) page.

This Hextra issue is also there, I have already added code for copyright by following the docs, but they don't work for some reason. Will try to fix or raise issue in Hextra.

@schristoff
Copy link
Member

Looking through docs, the font size is great - but in light mode we are getting some weird highlighting issues and then this weird effect around the right hand "on this page"

Attached some screenshots :)
Screenshot 2023-09-21 at 1 45 44 PM

Screenshot 2023-09-21 at 1 46 00 PM

@zelfroster
Copy link
Contributor Author

Looking through docs, the font size is great - but in light mode we are getting some weird highlighting issues and then this weird effect around the right hand "on this page"

Attached some screenshots :) Screenshot 2023-09-21 at 1 45 44 PM
Screenshot 2023-09-21 at 1 46 00 PM

This is not an issue of the website, It's probably some browser extension, something like DarkReader causing the effect. Please give it a try after disabling any extension of that kind, or maybe in a different browser as well.

@schristoff
Copy link
Member

schristoff commented Sep 21, 2023

This is not an issue of the website, It's probably some browser extension, something like DarkReader causing the effect. Please give it a try after disabling any extension of that kind, or maybe in a different browser as well.

You're 100% right 🤦🏻 it is darkreader good call

@schristoff
Copy link
Member

Screenshot 2023-09-21 at 3 59 39 PM One more and then I'm mergin'

@zelfroster
Copy link
Contributor Author

zelfroster commented Sep 21, 2023

Screenshot 2023-09-21 at 3 59 39 PM One more and then I'm mergin'

Which one? Copyright?

Also, I forgot to add myself to contributors.md, gonna do it now.

@zelfroster
Copy link
Contributor Author

Hey @schristoff, I am done for now on this PR. The copyright and favicon issue need to be resolved with Hextra and Unless I missed something, I think it's good to go.

schristoff and others added 3 commits September 21, 2023 21:49
@schristoff schristoff marked this pull request as ready for review September 22, 2023 16:43
@zelfroster
Copy link
Contributor Author

Lemme fix the CNCF logo at the footer, just few minutes.

Signed-off-by: zelfroster <[email protected]>
@zelfroster
Copy link
Contributor Author

@schristoff Done Finally 🎉

@zelfroster zelfroster changed the title Port theme to hextra: WIP Port Hugo theme to Hextra for the website Sep 22, 2023
@schristoff schristoff merged commit 19755b6 into getporter:main Sep 22, 2023
13 checks passed
kichristensen added a commit to kichristensen/porter that referenced this pull request May 22, 2024
PR getporter#2897 moved the CLI reference file, but the CLI reference generation
still points to the old location.

Signed-off-by: Kim Christensen <[email protected]>
schristoff pushed a commit that referenced this pull request May 23, 2024
…#3129)

PR #2897 moved the CLI reference file, but the CLI reference generation
still points to the old location.

Signed-off-by: Kim Christensen <[email protected]>
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.

feat: Update Hugo Template to Docsy
2 participants