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.

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

Improve kyma-project.io UI #18381

Open
2 of 3 tasks
mmitoraj opened this issue Nov 3, 2023 · 5 comments
Open
2 of 3 tasks

Improve kyma-project.io UI #18381

mmitoraj opened this issue Nov 3, 2023 · 5 comments
Labels
area/documentation Issues or PRs related to documentation

Comments

@mmitoraj
Copy link
Contributor

mmitoraj commented Nov 3, 2023

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.

Area

  • documentation

Reasons

More user-friendly docu

Assignees

@kyma-project/technical-writers

Attachments

@mmitoraj mmitoraj added the area/documentation Issues or PRs related to documentation label Nov 3, 2023
@nataliasitko
Copy link
Contributor

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
Copy link
Contributor

nataliasitko commented Dec 29, 2023

Some additional ideas to be discussed:

  • Google Analytics or investigate other analytics options; first: check legal requirements
  • 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)
  • Edit on GitHub
  • Add Page not found, which would link to Kyma Home
  • 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
Copy link
Contributor

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

Image

Copy link

github-actions bot commented Apr 9, 2024

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 github-actions bot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Apr 9, 2024
Copy link

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

@github-actions github-actions bot closed this as not planned Won't fix, can't repro, duplicate, stale Apr 17, 2024
@kyma-bot kyma-bot added lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. and removed lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. labels Apr 17, 2024
@mmitoraj mmitoraj reopened this Apr 24, 2024
@mmitoraj mmitoraj removed the lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. label Apr 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation Issues or PRs related to documentation
Projects
None yet
Development

No branches or pull requests

4 participants