search

uptane / deployment-considerations

Deployment Considerations and Best Practices for Uptane
Apache License 2.0
4 stars 8 forks source link

Fix missing citation on Glossary page #144

Closed jhdalek55 closed 1 year ago

jhdalek55 commented 1 year ago

If one goes to the Glossary page on this repo, the opening sentence appears to be incomplete. What is missing is the citation to RFC 2119. The Glossary was moved from the Standard in September of 2021. The citation is correct in the text, but doesn't appear in the website copy because the citations are missing on this repo.

I didn't set up the citations page on this repo and I'm not sure how to do so. Can I get a volunteer to fix this, or at the very least, tell me how to do it?

jhdalek55 commented 1 year ago

@mnm678 can you take a look at this and let me know if its something you can take care of...or talk me through how to do it?

mnm678 commented 1 year ago

It looks like that used to link to this part of the Standard: https://github.com/uptane/uptane-standard/blob/master/uptane-standard.md#keyword-def-shall-may-should-etc. You could just copy that section to the glossary (in the same header as seen here; https://raw.githubusercontent.com/uptane/uptane-standard/master/uptane-standard.md), and it should fix the link

jhdalek55 commented 1 year ago

Ok...forgive me for being a bit dense, but I'm not sure where I would paste this. The Standard has only one file. Deployment has many.