[FEATURE] Enhance UI and functionality of the landing page and integrate docs and blogs into a docusaurus project to enhance docs capabilities

ayushsatyam146 commented 1 month ago

Is there an existing feature request for this?

[X] I have searched the existing feature requests

Is your feature request related to a problem or use-case? Please describe.

shipwright.io has a very static landing page that doesn't serve much functionality or information regarding the Shipwright Project. Docs website is written in Hugo but it can be better written in documentation oriented frontend frameworks like Docusaurus.

Describe the solution that you would like.

Enhance UI of the landing page
Convert the docs portion into a docusaurus project
add additional functionalities like search, indexing, light/dark mode, easy navigation etc. (all easily achievable out of the box in docusaurus)

NOTE - Our goal is to utilize as much of the existing project and documentation and hence we want to have a .md file parser kind of approach, where simply adding a new .md file in the folders will add a new page and any changes in the files should automatically be reflected in the website (might need to setup a small deployment pipeline)

Describe alternatives you have considered.

No response

Anything else?

No response

Adarsh-jaiss commented 1 month ago

/assign

Adarsh-jaiss commented 1 month ago

/assign NAMANIND

openshift-ci[bot] commented 1 month ago

@Adarsh-jaiss: GitHub didn't allow me to assign the following users: NAMANIND.

Note that only shipwright-io members with read permissions, repo collaborators and people who have commented on this issue/PR can be assigned. Additionally, issues/PRs can only have 10 assignees at the same time. For more information please see the contributor guide

In response to [this](https://github.com/shipwright-io/website/issues/129#issuecomment-2354112674): >/assign NAMANIND Instructions for interacting with me using PR comments are available [here](https://git.k8s.io/community/contributors/guide/pull-requests.md). If you have questions or suggestions related to my behavior, please file an issue against the [kubernetes-sigs/prow](https://github.com/kubernetes-sigs/prow/issues/new?title=Prow%20issue:) repository.

qu1queee commented 1 month ago

I dont think there is consensus on Docusaurus, so this should not be a goal at the moment, neither moving out of Docsy. @ayushsatyam146 please rewrite your issue with more clear goals.

adambkaplan commented 1 month ago

I took a quick look at Docusaurus - I'm a bit ambivalent to be honest. Its feature set is more or less identical to our current Hugo + Docsy stack. Our site provider - Netlify - supports Docusaurus as a static site generator, so there's no sysadmin blocker there. My quick pros + cons:

Pro:

React based, thus technical contributions from front-end web designers might be easier. Also supports more sophisticated content pages with MDX.
Primary support for multi-versioned docs. For Docsy + Hugo this is kind of bolted on and free-form.
Stronger support for internationalization.

Con:

Switching cost - someone needs to port what we have over to Docusaurus
Contributor base - many CNCF projects use the Hugo + Docsy stack. Technical writers/UX experts may be less familiar with Docusaurus (use of React mitigates this?)

qu1queee commented 1 month ago

@adambkaplan thanks for handling this the proper way :) . I'm meeting tomorrow with @Adarsh-jaiss , we will work on a document to have a UI proposal based on my recent work and his investigations for next Monday. @ayushsatyam146 do you want to join us?

ayushsatyam146 commented 1 month ago

Hi @qu1queee it would be hard for me to join. I will connect with @Adarsh-jaiss later on for the updates. Thanks

Adarsh-jaiss commented 1 month ago

Here's the summary of website's call on 20th september : https://docs.google.com/document/d/1Hnpv8zow-Lg9DiqaNRFonQlZSUbZyF6hTVRHYdJ_3xw/edit?usp=sharing

Adarsh-jaiss commented 1 month ago

Hello Team, We had another call for the website design on 27th September in which we discussed about the Front page design which includes header, navbar and homepage. Feel free to check it out the meeting minutes here : https://docs.google.com/document/d/1Hnpv8zow-Lg9DiqaNRFonQlZSUbZyF6hTVRHYdJ_3xw/edit?usp=sharing

shipwright-io / website