[GitHub] [trafficcontrol] rob05c commented on issue #4628: Add ORT Rewrite Blueprint

[GitBox <gi...@apache.org>]

rob05c commented on issue #4628: Add ORT Rewrite Blueprint
URL: https://github.com/apache/trafficcontrol/pull/4628#issuecomment-612160310
 
 
   >On the other hand, if the plan is also to include the necessary parts of ATSTCCFG as part and parcel of the utilities (as opposed to the separate utility it is today) 
   
   The plan is for each app to be small and independent. They could be totally different languages if we want. The config generator is one app, and will probably be a modified version of `atstccfg`. But there's nothing preventing the other apps from being in other languages.
   
   >I'd be happy to help move ORT.py
   
   I'm not opposed to that. Personally, I'd prefer we were more open to more diverse languages. Especially for small apps like these, where it's not a big deal if a new primary developer doesn't like the language, they can just rewrite it, because it's very small.
   
   I also don't object to Python specifically, especially for small things, especially if it includes type annotations and compiling in the build.
   
   If you're the one writing these apps, I wouldn't have any objections. But I'd prefer to leave it up to whoever writes it. Personally, Go would be faster for me and I already have a good grasp of traffic_ops_ort.pl at this point. But I may not be the one writing it, either.
   
   >parts of ATSTCCFG
   
   I'd strongly encourage referring to the command in its proper case, atstccfg. In technical writing it's imperative to not confuse the reader. The application is `atstccfg`, executing `./atstccfg` will not work.
   
   I'm not aware of a universally-accepted technical writing style guide, but the Microsoft Style Guide is one of the most popular. It says 
   https://docs.microsoft.com/en-us/style-guide/capitalization
   
   >Capitalize the first word of labels and terms that appear in UI and APIs unless they're always lowercase (for example, fdisk).
   > In programming languages, follow the traditional capitalization of keywords and other special terms.
   
   And
   
   >Always capitalize the first word of a new sentence. Rewrite sentences that start with a word that's always lowercase.
   

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services