eiffel-community/eiffel-intelligence

EI Pages in 2.0.0-maintainance branch point to documentation on the master

Open

#483 opened on Nov 17, 2020

View on GitHubContributor guide
 (0 comments) (0 reactions) (0 assignees)Java (78 forks)auto 404
buggood first issue

Repository metrics

Stars
 (12 stars)
PR merge metrics
 (PR metrics pending)

Description

Description

Some of the documentation in 2.0.0-maintainance branch points out to the master branch which doesn't exist

Motivation

Updated documentation pointing out to proper branches and reachable documentation pages.

Exemplification

Here is an example of such page : https://github.com/eiffel-community/eiffel-intelligence/blob/2.0.0-maintenance/wiki/markdown/rules.md#Rule-set-up

Under the History Rules, when you click the here it points out to the master branch and that documentation is not available, instead it should point out to the 2.0.0-maintainance branch documentation itself.

Benefits

Readability of documentation and pointing out to the correct version of the documentation.

Possible Drawbacks

Unreachable pages and confusion to users on the documentation

Contributor guide

Research direction
Identify all documentation files in the 2.0.0 maintenance branch that contain links pointing to 'master' branch and replace them with the current branch name (2.0.0 maintenance).
Tech stack
None
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90