mesos-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Jörg Schad <jo...@mesosphere.io>
Subject Links in documentation
Date Thu, 14 Jan 2016 12:44:17 GMT
Hi,
just a short note about links in our documentation.
In the current documentation we use three different ways to link between
different *.md pages:
1. [label](/documentation/latest/foo/)
2. [label](foo.md)
3. [label](https://github.com/apache/mesos/blob/master/docs/foo.md)

First of all, option 3 should *not* be used as it is rendered incorrectly
onto website* and rather long.

Between option 1 and 2 Neil and myself discussed (MESOS-4295) and are
favoring option 2 as it
- previews better on github
- is shorter
- is easier to maintain multiple versions of the same doc.

Any comments or objections?

Thanks for your feedback!

*In fact it seems that all links ending with .md are interpreted as
relative links on the webpage, i.e. [label](https://test.com/foo.md) is
rendered into <a href="/documentation/latest/https://test.com/foo/
">label</a>.

Mime
  • Unnamed multipart/alternative (inline, None, 0 bytes)
View raw message