-
Notifications
You must be signed in to change notification settings - Fork 3
Open
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation
Description
Now that our documentation has been converted to AsciiDoc, we must produce manuals in PDF format for the following components:
- ThreadX / ThreadX SMP
- NetX Duo
- USBX
- GUIX
- FileX
- LevelX
- TraceX
The content itself is found in this repository. All new pages and/or content must use AsciiDoc.
To perform this task, the following elements are needed.
General
- Design a cover page and a back page which will include the Eclipse Foundation and Eclipse ThreadX logos.
- Design a page to include the required trademark and license statements. We will use the Creative Commons Attribution-ShareAlike 4.0 International license for the PDFs.
- Create a "container" page design with standard headers and footers. Header must contain the manual's title. Footer must contain a copyright statement ( (c) year Eclipse ThreadX Contributors) and the page number.
The two elements above must use substitution variables to customise them for specific manuals. No duplication, please!
For each component
- Build a "meta document" that will assemble the cover page, legal page, component-specific content and back page in a finished manual. This document will set the proper values for the variables.
- Generate a PDF for each manual using AsciiDoctor and version them in this repository.
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation
Type
Projects
Status
Ready