CSCfi / csc-user-guide

User guides, FAQs and tutorials related to CSC services
https://docs.csc.fi
Creative Commons Attribution 4.0 International
47 stars 83 forks source link

When your project handles personal data #2000

Closed mkannisto closed 7 months ago

mkannisto commented 8 months ago

Proposed changes

I updated the text a little bit, updated the picture, and added the table at the end of the page.

Preview link: https://csc-guide-preview.rahtiapp.fi/origin/SD-WhenYourProjectHandlesPersonalData/accounts/when-your-project-handles-personal-data/

Checklist before requesting a review

rkronberg commented 7 months ago

The link checker detected that some link(s) are broken. See https://github.com/CSCfi/csc-user-guide/blob/master/FAQ.md#my-pr-did-not-pass-the-tests-what-to-do for what to do.

joonas-somero commented 7 months ago

Ah, the perfect opportunity to learn about relative paths. The link in question is pointing to

docs/img/WhenYourProjectHandlesPersonalData_GDPRdocument.png

As it doesn't begin with a / (that would be an absolute path, those are not supported), there's a sort of an implicit ./ prefixed to it

./docs/img/WhenYourProjectHandlesPersonalData_GDPRdocument.png

Since the location of the .md file is accounts/, this equates to

accounts/docs/img/WhenYourProjectHandlesPersonalData_GDPRdocument.png

So, instead of "sort of an implicit .", what we need is an explicit ..

../img/WhenYourProjectHandlesPersonalData_GDPRdocument.png

That is, since absolute paths wouldn't even be supported by MkDocs (although often they do work by accident), we need to use relative paths with . for the current location and .. for the parent.

edit: VS Code will actually guide you if you start typing the link: image

mkannisto commented 7 months ago

Ah, the perfect opportunity to learn about relative paths. The link in question is pointing to

_docs/img/WhenYourProjectHandlesPersonalDataGDPRdocument.png

As it doesn't begin with a / (that would be an absolute path, those are not supported), there's a sort of an implicit ./ prefixed to it

_./docs/img/WhenYourProjectHandlesPersonalDataGDPRdocument.png

Since the location of the .md file is accounts/, this equates to

_accounts/docs/img/WhenYourProjectHandlesPersonalDataGDPRdocument.png

So, instead of "sort of an implicit .", what we need is an explicit ..

_../img/WhenYourProjectHandlesPersonalDataGDPRdocument.png

That is, since absolute paths wouldn't even be supported by MkDocs (although often they do work by accident), we need to use relative paths with . for the current location and .. for the parent.

edit: VS Code will actually guide you if you start typing the link: image

Thanks! I fixed it, hopefully it works now!