apache / apache/hop

[Task]: Create global documentation variables

Open
#3,297 0 comments 0 reactions 0 assignees View on GitHub
awaiting triage Documentation P2
Dominant language
Java
Stars
1.5k
Forks
476
Avg merge
18h 32m
Merged PRs (30d)
216

Description

### What needs to happen?

We currently have errors creeping in the documentation in locations where we are using version numbers and other more release related dynamic content.

We should create global variables such as our current version or current supported version for Beam.
Then we can update 1 page with these variables on each release and have all our documentation correctly synced

### Issue Priority

Priority: 2

### Issue Component

Component: Documentation

Contributor guide

Open the contributing guide

Research direction

The issue names no files, tests, or entry points. Start by locating documentation pages that contain version numbers and the release process used to update them, then determine how shared documentation variables could be supported; done means one release update keeps all affected references synchronized.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.