Skip to content

New documentation landing page #214

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

Closed
Tracked by #356 ...
fhennig opened this issue Jun 16, 2022 · 1 comment · Fixed by #492
Closed
Tracked by #356 ...

New documentation landing page #214

fhennig opened this issue Jun 16, 2022 · 1 comment · Fixed by #492

Comments

@fhennig
Copy link
Contributor

fhennig commented Jun 16, 2022

As a user visiting the landing page, I want to get a quick overview of the documentation content and quickly navigate to the information I want.

Currently, the top menu is basically the only entrypoint into the content.

The introductory text currently at the top of the landing page is probably more suited for a concepts/background/explanation page, or even for stackable.tech.

Current Idea

Some of the documentation I like uses tiles (see examples below, with tiles we can show people what we think is important, and write a sentence of description on the tile as well, to help first time users quickly find what they need.

image

Examples from other documentation sites

Docker

2023-10-17_09-48

GitLab

2023-10-17_09-48_1

Datahub

2023-10-17_09-49

GitHub

2023-10-17_09-52

@fhennig
Copy link
Contributor Author

fhennig commented Nov 1, 2023

@lfrancke ping

@fhennig fhennig moved this to Development: Done in Stackable Engineering Dec 6, 2023
@lfrancke lfrancke moved this from Development: Done to Done in Stackable Engineering Dec 11, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

2 participants