[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]
Subject: Re: EXT :Re: [openc2] Re: EXT :[openc2] Simplified Branching Strategy Discussion on Slack
Thanks for that annex / appendix tutorial; I've never been clear on that distinction. And I'd agree that the current "annexes" are as critical to the document as my own appendix, and should be renamed accordingly.
Any other votes for just ditching "Annex" C? One thing in there that might be worth saving somewhere is in (new) C.3, where Jason created instructions for using "oasis" and "fork" to refer to the upstream parent document repo and your personal fork, respectively. Somewhat clearer than "upstream" and "origin" when working at the command line
NOTE: the TOC is broken in my PR, I need to update it. Now where did I leave that copy of pandoc . . .
Dave
David Lemire Systems Engineer HII Mission Driven Innovated Solutions (HII-MDIS) Technical Solutions Division
302 Sentinel Drive | Annapolis Junction, MD 20701 Work (301) 575-5190 | Mobile (443) 535-1182 From: duncan sfractal.com <duncan@sfractal.com>
Sent: Tuesday, August 25, 2020 12:24:55 PM To: Lemire, Dave (HII-TSD); openc2@lists.oasis-open.org Subject: EXT :Re: [openc2] Re: EXT :[openc2] Simplified Branching Strategy Discussion on Slack
Great work Dave! Re: “Are those detailed procedures (Annex C) actually useful?” Although I think Annex C is useful, I’m not sure it’s worth the work to keep it up to date as things change. We don’t start that many documents and there are enough online tutorials on how to use github that I don’t think it would hurt
to remove this Annex. As an aside, I think it (and probably the other ones) is an Appendix, not an annex. An Annex (legal definition which is what is usually used by SDO’s) is an integral part of the document. An appendix is supplementary information. A document
could stand alone without the appendices. Duncan Sparrell sFractal Consulting LLC iPhone, iTypo, iApologize I welcome VSRE emails. Learn more at http://vsre.info
[vsre.info]/ From: TC OpenC2 <openc2@lists.oasis-open.org> on behalf of "Lemire, Dave (HII-TSD)" <david.lemire@hii-tsd.com> Follow-up: I've created a PR to update Documentation Norms with the simplified branching strategy. The PR is here
[github.com]. The complete updated version that's the source of the PR can be read here
[github.com]; there are numerous minor tweaks in addition to the changes for the branching strategy.I have not yet carefully updated the procedures in Annex
C, particularly those performed on the command line with a local clone of a personal fork. Are those detailed procedures actually useful? Or just overkill? Dave David Lemire Systems Engineer HII Mission Driven Innovated Solutions (HII-MDIS) Technical Solutions Division 302 Sentinel Drive | Annapolis Junction, MD 20701 Work (301) 575-5190 |
Mobile (443) 535-1182 From: openc2@lists.oasis-open.org <openc2@lists.oasis-open.org> on behalf of Lemire, Dave (HII-TSD) <david.lemire@hii-tsd.com>
Work product editors and interested TC members: there's a discussion on Slack regarding a question that arose as I started itemizing changes to the
Documentation Norms to describe the simplified branching strategy that was discussed at the last TC meeting. You can read the thread at https://openc2-community.slack.com/archives/C2Q818JAU/p1597956545007400
[openc2-community.slack.com] Short form:
Alternative suggestions or concurrences are welcome. Dave David Lemire Systems Engineer HII Mission Driven Innovated Solutions (HII-MDIS) Technical Solutions Division 302 Sentinel Drive | Annapolis Junction, MD 20701 Work (301) 575-5190 |
Mobile (443) 535-1182 |
[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]