apache / apache/pekko-site

Index page is very complicated

Open
#99 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
HTML
Stars
58
Forks
15
Avg merge
5h 7m
Merged PRs (30d)
5

Description

The index page is very difficult to follow. For someone new to the product, how do they decide which box to choose? Also some TLAs are not explained, for example FSM.

I think it would be clearer if the getting started entries were grouped by type (Cluster, Distributed Data etc), and the different implementations (Java, Scala, Docker etc) relegated to secondary index pages.

Also the index page does not make clear what languages and OSes are supported.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with the index page and trace its getting-started entries, noting how the Cluster and Distributed Data groupings relate to the Java, Scala, and Docker implementations. Check how FSM and other TLAs are introduced, then verify that the revised navigation explains the supported languages and operating systems and separates secondary implementation indexes.

Written by the indexing model from the issue text.

Assessment

Tech stack
docker, html, java, scala
Domain
content, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.