GitHub user dominikriemer closed a discussion: Reduce website & docs complexity

Hi,
currently, we use three different frameworks to host our website:
* The website itself using harp.js
* The documentation using Docusaurus v1
* The Python docs using markdown

The reason why we use two frameworks for website & docs was that Docusaurus v1, 
which we used at this time, did not provide a lot of customization features in 
terms of design, e.g., building a nice-looking home page.

Docusaurus v2 is already available for some time and can be completely 
customized with React under the hood, and although it is some substantial work, 
I suggest to merge the website and docs and then serve the main content from 
Docusaurus. This should ease website maintenance and allows users to faster 
access the documentation instead of navigating to a subpage. We would keep the 
Python docs in Markdown since it's automatically built but would also be able 
to show the Python support more prominently in the navigation bar.

I created a branch in the website repo 
(https://github.com/apache/streampipes-website/tree/improved-website) to check 
the feasibility and it roughly works - I'll continue to migrate the home page 
and other pages.

What do you think? Do we have any requirements or changes to the main structure 
we want to have?

GitHub link: https://github.com/apache/streampipes/discussions/1731

----
This is an automatically sent email for [email protected].
To unsubscribe, please send an email to: [email protected]

Reply via email to