Improve kyma-project.io UI

kyma-project / kyma

Kyma is an opinionated set of Kubernetes-based modular building blocks, including all necessary capabilities to develop and run enterprise-grade cloud-native applications.

https://kyma-project.io

Apache License 2.0

1.51k stars 407 forks source link

Improve kyma-project.io UI #18381

Open mmitoraj opened 8 months ago

mmitoraj commented 8 months ago

Description

The kyma-project.io website is now a very basic one when it comes to its UI. It lacks some features that would make it more user-friendly and better-looking.

Let's use some time to investigate Docsify plugins and implement those that could be useful for our users.

[x] https://github.com/jperasmus/docsify-copy-code - copy-code plugin
[x] https://github.com/imyelo/docsify-pagination#readme - pagination plugin
[ ] ?

Area

documentation

Reasons

More user-friendly docu

Assignees

@kyma-project/technical-writers

Attachments

nataliasitko commented 6 months ago

Docsify allows for using red and blue notes. You just add !> **CAUTION** or ?> **NOTE** and it’s rendered like in the screenshots. In my opinion, it looks really nice. Screenshot 2023-12-29 at 12 43 24 Screenshot 2023-12-29 at 12 54 25 Unfortunately, there are no green notes available for tips (we rarely use them anyway), and when you add two notes one after another, they’re not indented correctly (a workaround would be to join such notes) Screenshot 2023-12-29 at 12 45 01 Screenshot 2023-12-29 at 12 36 03

nataliasitko commented 6 months ago

Some additional ideas to be discussed:

[ ] Google Analytics or investigate other analytics options; first: check legal requirements
[x] Beautify cautions and notes: use the Docsify solution (see the comment) or the Flexible Alerts plugin (even better, but I haven't tested it yet)
[x] Edit on GitHub
[ ] Add Page not found, which would link to Kyma Home
[x] I was wondering if we could use a shade of blue in UIs that matches the one used in the Kyma logo. It might create better contrast and make UIs more noticeable in dark mode
[ ] Find out if that's possible to make the footer stick to the bottom of a page when a document is short

NHingerl commented 5 months ago

I was wondering if we could use a shade of blue in UIs that matches the one used in the Kyma logo. It might create better contrast and make UIs more noticeable in dark mode

github-actions[bot] commented 3 months ago

This issue has been automatically marked as stale due to the lack of recent activity. It will soon be closed if no further activity occurs. Thank you for your contributions.

github-actions[bot] commented 2 months ago

This issue has been automatically closed due to the lack of recent activity. /lifecycle rotten

github-actions[bot] commented 2 weeks ago

This issue has been automatically marked as stale due to the lack of recent activity. It will soon be closed if no further activity occurs. Thank you for your contributions.