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

feat: Update Hugo Template to Docsy #2885

Closed
schristoff opened this issue Aug 25, 2023 · 8 comments · Fixed by #2897
Closed

feat: Update Hugo Template to Docsy #2885

schristoff opened this issue Aug 25, 2023 · 8 comments · Fixed by #2897
Assignees
Labels
help wanted Good for someone who has contributed before suggestion Idea for maintainers to consider. Do not take this issue until triaged. website Great for people with graphic design and html/css skills

Comments

@schristoff
Copy link
Member

I believe Docsy would be the easiest lift and shift that suites our needs as a product, but I am open to other solutions. I have not scoped out the work to move our website theme.

@schristoff schristoff added help wanted Good for someone who has contributed before suggestion Idea for maintainers to consider. Do not take this issue until triaged. website Great for people with graphic design and html/css skills labels Aug 25, 2023
@schristoff schristoff moved this to 🆕 New in Porter Aug 25, 2023
@kumarankit999
Copy link

Can I work on this issue, I would love to help this out

@schristoff
Copy link
Member Author

Sure @kumarankit999 - we would love the help!
I don't think it's going to be an easy 'lift and shift', but when you make a PR it should publish any changes to netlify so that we can all view them too. If you get stuck or need any feedback quickly, I highly suggest the #porter channel in the CNCF slack as well, as all the maintainers are sitting in there :)

@zelfroster
Copy link
Contributor

Sure @kumarankit999 - we would love the help! I don't think it's going to be an easy 'lift and shift', but when you make a PR it should publish any changes to netlify so that we can all view them too. If you get stuck or need any feedback quickly, I highly suggest the #porter channel in the CNCF slack as well, as all the maintainers are sitting in there :)

I would also love to help. I have built my site with Hugo, so I have some experience.

@zelfroster
Copy link
Contributor

I believe Docsy would be the easiest lift and shift that suites our needs as a product, but I am open to other solutions. I have not scoped out the work to move our website theme.

Hello @schristoff, I have been looking into some Hugo themes for documentation. And this one looks promising, https://getdoks.org/ . Please check this out.
And, Kindly tell me if we should proceed with that. One more thing, The documentation part is not dependent on porter installation and running, right?

@schristoff
Copy link
Member Author

Hi @zelfroster - posting in here (even though addressed in Slack)
Doks is totally great! I think it's a cool theme.
The documentation part is not dependent on a porter installation - that is correct :)

@zelfroster
Copy link
Contributor

zelfroster commented Sep 6, 2023

Hey @schristoff, Here is an update on this work, as much as I wanted to use Doks, after seeing the way it is needed to set up, I don't want to use it anymore.

The reason being It doesn't use the Hugo modules or git submodules, rather It uses Node.js for managing and updating the theme, which adds a lot of files and dependencies in the project to be maintained on our end. While that can be beneficial and provide more control for some people, It seems unnecessary to me.

I have been looking for another theme and found Hextra, It is very simple and clean and does the job for us. I wanted to present a working version so that I can get the community members feedback to go on with this. Here's a working version https://64f899057ff7e32422ae7629--verdant-cupcake-b7edc5.netlify.app/

I have almost ported the theme to Hextra, but will also need inputs and clarifications for doing it the correct way, as I did it in one go 😅. Please give your valuable feedback.

@schristoff
Copy link
Member Author

❗ Omg, I love it. It looks very modern, sleek, what a great choice!
Thank you so much for creating a preview as well.
Once the port over to Hextra is done I think the next step will be to spruce up that homepage.
I'll nitpick on the format of the homepage and such when we get a PR up and ready. I cannot overstate how jazzed I am to see this. :)

@zelfroster
Copy link
Contributor

❗ Omg, I love it. It looks very modern, sleek, what a great choice! Thank you so much for creating a preview as well. Once the port over to Hextra is done I think the next step will be to spruce up that homepage. I'll nitpick on the format of the homepage and such when we get a PR up and ready. I cannot overstate how jazzed I am to see this. :)

Thank you so much <3 !!
I will start the work with a draft PR soon. Please assign this issue to me.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Good for someone who has contributed before suggestion Idea for maintainers to consider. Do not take this issue until triaged. website Great for people with graphic design and html/css skills
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

3 participants