Web Content Redesign - Githubissues

tremor-rs / tremor-www-docs

Tremor https://docs.tremor.rs site

Apache License 2.0

24 stars 22 forks source link

Web Content Redesign #121

Open mfelsche opened 3 years ago

mfelsche commented 3 years ago

As an early stage project we’ve biased in favour of documenting the essentials and getting content in place as fast as possible. This has worked well but a side-effect is 3 or 4 different sources of content ( www, docs, rfcs and courseware ).

We came up with some improvements we could think of but are happy and eager for more:

Unify the different content forms under a single consolidated theme and design
Ease of navigation ( breadcrumbs )
Preserve markdown for data entry ( we’re programmers ) and keep design separate ( we’re not designers and find this stuff super hard )
A clean, easy to navigate theme with a focus on user experience
Well integrated with our CI and doc generation tooling ( think gitops for docs and content )
Support multiple separate documentations for different versions. See also #5

The related LFX Summer Mentorship Project to submit applications.

Harshita-Kanal commented 3 years ago

I would like to work on this, where can I discuss the implementation ideas?

darach commented 3 years ago

Hi Harshita, I see you've already found our community server - that's a great place to start! 🥳

Licenser commented 3 years ago

Welcome @Harshita-Kanal ! As Darach said feel free to ask any questions you have either here or in the #mentoring channel on our discord.

Applications are handled over at the LFX page: https://mentorship.lfx.linuxfoundation.org/project/336820e5-b46e-4184-a7eb-8f0cb4dd18b4 ; we forgot to add that to the issue, sorry, we added it in now :)

Harshita-Kanal commented 3 years ago

Thanks! 🙂

adithyaakrishna commented 3 years ago

This is a great one and would love to work on this 💯 I guess with this, we can also deal with Issue #5 to support multiple versions of the docs

idontknowjs commented 3 years ago

hey @darach @Licenser can you please share the discord server link, thanks! :)

Licenser commented 3 years ago

Sure it's on the project webpage here is a shortcut: https://bit.ly/tremor-discord

abhi14nexu commented 3 years ago

This looks like an amazing project to work on, I would really like to work on this! :)

adithyaakrishna commented 3 years ago

Hey @abhi14nexu Do join Tremor's Discord Channel, https://bit.ly/tremor-discord

Priyaraj17 commented 3 years ago

Hey everyone, I am interested to be a part of this project... I am interested to work on documentation and also in web design. I am sorry for being this late... :(

govindgoel commented 3 years ago

This is interesting, I look forward to contribute to the project.