Relative links for Project's top level resources

Description

There should be a way to create a relative link in a wiki page to link to the equivalent project's top level pages (like '/issues', '/merge_requests') without hard-coding the full URL.

Proposal

It should be possible to write a wiki page and include a line like:

for a list of open issues go to [[issues]]

and the link should be generated to go to the issues page for the project that has this wiki page.

Links / references

  • Most wiki's have a way to create links that reference other pages within the same wiki, this could be an extension of that.
    • https://en.wikipedia.org/wiki/Wikipedia:Tutorial/Wikipedia_links

Overview

Why should someone use this feature?

  • it'll allow well-written wiki pages to be copied between projects without needing to go through and rewrite links and check them again.

What is the underlying (business) problem?

  • if everything is linked then the wiki should be brought in as part of the "code" of the project as well. Allowing the wiki to reference the project in a connected way would make it easier to create a good wiki for a project.

Use cases

  • a maintainer trying to get a new project started quickly, wants to quickly copy over a good 'code of conduct' or 'contribution guide' over from another project without needing to go through each link and change it.
  • if the repo changes owners, or the repo name changes, or anything changes the links in the wiki will still work.

Feature checklist

Make sure these are completed before closing the issue, with a link to the relevant commit.

  • Feature assurance
  • Documentation
  • Added to features.yml
Edited Aug 21, 2017 by Mark Fletcher
Assignee Loading
Time tracking Loading