-
Notifications
You must be signed in to change notification settings - Fork 647
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
Conversation
Well-Known-Specification.md
Outdated
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). |
There was a problem hiding this comment.
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:
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`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done
Well-Known-Specification.md
Outdated
@@ -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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Well-Known-Specification.md
Outdated
Website Site (RWS). | ||
## Content | ||
|
||
The `/.well-known/related-website-set.json` file for the set primary of an RWS |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nit: trailing whitespace
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 |
Well-Known-Specification.md
Outdated
} | ||
} | ||
``` | ||
The `/.well-known/related-website-set.json` file for set members of an RWS |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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 |
Well-Known-Specification.md
Outdated
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). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Website Site (RWS). | |
Website Site (RWS). |
Well-Known-Specification.md
Outdated
} | ||
} | ||
``` | ||
The `/.well-known/related-website-set.json` file for set members of an RWS |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Looks like you've passed all of the checks! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, thanks!
There was a problem hiding this 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
* Create Well-Known-Specification.md
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.