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

Clarify headings for dereferencing primary/secondary resource #89

Open
wants to merge 1 commit into
base: gh-pages
Choose a base branch
from

Conversation

peacekeeper
Copy link
Collaborator

This expands the names of the sections about dereferencing the primary/secondary resources.

I'm actually not sure if I am in favor of merging this, since it results in longer headning. But I wanted to capture this since it has been brought up in last week's DID WG meeting.

Copy link

@danpape danpape left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree adding these clarifications this way would make the subsection headings quite large and may mess up the nice table of contents on the respec page. Could the verbiage about what we mean by primary and secondary resources be put in the "4.3 Algorithm" intro paragraph?

@pchampin
Copy link
Collaborator

pchampin commented Sep 12, 2024

This was discussed during the #did meeting on 12 September 2024.

@mccown
Copy link

mccown commented Sep 13, 2024

I would be happy either way on this. The extra text will help guide readers -- especially new readers. However, I don't think it's strictly necessary. Generally, I'm in favor of things that help new adopters.

@peacekeeper
Copy link
Collaborator Author

I agree with @danpape 's comment. The problem here is not the headings, it's that maybe the meanings of "primary resources" and "secondary resource" aren't clear enough. I was trying to use them as they are defined in RFC3986, but am also open to using different terms.

@@ -1028,7 +1028,7 @@ <h2>Algorithm</h2>
</ol>

<section id="dereferencing-algorithm-primary">
<h2>Dereferencing the Primary Resource</h2>
<h2>Dereferencing the Primary Resource (DID document or other resource)</h2>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<h2>Dereferencing the Primary Resource (DID document or other resource)</h2>
<h2>Dereferencing the Primary Resource (DID Document or other resource)</h2>

do we keep these both caps?

@pchampin
Copy link
Collaborator

This was discussed during the #did meeting on 19 September 2024.

View the transcript

DID Resolution PR 88 / 89

"w3c/did-resolution#88

w3c/did-resolution#89"

Simplify dereferencing of the DID fragment based on the media type

Wip: I put this on the agenda. We talked about it last week. Should the primary resource be the DID Document? it says 'first you get the DID Document in resolution, then primary resource...'

<swcurran> +1 to WIP about primary document

markus_sabadello: agree, lets not have a big discussion about the naming of primary and secondary resource. I have been using the terms as introduced in original rfc3936
… PR 88 is an attempt to remove language related to processing the fragment. This depends on the media type
… Currently the text is specific to a JSONLD document. The intent of the PR is to simplify and remove this part
… regarding the discussion of primary and secondary resource lets have a special topic about it. It effects a lot of things

manu: Fine with 88 being merged. Agree there was confusion with primary and secondary resource. I also found the current spec text clear on that
… not blocking 88

decentralgabe: We will plan on a special topic call for 88 and 80 around this resource discussion


Copy link

@OKEAMAH OKEAMAH left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cv

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants