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.

Sign up for GitHub

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

Jump to bottom

Move kubearmor.io to new static generator #1

Open
ShubhamTatvamasi opened this issue Sep 8, 2023 · 34 comments
Open

Move kubearmor.io to new static generator #1

ShubhamTatvamasi opened this issue Sep 8, 2023 · 34 comments
Assignees
@Aditya-150

Comments

@ShubhamTatvamasi
Copy link
Contributor

Currently, our website is on build using gatsby. We are planning to move it to a new static website generator, so we can host it on github pages. I created a draft using hugo for our blogging needs. We can look for more options if needed.
@Aditya-150
Copy link
Collaborator

I have an idea. We can directly use GitHub wiki page content for the blog for this we can use GitHub API.
What say? @ShubhamTatvamasi

@ShubhamTatvamasi
Copy link
Contributor Author

We are doing that already. We want people to create a PR for posting new blogs and have a custom theme for our landing page.
https://github.com/kubearmor/KubeArmor/wiki

@Aditya-150
Copy link
Collaborator

I understand it now.

We are doing that already. We want people to create a PR for posting new blogs and have a custom theme for our landing page. https://github.com/kubearmor/KubeArmor/wiki

@Aditya-150
Copy link
Collaborator

When the PR having tag of blog is merged. It should be released in the blogs section of the website. I think we do it by setting up a github workflow for it.

@Aditya-150
Copy link
Collaborator

We are doing that already. We want people to create a PR for posting new blogs and have a custom theme for our landing page. https://github.com/kubearmor/KubeArmor/wiki

Also theme and UI for website. If you want I can design.

@ShubhamTatvamasi
Copy link
Contributor Author

I worked on this theme, can we improve it as per our needs?
https://hugo.shubhamtatvamasi.com

@Aditya-150
Copy link
Collaborator

Aditya-150 commented Sep 8, 2023 •
edited
Loading

Yeah, we can definitely improve the theme. Even we can make or revamp whole website of kuberarmor.io using hugo unless its using any dynamic functionalities.

As I can see you are using theme provided by hugo-PaperMod. We need to add our own stylesheets, CSS files or CSS modules in order to customize the theme of the website.

My question is: Will we be revamping the whole kuberarmor.io or the blog part you are currently working on?

@ShubhamTatvamasi
Copy link
Contributor Author

We will have to change the whole website. Come up with new design.

@Aditya-150
Copy link
Collaborator

Fine👍! Should I create a Figma file and share the access of it via mail(mentioned in your profile) ? or we can do the vice-versa.

@ShubhamTatvamasi
Copy link
Contributor Author

You do it.

@Aditya-150
Copy link
Collaborator

Done🚀

@ShubhamTatvamasi
Copy link
Contributor Author

I got the email, we have to get on a call for this.

@Aditya-150
Copy link
Collaborator

Yup. Anytime in night. I'll be available and in any platform you choose.

@Aditya-150
Copy link
Collaborator

Yup. Anytime in night. I'll be available and in any platform you choose.

Just notify me before hand if possible. I'll be there.

@Aditya-150
Copy link
Collaborator

@ShubhamTatvamasi I'm just thinking of conducting an user survey in order to get an idea of what people think about current design and what changes or improvements they want in order to make the site more intuitive. Do you think this would work?

Also a new channel can only be create by the admin of the slack workspace. We need to talk to Rahul about this as he currently has the admin access.

@ShubhamTatvamasi
Copy link
Contributor Author

@ShubhamTatvamasi I'm just thinking of conducting an user survey in order to get an idea of what people think about current design and what changes or improvements they want in order to make the site more intuitive. Do you think this would work?

Also a new channel can only be create by the admin of the slack workspace. We need to talk to Rahul about this as he currently has the admin access.

@nyrahul can you please create a new channel for #kuberarmor-website.

@Aditya-150
Copy link
Collaborator

Aditya-150 commented Sep 14, 2023 •
edited
Loading

Also, I have a new framework suggestion. It's astro🚀. It uses .mdx instead of .md for content publication but customization it gives is out of the box. We can also use libraries like tailwind CSS in it.
Just checkout. Let me know .

@ShubhamTatvamasi
Copy link
Contributor Author

Also, I have a new framework suggestion. It's astro🚀. It uses .mdx instead of .md for content publication but customization it gives is out of the box. We can also use libraries like tailwind CSS in it. Just checkout. Let me know .

Is it simple to read and write?
Can we generate static web pages with this?

@Aditya-150
Copy link
Collaborator

Its just markdown having the access for jsx(its not mandatory, it uses javascript for more flexibility). React developers will have have fun. Yes, Astro mainly focuses on content based websites like blogs, portfolios, marketing and less dynamic e-commerce. So, I think this might be just the perfect framework for us.

@Aditya-150
Copy link
Collaborator

I'm confirming about the best of the two within 2 days.

@ShubhamTatvamasi
Copy link
Contributor Author

I'm confirming about the best of the two within 2 days.

That will be great, Thanks.

@Aditya-150
Copy link
Collaborator

Astro🚀 V/S Hugo🔥

This is a competitive analysis between 2 frameworks.
Note: In this I have used basic boiler plate code that every framework gives.

GitHub Repo for Astro🚀: https://github.com/Aditya-150/hugo-test
GitHub Repo for Hugo🔥: https://github.com/Aditya-150/astro-blog

Both are hosted using Vercel.

Count the emojis to decide the winner.
🚀 -> Astro
🔥 -> Hugo

Framework SSG Documentation Build Speed Community
Support		 Markdown
for Content Publication		 Developer Experience 3rd Party
Library Integration		 Real-time Data Loading SEO Performance
(Lighthouse Score)		 Deployment Ease
Hugo🔥
  • Checked
 Good & Detailed 4ms🔥 Larger🔥 &
experienced		 .md file supported + .json etc Good Can Work May work Good Killer🔥 OK
Astro🚀
  • Checked
 Good & Detailed 407ms for For normal template
546ms for blog template		 Relatively New .md + .mdx file supported🚀 Better🚀 (fun for React developers) Seamless🚀 Works🚀 Awesome🚀 Good Better🚀
Winner⭐ _ _ 🔥 🔥 🚀 🚀 🚀 🚀 🚀 🔥 🚀

Some more online resources found:

(Based on data available on internet, some tests and our requirements)

PS: I wasn't able to host Hugo site on GitHub pages due to some workflow issues for which I had to delete that repo🥲.

@ShubhamTatvamasi
Copy link
Contributor Author

@Aditya-150 also check if these solutions can be deployed on GitHub pages.

@Aditya-150
Copy link
Collaborator

I will try again and let you know.

@Aditya-150
Copy link
Collaborator

Also if we host on Vercel we can still change the domain name by changing the DNS configuration.

@ShubhamTatvamasi
Copy link
Contributor Author

Also if we host on Vercel we can still change the domain name by changing the DNS configuration.

I guess Vercel is a paid service.

@Aditya-150
Copy link
Collaborator

Aditya-150 commented Sep 16, 2023 via email

@Aditya-150
Copy link
Collaborator

@ShubhamTatvamasi just asking. Should I make any progress on the UI design part or wait for the content?

@ShubhamTatvamasi
Copy link
Contributor Author

@ShubhamTatvamasi just asking. Should I make any progress on the UI design part or wait for the content?

Hi @Aditya-150, please feel free to progress on the UI design part, we are still in the process of gathering all the content.

@Aditya-150
Copy link
Collaborator

Ok I'll be using content currently given in the website with some basic improvisations. Is that fine ? @ShubhamTatvamasi

@ShubhamTatvamasi
Copy link
Contributor Author

Ok I'll be using content currently given in the website with some basic improvisations. Is that fine ? @ShubhamTatvamasi

Sure, that would be great. Thanks @Aditya-150 😄

@hanshal101
Copy link

Hey everyone While reading the whole conversation, I understood that we are building the site on Hugo or Astro. My question is why are we not using Javascript frameworks like ReactJs or NextJs.

Also, I'm interested in developing the website.

@Aditya-150
Copy link
Collaborator

Hello @hanshal101. Nice to have you.
Thanks for going through the whole conversation. Also Thanks for showing so much interest in developing the website.

Coming to your question,
We aren't actually building our website with Hugo or Asto. We are using docusaurus which is open source framework by Meta for building our website which is a content driven framework too(Refer to the docusaurus official documentation for understanding linked above👆). Actually you are correct we could have used NEXTJS as it is a more dynamic framework and quite popular. We are using docusaurus as it is just a preference. Hope you understand.

Actually, currently we are at quite early stage of website. The first version is also yet to be released. There are a lot of thing to be done actually like documentation etc. So, you might need to wait for some time in order to start contributing. Thanks for showing so much interest. You can follow official documentation of docusaurus and get to know about kubearmor till then.

PS: Join the Slack Channel if you want to be part of this journey. 👉Join Slack

@hanshal101
Copy link

Thanks, @Aditya-150 for such a nice explanation. I'm currently learning ReactJs for frontend development, so I was quite interested in building the KubeArmor website. I truly understand the current requirements, and you are right, it's quite challenging to maintain a NextJS or ReactJS website in the early stages.

I will definitely look up the Docusaurus documentation and learn more about this framework.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Aditya-150 Aditya-150

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@ShubhamTatvamasi @Aditya-150 @hanshal101