Skip to content
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

Broken link to dpv document #301

Open
tanjadegroot opened this issue Sep 17, 2024 · 4 comments · May be fixed by #311
Open

Broken link to dpv document #301

tanjadegroot opened this issue Sep 17, 2024 · 4 comments · May be fixed by #311
Assignees
Labels
correction correction in documentation

Comments

@tanjadegroot
Copy link
Contributor

Problem description
in the https://github.com/camaraproject/Commonalities/blob/main/documentation/API-design-guidelines.md, section 11.6, the link to the "purpose section" is broken.

Expected behavior
Rewrite the section to remove the link to the external doc from this doc (which can just point to the ICM profile doc) to avoid maintenance problems between these 2 documents. Only keep the external link to W3C in the ICM doc.

Alternative solution
Fix the broken link to point to v2.0 (but I would avoid)

Additional context

@tanjadegroot tanjadegroot added the correction correction in documentation label Sep 17, 2024
@jpengar
Copy link
Collaborator

jpengar commented Sep 17, 2024

@tanjadegroot This same issue was raised in camaraproject/IdentityAndConsentManagement#195 for ICM documentation, fixed in camaraproject/IdentityAndConsentManagement#196, and resulted in camaraproject/IdentityAndConsentManagement#202 to generate a r0.2.1 patch release with the fix. But if you're referring to https://github.com/camaraproject/Commonalities/blob/main/documentation/API-design-guidelines.md, shouldn't this issue be opened in Commonalities WG, and perhaps refer to ICM's camaraproject/IdentityAndConsentManagement#195 for further context?

@tanjadegroot
Copy link
Contributor Author

tanjadegroot commented Sep 17, 2024

Oops, sorry indeed, I picket the wrong project :-( Is there a way to move the issue ? Or I can delete and recreate there

@jpengar
Copy link
Collaborator

jpengar commented Sep 17, 2024

There is a Transfer issue option, but I'm not allowed to transfer this issue to the Commonalities subproject. Not sure if @hdamker or others can do this. If not, we can close this issue and just open a copy of it in Commonalities.

@hdamker
Copy link
Collaborator

hdamker commented Sep 17, 2024

@hdamker or others can do this. If not, we can close this issue and just open a copy of it in Commonalities.

Yes, I can do (requirement is write access in both repositories).

@hdamker hdamker transferred this issue from camaraproject/IdentityAndConsentManagement Sep 17, 2024
@rartych rartych self-assigned this Oct 9, 2024
@rartych rartych linked a pull request Oct 9, 2024 that will close this issue
@rartych rartych linked a pull request Oct 14, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
correction correction in documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants