Help Page - FAQ
Q: What is FreeBSD Online Document Editor?
A: It is an online website editor for FreeBSD documentation which is still developing. The purpose of FreeBSD Online Document Editor is to simplify the editing process in FreeBSD documentation. Here is the GitHub repo URL - https://github.com/Wang-Yan-Hao/FreeBSD-Online-Document-Editor.
Q: How to use the online editor to change document>
A: Please follow the below step.
- You find the problem on a certain page on the FreeBSD document.
- Click the "Edit Page" button on the page and go to "FreeBSD Online Document Editor".
- Change the source code(.adoc) in the left section. Click the "Patch Download" button to download the patch about your change.
- Click the "FreeBSD Bugzilla" button, going to FreeBSD Bugzilla to submit the patch.
Q: How can I give advice?
A: You can advise on the github repo issue or contact me directly by email - bses30074@gmail.com.
Q: Is there a document about how to contribute to the document?
A: Yes, the book "FreeBSD Documentation Project Primer for New Contributors" (https://docs.freebsd.org/en/books/fdp-primer/.) may help you.
Q: I am not familiar with Asciidoc?
A: Asciidoc supplies a complete document "AsciiDoc Syntax Quick Reference" (https://docs.asciidoctor.org/asciidoc/latest/syntax-quick-reference/) to reference. It can help you a lot.