corona-warn-app / cwa-documentation

Project overview, general documentation, and white papers. The CWA development ends on May 31, 2023. You still can warn other users until April 30, 2023. More information:
https://coronawarn.app/en/faq/#ramp_down
Apache License 2.0
3.28k stars 344 forks source link

Absolute links in cwa-documentation repository #839

Closed MikeMcC399 closed 2 years ago

MikeMcC399 commented 2 years ago

Where to find the issue

https://github.com/corona-warn-app/cwa-documentation Corona-Warn-App: Documentation repository

Describe the issue

The recent change of the default branch in the Corona-Warn-App: Documentation repository https://github.com/corona-warn-app/cwa-documentation from master to main highlighted some link aspects which could be improved.

Some links in the repository to locations within the repository are absolute.

GitHub help: Relative links says:

"Relative links are easier for users who clone your repository. Absolute links may not work in clones of your repository - we recommend using relative links to refer to other files within your repository."

Suggested change

  1. Change absolute links using https://github.com/corona-warn-app/cwa-documentation to relative links in the repository.

  2. Change absolute links such as https://raw.githubusercontent.com/corona-warn-app/cwa-documentation/master/, which cannot technically be made relative, to use the main branch instead of the master branch.

MikeMcC399 commented 2 years ago