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

[Minor Issue] Inconsistent capitalization of "Image", "Director", and "Target" repositories #116

Closed
plapczyn opened this issue Jun 19, 2019 · 7 comments
Milestone

Comments

@plapczyn
Copy link
Contributor

It seems to be about 50/50 that we capitalize "Image" "Director", and "Target" when talking about the repositories. We should make a decision one way or another and make the document consistent.

@jhdalek55
Copy link
Contributor

jhdalek55 commented Jun 19, 2019 via email

@trishankatdatadog trishankatdatadog added this to the Uptane 1.0 milestone Jun 19, 2019
@iramcdonald
Copy link

iramcdonald commented Jun 19, 2019 via email

@jhdalek55
Copy link
Contributor

If we are agreed that Image, Target and Director should always be capitalized, I can probably do a pass early this week and correct all these. Should I change Primary and Secondary as well, as per Ira's suggestion?

@iramcdonald
Copy link

iramcdonald commented Jun 24, 2019 via email

@jhdalek55
Copy link
Contributor

Fine. I'll take care of this.

Lois

jhdalek55 added a commit to jhdalek55/uptane-standard that referenced this issue Jul 2, 2019
I've now gone through and have made sure  instances of proper names for roles, ECUs, and metadata are capitalized. I also fixed some inconsistent capitalization in headings and subheads. Now only the first word in headings is capitalized, except where proper nouns appear. This addresses  Issue uptane#116.

I also addressed the one element in Issue uptane#119. That is I've included the missing definition of "metadata." For this, I followed Ira's suggestion and included both the NIST definition and the version proposed by @mcvand in discussion on the issue.
I also added definitions for three acronyms used in the document that were never defined.
Lastly I fixed a handful of sentences that to my eye had structural.
I was going to add the citations to our definitions at the beginning of the document, per @iramcdonald. But I don't know how to set up the citations in Markdown using this particular format. If someone can let me know how, I can take care of that, but probably not until early next week. If another team member could step in and do this, I would likely be faster.
@jhdalek55
Copy link
Contributor

PR#125 takes care of this concern.

tkfu pushed a commit that referenced this issue Jul 3, 2019
* Addressing Issue #116 and one item in issue #119

I've now gone through and have made sure  instances of proper names for roles, ECUs, and metadata are capitalized. I also fixed some inconsistent capitalization in headings and subheads. Now only the first word in headings is capitalized, except where proper nouns appear. This addresses  Issue #116.

I also addressed the one element in Issue #119. That is I've included the missing definition of "metadata." For this, I followed Ira's suggestion and included both the NIST definition and the version proposed by @mcvand in discussion on the issue.
I also added definitions for three acronyms used in the document that were never defined.
Lastly I fixed a handful of sentences that to my eye had structural.
I was going to add the citations to our definitions at the beginning of the document, per @iramcdonald. But I don't know how to set up the citations in Markdown using this particular format. If someone can let me know how, I can take care of that, but probably not until early next week. If another team member could step in and do this, I would likely be faster.

* Addition changes per Jon Oster's comments

Hopefully this meets the request changes.
@jhdalek55
Copy link
Contributor

This issue can now be closed via PR#125.

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

No branches or pull requests

4 participants