To start writing a new document, follow these steps:
1) read the README.adoc for the preliminary requirements.
2) create a directory with the same name of the doc title lowercase with underscore for space.
3) copy a master document from other docs to simplify coherency and change whatever needs to be changed.
4) follow the convention to call the name of the document with the same name of the doc project dir
5) if the document is rather large and you want to break it into separate chapters, follow the convention of calling the chapter files as:
docname_chapter_name-or-number.adoc
The first _ character will separate the docname from the chapter names and will guarantee automatic inclusion of the chapters into the final output formats.
6) when you reach a worthwhile point on your document, create a patch with:
git add docname git commit -m "Added manual docname, first draft" git format-patch HEAD^
and send it to the devels or fork with gitbub web interface and ask for pull merging.
Please, before committing any file, check for functionality, to avoid breaking automatic compilation of docs.
Happy writing!
此处可能存在不合适展示的内容,页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容,可点击提交进行申诉,我们将尽快为您处理。