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

Create Well-Known-Specification.md #121

Merged
merged 2 commits into from
Nov 16, 2023
Merged

Conversation

sjledoux
Copy link
Collaborator

In order to register the /.well-known/related-website-set.json URI, Well-Known-Specification.md should be created so that we have a dedicated reference page that describes the purpose and content of the /.well-known/related-website-set.json file.

@sjledoux sjledoux requested review from cfredric and helenyc November 15, 2023 18:01
Comment on lines 7 to 10
A page may be hosted at the URI having the path of
`/.well-known/related-website-set.json` in order to demonstrate
administrative access to the site when submitted as an entry in a Related
Website Site (RWS).
Copy link
Collaborator

Choose a reason for hiding this comment

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

Please use active voice to make this clearer:

Suggested change
A page may be hosted at the URI having the path of
`/.well-known/related-website-set.json` in order to demonstrate
administrative access to the site when submitted as an entry in a Related
Website Site (RWS).
A site may demonstrate intentional opt-in to participating in a Related Website Set (RWS) by hosting a specific JSON file at the URI with a path of
`/.well-known/related-website-set.json`.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Done

@@ -0,0 +1,68 @@
# The "related-website-set.json" Well-Known Resource Identifier

This page describes the use and content of URIs having the path
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
This page describes the use and content of URIs having the path
This page describes the use and content of URIs with the path

Nit: "having" feels like odd word choice to me.

Website Site (RWS).
## Content

The `/.well-known/related-website-set.json` file for the set primary of an RWS
Copy link
Collaborator

Choose a reason for hiding this comment

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

Nit: trailing whitespace

Suggested change
The `/.well-known/related-website-set.json` file for the set primary of an RWS
The `/.well-known/related-website-set.json` file for the set primary of an RWS

}
}
```
The `/.well-known/related-website-set.json` file for set members of an RWS
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
The `/.well-known/related-website-set.json` file for set members of an RWS
The `/.well-known/related-website-set.json` file for set members of an RWS

A page may be hosted at the URI having the path of
`/.well-known/related-website-set.json` in order to demonstrate
administrative access to the site when submitted as an entry in a Related
Website Site (RWS).
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
Website Site (RWS).
Website Site (RWS).

}
}
```
The `/.well-known/related-website-set.json` file for set members of an RWS
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
The `/.well-known/related-website-set.json` file for set members of an RWS
The `/.well-known/related-website-set.json` file for non-primary members of an RWS

"set members of an RWS" feels redundant, and I think we also need to specify that we're not talking about the primary sites.

Copy link

Looks like you've passed all of the checks!

Copy link
Collaborator

@cfredric cfredric left a comment

Choose a reason for hiding this comment

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

LGTM, thanks!

@cfredric cfredric merged commit bc54b51 into main Nov 16, 2023
4 checks passed
@cfredric cfredric deleted the Create-separate-wellknown-schema branch November 16, 2023 20:06
Copy link

@mostafakn mostafakn left a comment

Choose a reason for hiding this comment

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

Well-Known-Specification.md

cfredric pushed a commit to cfredric/chrome-first-party-sets that referenced this pull request Mar 11, 2024
* Create Well-Known-Specification.md
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.

4 participants