Documentation Guidelines
Licensing
The OpenXT toolkit supports an ecosystem of diverse commercial derivatives, which can extend both software and documentation with proprietary enhancements and branding. This rules out the possibility of using GPL or CC-BY-SA license variants for documentation. Instead, OpenXT documentation artifacts are licensed under the Creative Commons Attribution 4.0 International License, which:
- Is designed for use in multiple legal jurisdictions.
- Requires attribution, https://wiki.creativecommons.org/wiki/Best_practices_for_attribution
- Permits commercial derivatives, including electronic distribution (e.g. HTML, ePub, Kindle) and printed book distribution.
- Does not require changes to be upstreamed, e.g. document additions which are specific to proprietary Service VMs or unique platform configurations. Note that it is in the interest of every OpenXT derivative to upstream document changes which apply to the base platform, to avoid the cost of maintaining document patches.
Sample License Header for Confluence
These markup samples can be pasted into Confluence pages, using the "Insert Markup" function (click the + dropdown, select Markup, and on the Insert drop-down select Confluence wiki). For an extended discussion of the copyright status of works created by U.S. Government employees and contractors, see the CENDI FAQ and Wikipedia. Please consult legal counsel for your organization for definitive guidance.
Commercial Entity
{info:icon=None} !OD:Documentation Guidelines^cc-by.png|width=80! Copyright 2015 by Company, Inc. Created by First Last. This work is licensed under the Creative Commons Attribution 4.0 International License. To view a copy of this license, visit http://creativecommons.org/licenses/by/4.0/. {info}
U.S. Government Entity
{info:icon=None} !OD:Documentation Guidelines^cc-by.png|width=80! As a work of the United States Government, this work is in the public domain within the United States. Outside of the United States, this work is Copyright 2015 by the U.S. Government, created by First Last and is licensed under the Creative Commons Attribution 4.0 International License. To view a copy of this license, visit http://creativecommons.org/licenses/by/4.0/. {info}
Artifacts
Information is currently dispersed across a range of sources:
- Confluence wiki pages
- Google Group mailing list archives
- Legacy documents in PDF format
- README files in Github source repositories
- Comments on Github pull requests
- JIRA tickets and comments
Markup
To Do: select markup format to replace legacy documentation which is written in DocBook.