apache / apache/iceberg

[docs] Indicate navigation links that take the user to an external site

Open
#13,514 4 comments 0 reactions 0 assignees View on GitHub
improvement website
Dominant language
Java
Stars
9.2k
Forks
3.5k
Avg merge
2d 16h
Merged PRs (30d)
129

Description

### Feature Request / Improvement

The Iceberg docs left-hand nav currently has a mixture of links to within the docs, and those external such as third-party sites.
The UX of this can grate, because the user is never sure when they're leaving the Iceberg docs or not.

We should update the docs so that link use one of the generally recognised icons to indicate an external link such as https://fontawesome.com/v4/icon/external-link

Image

### Query engine

None

### Willingness to contribute

- [x] I can contribute this improvement/feature independently
- [ ] I would be willing to contribute this improvement/feature with guidance from the Iceberg community
- [ ] I cannot contribute this improvement/feature at this time

Contributor guide

Open the contributing guide

Research direction

Start by locating the Iceberg docs left-hand navigation configuration and review how its internal and external links are defined. Update the external entries to use a recognised external-link icon, then verify that external destinations are visibly distinguishable from links within the docs.

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
Quiet
Clarity
Mostly clear
Newbie friendliness
67/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.