Docs: Fix broken links on generated site #2600
Conversation
slim-bean
requested review from
achatterjee-grafana and
oddlittlebird
as code owners
|
In order to work in the build, all links need to be relref links. Format is: |
Which are you talking about? The external links? |
Codecov Report
@@ Coverage Diff @@
## master #2600 +/- ##
==========================================
- Coverage 62.95% 62.95% -0.01%
==========================================
Files 169 169
Lines 15018 15018
==========================================
- Hits 9455 9454 -1
+ Misses 4809 4807 -2
- Partials 754 757 +3
|
|
Nope. All links in the doc site to internal documentation need to be relref
links.
https://github.com/grafana/grafana/tree/master/docs#using-relref-for-internal-links
…On Fri, Sep 4, 2020 at 7:29 AM Codecov Comments Bot < ***@***.***> wrote:
Codecov <https://codecov.io/gh/grafana/loki/pull/2600?src=pr&el=h1> Report
Merging #2600
<https://codecov.io/gh/grafana/loki/pull/2600?src=pr&el=desc> into master
<https://codecov.io/gh/grafana/loki/commit/409eb31a5cd1cf3e332b1406a3f377e6a203dabb?el=desc>
will *decrease* coverage by 0.00%.
The diff coverage is n/a.
[image: Impacted file tree graph]
<https://codecov.io/gh/grafana/loki/pull/2600?src=pr&el=tree>
@@ Coverage Diff @@
## master #2600 +/- ##
==========================================
- Coverage 62.95% 62.95% -0.01%
==========================================
Files 169 169
Lines 15018 15018
==========================================
- Hits 9455 9454 -1
+ Misses 4809 4807 -2
- Partials 754 757 +3
Impacted Files
<https://codecov.io/gh/grafana/loki/pull/2600?src=pr&el=tree> Coverage Δ
pkg/promtail/targets/file/tailer.go
<https://codecov.io/gh/grafana/loki/pull/2600/diff?src=pr&el=tree#diff-cGtnL3Byb210YWlsL3RhcmdldHMvZmlsZS90YWlsZXIuZ28=> 70.83%
<0.00%> (-4.17%) ⬇️
pkg/promtail/targets/file/filetarget.go
<https://codecov.io/gh/grafana/loki/pull/2600/diff?src=pr&el=tree#diff-cGtnL3Byb210YWlsL3RhcmdldHMvZmlsZS9maWxldGFyZ2V0Lmdv> 66.85%
<0.00%> (+0.57%) ⬆️
pkg/querier/queryrange/downstreamer.go
<https://codecov.io/gh/grafana/loki/pull/2600/diff?src=pr&el=tree#diff-cGtnL3F1ZXJpZXIvcXVlcnlyYW5nZS9kb3duc3RyZWFtZXIuZ28=> 97.93%
<0.00%> (+2.06%) ⬆️
—
You are receiving this because your review was requested.
Reply to this email directly, view it on GitHub
<#2600 (comment)>, or
unsubscribe
<https://github.com/notifications/unsubscribe-auth/AMNF6KMSAXPZ2TFYNERWLF3SED2SZANCNFSM4QYOFEZA>
.
--
Diana Payton (She/Her)
Sr. Technical Writer at Grafana Labs
|
|
That seems untenable and unnecessary? The links definitely work as is. Asking users to understand the bizarre hugo syntax for this seems unnecessary to me? Especially when they work without it. Are there other reasons this would be helpful or necessary I'm not aware of? |
|
That is a @robbymilo question |
|
Ok, I will follow up with Robby! I would like to merge this as is however because all these links are currently broken and this will unbreak them. If we need to go through and replace all our internal links with relref style I think that might be best done in a separate PR where we can sweep the entire site. |
|
I looked at the docs for relref and it looks like it would allow writing the links to the exact file names with the .md extension, I can see some benefits here for sure. My concern would be how difficult this makes adding new docs unless you are familiar with Hugo, that being said it's still going to be easy to get them wrong as non relref links if you accidentally link to the markdown. Ultimately I want to get the htmltest app I used to find all these into our CI so either way broken links are caught. I'm also wondering if there is a hugo linter we could use to automate suggesting of the relref link style whenever someone links to a .md file |
This is not required for the build to work, just a nice to have. @oddlittlebird @slim-bean |
No description provided.