galaxyproject / galaxyproject/planemo

Edit this page link for standards broken in planemo docs

Open
#632 1 comment 0 reactions 0 assignees View on GitHub
docs missing help wanted
Dominant language
Python
Stars
110
Forks
102
Avg merge
4d 21h
Merged PRs (30d)
13

Description

1. Goto http://planemo.readthedocs.io/en/latest/standards/docs/best_practices.html
2. Click the link "Edit on GitHub"
3. Goes to https://github.com/galaxyproject/planemo/blob/master/docs/standards/docs/best_practices.rst
3. Observe Error 404 page.

This is included from https://github.com/galaxy-iuc/standards/blob/master/docs/best_practices.rst in the planemo git repository, but that does not get handled automatically by GitHub.

Likely the "Edit on GitHub" definition needs to be special cased for everything under ``docs/standards/``

Contributor guide

Open the contributing guide

Research direction

Start by locating the Edit on GitHub definition used for docs/standards/ and compare it with docs/standards/docs/best_practices.rst, which is included from galaxy-iuc/standards. Verify the generated link for best_practices.html points to the source in galaxy-iuc/standards and no longer returns a 404.

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
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.