apache / apache/accumulo-website

Create a stable way to link to property documentation

Open
#98 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
HTML
Stars
19
Forks
133
Avg merge
9h 37m
Merged PRs (30d)
4

Description

To support linking to property documentation from Javadocs, it would be nice if the website offered stable way to do this. For example the following link could show the docs for the `table.scan.dispatcher` property.

```
https://apache.accumulo.org/docs/property/table.scan.dispatcher
```

Could start off with this redirecting to the docs for the latest version and change the behavior over time.
For example, it could link to the the docs for different versions of a prop and show the description from the latest version.

Contributor guide

Open the contributing guide

Research direction

Start by inspecting the website's existing documentation URL structure and the page for the `table.scan.dispatcher` property. Done means the example property URL resolves reliably and the intended latest-version or version-specific behavior is documented and works consistently.

Written by the indexing model from the issue text.

Assessment

Tech stack
jekyll
Domain
documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.