search

OpenC2-org / openc2-org

The Open Command and Control Forum promotes the global development and adoption of the OpenC2 language and reference material.
Other
30 stars 4 forks source link

Use Markdown instead of DOCX #2

Closed pwrdwnsys closed 7 years ago

pwrdwnsys commented 8 years ago

The current DOCX format for the documentation means that Github can't show users the changes that are being made ("Binary file not shown.")

By changing the documents to Markdown, Github can directly show the changes which are being made, and should also be more accessible for contributions from those without Microsoft Word (or LibreOffice).

romanojd commented 8 years ago

Great suggestion! I currently have the details of the Language Description Document formatted in markdown, but not the front matter. I can make the translation prior to the next updates. We can use v1.0 as the initial baseline going forward.

davaya commented 8 years ago

Github also previews PDF nicely, so if there is content (like powerpoint slides or word diagrams) that aren't easily accommodated in markdown, saving the PDFs on Github works fine.

-----Original Message----- From: pastoraleman [mailto:notifications@github.com] Sent: Tuesday, September 20, 2016 1:43 PM To: OpenC2-org/openc2-org Subject: [OpenC2-org/openc2-org] Use Markdown instead of DOCX (#2)

The current DOCX format for the documentation means that Github can't show users the changes that are being made ("Binary file not shown.")

By changing the documents to Markdown, Github can directly show the changes which are being made, and should also be more accessible for contributions from those without Microsoft Word (or LibreOffice).

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub https://github.com/OpenC2-org/openc2-org/issues/2 , or mute the thread https://github.com/notifications/unsubscribe-auth/ASRALGGHXsQbri20PCpBdu2qcxBDotX9ks5qsBsigaJpZM4KB6i_ . https://github.com/notifications/beacon/ASRALAqFFasO7RAJMcPtoQuFgkmi5_4qks5qsBsigaJpZM4KB6i_.gif

romanojd commented 7 years ago

I added the front matter to the markdown version of the Language Description Document. You can find it here: docs-pub.

This markdown version is consistent with the 1.0 version of the Word Document and PDF, with the exception of Appendix, which is not complete. But everything else should be there.

This all may be moot, however, if the group decides to use Google Docs for working versions of our documents.

romanojd commented 7 years ago

The appendix is now complete. This issue is now closed, although, since we're now talking about using Google Docs, this may be OBE.