-
Notifications
You must be signed in to change notification settings - Fork 126
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Allow Trailing Slashes within HTMLTest #1170
Comments
@StackScribe, i think we should remove the trailing slash check |
I am happy with that solution but I could also live with having to do the /index.md structure as well. Frankly, the quality of our markdown code seems like a much lower priority than being able to quickly improve the content and organization so favor solutions that don't impede that work. |
aepfli
added a commit
to aepfli/lifecycle-toolkit
that referenced
this issue
Apr 3, 2023
As explained in keptn#1170, we do have issues with creating documentations without a separate folder and linking to them. To ease developer experience we remove this check. Although we might encounter redirects within the documentation. Signed-off-by: Simon Schrottner <simon.schrottner@dynatrace.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
We enforced trailing slashes within our docs to reduce redirects. This was no issue as long as we structured our documentation with
<documentName>/_index.md
. But it causes problems with the more accessible and more straightforward way of naming them simply<documentName>.md
without an own folder.Detailed Description
To visualize this; we take a look at this structure
If we link from
root.md
todoc1/_index.md
, we can use this syntax[link](doc1\)
with a trailing slash, signalizing that this is a folder and that there will be no redirect. (works with HTMLtest and markdown-link-check).If we link from
root.md
todoc2.md
, it gets complicated, we can use this syntax:[link](doc2)
, this is correct each IDE will detect it - but it will be a redirected link within Hugo, hence that HTMLtest will complain about the missing trailing slash[link](doc2/)
, with a trailing slash, signalizing that this is a folder and that there will be no redirect. This will work with HTMLtest, and will work with the rendered page, but it won't work within IDEs and markdown-link-check.Proposal
As I do think both ways of naming and creating documentation are valid, and the one without a folder provides a nicer experience. I suggest removing the trailing slash check within HTMLtest
The text was updated successfully, but these errors were encountered: