crate / crate/cratedb-guide

Feedback on /install: Improve discoverability

Open
#483 2 comments 1 reaction 0 assignees View on GitHub
Dominant language
No language data
Stars
3
Forks
4
Avg merge
3d 18h
Merged PRs (30d)
1

Description

### Documentation feedback


- Page title: Install
- Page URL: https://cratedb.com/docs/guide/install/index.html
- Source: https://github.com/crate/cratedb-guide/blob/main/docs/install/index.md

---

@hammerhead reported the page is currently not easy to discover, because the new "Getting started" section pulls too much attention. Also discovering it by inline search does not work, because two other pages pull too much attraction.

Image

- https://cratedb.com/docs/sqlalchemy-cratedb/install.html
- https://cratedb.com/docs/jdbc/en/latest/getting-started.html

At least, web crawlers / search engines get it right.

- https://www.google.com/search?q=install+cratedb
- https://www.startpage.com/sp/search?q=install+cratedb

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with docs/install/index.md and compare its navigation context with the Getting started section and the linked SQLAlchemy and JDBC pages. Investigate how these pages affect navigation and inline search, then confirm that the Install page is easier to discover without harming the linked documentation.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.