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

Include a reference to RFC 2119 #565

Open
andylolz opened this issue Aug 7, 2019 · 6 comments
Open

Include a reference to RFC 2119 #565

andylolz opened this issue Aug 7, 2019 · 6 comments

Comments

@andylolz
Copy link
Contributor

andylolz commented Aug 7, 2019

The IATI Standard uses the capitalised keywords "MUST", "SHOULD" etc throughout, but I don’t think it explicitly references RFC 2119 (where these keywords are defined).

RFC 2119 recommends the following:

Authors who follow these guidelines should incorporate this phrase near the beginning of their document:

The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL
NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and
"OPTIONAL" in this document are to be interpreted as described in
RFC 2119.

It would be good to add this.

@samuele-mattiuzzo
Copy link
Contributor

I wonder if that's where our wording comes from, will drag @amy-silcock into this as she might know better

@andylolz
Copy link
Contributor Author

andylolz commented Aug 7, 2019

Great – thanks.

Apart from this API documentation (which I presume was a precursor to the datastore API?) I wasn’t able to find a reference to it.

@amy-silcock
Copy link
Contributor

amy-silcock commented Aug 8, 2019

As far as I know we don't reference it. As part of the standardising the standard work it's something we're looking to add!

And to use the wording around and capitalisation of must/should etc. consistently.

@samuele-mattiuzzo
Copy link
Contributor

I'm going to mark this as blocked pending internal planning for the moment, since we're also undergoing a merge of the Reference Site into the main iatistandard.org portal, and possibly worth looking at this as a part of the whole chunk of work

/cc @andylolz ^

@andylolz
Copy link
Contributor Author

andylolz commented Aug 8, 2019

Great – thanks both

@akmiller01
Copy link
Contributor

Just thinking of where to properly place this reference, I realized that our entire reference.rst file in this repository is essentially unused. It only contains a toctree that's repetitive to the side menu. So maybe we could use that page to cite references like RFC2119 like this: #661

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

No branches or pull requests

4 participants