Earlier  
Posted Nick Remark
#openstack-nova - 2019-01-10
13:51:31 stephenfin I did the same
13:51:32 kashyap stephenfin: Since we're going to "fix it", should I change it to ---?
13:51:43 stephenfin eh, we'll do it all at once, I suspect
13:51:46 stephenfin local consistency first
13:51:50 kashyap Or stay consistent for now, and do a bulk thingie later?
13:51:52 kashyap Yep
13:51:57 kashyap I'll let it be for now.
13:54:10 kashyap stephenfin: Please remind me again -- on using lower case "nova" vs. upper case?
13:54:44 stephenfin kashyap: https://docs.openstack.org/doc-contrib-guide/writing-style/openstack-components.html
13:56:33 kashyap stephenfin: It doesn't tell _why_
13:56:38 openstackgerrit Yongli He proposed openstack/nova-specs master: add 'show-server-group' spec https://review.openstack.org/612255
13:56:43 kashyap I think it's in the "Service Project Naming"
13:56:56 stephenfin kashyap: For that, you'll have to ask #openstack-doc. I don't actually recall
13:57:08 kashyap [quote]
13:57:09 kashyap The history of this decision is that the documentation contributors wanted the least amount of cognitive overhead when writing and reviewing. Learning rules about case can be difficult across multiple projects with hundreds of documentation contributors and thousands of changes and additions. Lowercase for project names as a rule is then easiest to review and enforce at this scale and growth
13:57:15 kashyap pattern.
13:57:17 kashyap [/quote]
13:57:29 kashyap So it's to lower the cognitive overhead, at the cost of "impure English". Yikes!
13:58:00 cdent why do you think nova should be uppered?
13:58:07 kashyap That's also part of concentration & focus: using the correct capitalization, punctuation, etc. at the right place
13:58:19 kashyap cdent: It's a proper noun
13:58:32 cdent not all proper nouns are upper cased
13:59:07 kashyap True, though. But in this case "intuition" says so :D
13:59:14 kashyap And "Nova" is a special noun
13:59:25 kashyap But anyway, I'll go with the rule, now that I know the history of it.
14:00:16 kashyap cdent: Random internet person says this: https://grammar.yourdictionary.com/capitalization/rules-for-capitalizing-proper-nouns.html
14:00:34 stephenfin kashyap: Where was that quote from?
14:00:49 cdent kashyap: my response to that is "meh" ;)
14:00:51 stephenfin You might add it to that page I linked, if you find the time
14:00:53 kashyap stephenfin: Ha! I read the doc buried in the doc -- https://governance.openstack.org/tc/reference/service-project-naming.html
14:01:12 stephenfin ahh
14:01:14 stephenfin cool :)
14:01:19 kashyap I wonder what else are we doing in the name of "lowering cognitive overhead". There's a time and place for it
14:01:26 kashyap But not with proper nouns. Haha
14:01:42 jangutter "openstack: The meeting name has been set to 'nova' " <---- shouldn't that be "OpenStack: The meeting name has been set to 'Nova' " ?
14:02:18 kashyap jangutter: Heh, there the bot is called 'openstack'; so in that context it's OK :D
14:03:09 jangutter kashyap: hehehe, it's just the Baader-Meinhof Phenomenon
14:04:34 jaypipes alex_xu: feel free to send https://review.openstack.org/#/c/612255/ along
14:04:55 openstackgerrit Maciej Jozefczyk proposed openstack/nova master: Add fill_virtual_interface_list online_data_migration script https://review.openstack.org/614167
14:06:34 alex_xu jaypipes: done
14:06:44 openstackgerrit Maciej Jozefczyk proposed openstack/nova master: Force refresh instance info_cache during heal https://review.openstack.org/591607
14:07:31 stephenfin bauzas: You think https://blueprints.launchpad.net/nova/+spec/libvirt-neutron-sriov-livemigration is something you could revisit today?
14:08:22 stephenfin and maybe jaypipes, for the first time? ^
14:08:44 stephenfin I ask because I have reviewed most of the implementation, and it's pretty straightforward. Also, it's a long time bugbear of mine
14:09:11 jaypipes ack. will get to that shortly stephenfin
14:09:19 stephenfin thank you sir
14:11:30 openstackgerrit Stephen Finucane proposed openstack/nova stable/queens: Fail to live migration if instance has a NUMA topology https://review.openstack.org/629597
14:19:17 openstackgerrit Merged openstack/nova-specs master: add 'show-server-group' spec https://review.openstack.org/612255
14:20:26 yonglihe alex_xu, Jay, thanks. Have a good one.
14:20:44 kashyap stephenfin: Is a single back-tick OK here: :oslo.config:option:`libvirt.live_migration_with_native_tls`
14:20:49 kashyap Or does it require a double back-tick?
14:20:52 stephenfin single
14:21:00 stephenfin double is only used for literals
14:21:16 stephenfin single backticks means "default role", which is configurable but defaults to italics
14:21:32 stephenfin single backticks without the :xyz: prefix for an explicit role
14:21:46 kashyap stephenfin: I see, thanks for the education.
14:25:40 kashyap stephenfin: One last English nit-pick: you suggest "commas" in the place of em-dash, e.g. look at point 2 in the "Prerequisites" section: http://logs.openstack.org/27/629627/2/check/openstack-tox-docs/dc52e37/html/admin/secure-live-migration-with-qemu-native-tls.html
14:26:00 stephenfin yup?
14:26:02 kashyap It makes sense to retain that there.
14:26:21 kashyap Because the content between the em-dashes can also be used in brackets, _or_ two commas.
14:27:17 stephenfin kashyap: True, em dash ~= comma
14:27:26 stephenfin but I tend to see them used more for asides
14:27:28 kashyap Sure.
14:27:45 stephenfin something not directly related to the main sentence
14:27:53 stephenfin i.e.
14:27:54 kashyap In this case I've used it in place of two commas (which is also used for bracketed content)
14:28:23 stephenfin I was on the way home, driving on the motorway, when I saw a cat
14:28:25 stephenfin vs.
14:28:45 stephenfin I was on the way home -- a needless endeavour, it turned out -- when I saw a cat
14:29:04 stephenfin I don't know if that's correct, but that's how _I've_ done it :)
14:29:11 kashyap Hehe, I see your point there
14:29:14 kashyap But, in this case:
14:29:16 kashyap "A pre-configured TLS environment—i.e. CA, server, and client certificates, their file permissions, et al—must be “correctly” configured (typically by an installer tool) on all relevant compute nodes."
14:29:19 jaypipes kashyap: em-dash ftw.
14:29:24 stephenfin fair :)
14:29:27 kashyap Replacing those em-dashes with more commas is fugly
14:29:29 jaypipes stephenfin: :P
14:29:31 kashyap I can use brackets, though.
14:29:54 stephenfin Just space them out either side and I'm happy (not sure if that's correct but it's tough to read otherwise)
14:30:02 stephenfin jaypipes: I blame asettle
14:30:22 jaypipes heh :)
14:30:24 kashyap stephenfin: Haha, you know ... I have read the literature on the _spacing_ too
14:30:40 kashyap stephenfin: When the doc is rendered, a space between two em-dashes attract too much attention to the em-dash iself.
14:30:43 kashyap s/iself/itself/
14:30:48 kashyap See the fine point? :D
14:31:06 kashyap That was also a conscious (and consistent) choice throughout the doc
14:31:37 kashyap But if you insist, you know, in the name of civility I will happily add the spaces (consistently through out) :-)
14:31:37 stephenfin :D
14:31:53 kashyap stephenfin: I don't joke when I say I take my English seriously :D
14:32:09 stephenfin Noted :D
14:32:24 kashyap Sorry, if I'm taxing your brain. I like these pedantics, I know you do, too.
14:32:27 jangutter kasyap: obligatory https://imgs.xkcd.com/comics/third_way.png
14:33:06 kashyap stephenfin: I dislike the past tense :-(
14:33:30 kashyap The team no longer exists now? And all docs are taken care of by relavant components?
14:34:42 stephenfin Still there but only for things like the contributor guide that don't have a home elsewhere
14:34:43 kashyap jangutter: Two spaces after a period is, of course, the correct thing. It gives the brain a "breathing room" between the sentences, dammit.
14:35:04 kashyap stephenfin: I see. But I can still enjoy working on the Nova docs to my heart's content
14:35:10 kashyap stephenfin: LOL, I know your view on that
14:35:28 jangutter kashyap: Them's fighting words.
14:42:45 edleafe kashyap: I like how the iPhone settled it. You type two spaces, and it inserts a period and a single space. :)

Earlier   Later