ui icon indicating copy to clipboard operation
ui copied to clipboard

docs: include .md extension for relative links

Open amcgee opened this issue 2 years ago • 4 comments

Relative links without the .md extension break when there is a trailing slash in the browser URL:

https://ui.dhis2.nu/components/calendar-input + ./calendar => https://ui.dhis2.nu/components/calendar https://ui.dhis2.nu/components/calendar-input/ + ./calendar => https://ui.dhis2.nu/components/calendar-input/calendar (404)

Docusaurus should handle this for us properly by resolving absolute link targets when the source file references another .md in the source (bonus: this should also work when browsing the docs source on github)

See https://github.com/facebook/docusaurus/issues/2298

amcgee avatar Mar 01 '23 15:03 amcgee

@Topener we probably want to check the links across the documentation site to make sure none are broken and that we use .md extensions for all relative links.

I also noticed that the "edit this page" links are broken, probably need to update the docusaurus configuration

amcgee avatar Mar 01 '23 15:03 amcgee

🚀 Deployed on https://pr-1243--dhis2-ui.netlify.app

dhis2-bot avatar Mar 01 '23 16:03 dhis2-bot

1 failed tests on run #2816 ↗︎

1 583 0 0 Flakiness 0

Details:

docs: use .md for relative calendar link
Project: ui Commit: f1582f50d4
Status: Failed Duration: 09:05 💡
Started: Mar 1, 2023 4:29 PM Ended: Mar 1, 2023 4:38 PM
Failed  components/calendar/src/features/supports_calendar_clear_button.feature • 1 failed test • e2e

View Output Video

Test
The Calendar allows clearing the selection > Clear the selection in the Gregorian calendar Screenshot

This comment has been generated by cypress-bot as a result of this project's GitHub integration settings.

cypress[bot] avatar Mar 01 '23 16:03 cypress[bot]

Ah this is interesting, and honestly a bit weird it breaks like that. But good find. We should indeed check if anything else is broken but there's a LOT to dig through!

Topener avatar Mar 02 '23 14:03 Topener