You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Hi,
we have a use case, where our client demands a statically built manual as a project deliverable.
I implemented automation for this case and perhaps it could be used as an addition to piranha.core, since it seems to completement the piranha.core.docs project somwhat. I intend to add automatic archiving support from Clickup, maybe Jira, and render task contents into the document.
Please let me know if such feature is useful to Piranha project.
Requirements
Automation should support multiple product-specific builds.
Automation should support git submodules, where each submodule has it's own documentation, which can be included using same rules.
Implement template syntax to embed/serialize binary or string content from file system instead of linking them. Generated document is standalone and does not link any external resources.
Generate compiled markdown and overwrite repository's README.md.
Generate PDF/A from compiled markdown: i.e. used as project deliverable.
Generate HTML from markdown: i.e. export to /assets for use with Piranha CM deployment. Document is generated in a deterministic way and chapters can be linked from within CMS.
Automatic versioning of builds.
Add document meta to header and footer: Author, Timestamp, Version, SHA 256 content hash, etc.
Generate a JSON file with a list of all included files and their meta data. Chapters are sorted by orderId, then by name. List of chapters can be edited manually.
Auto-numbering of chapters.
Command Arguments
Proposed automation command arguments during build would look somewhat like this:
string productName: Product name
string solutionDirectory: Solution directory root
string directoryNameFilter: Directory name filter: used to filter out directories that contains documentation
string fileExtensionFilter: File extension to look for in filtered directories: i.e. "readme.md"
string outputPathMarkdown: Compiled markdown output path, relative to solution root
string outputPathHtml: Compiled HTML output path, relative to solution root
string outputPathPdf: : Compiled PDF/A output path, derived from outputPathHtml, since both should probably be deployed to the same location.
string[] externalLinks: List of external links to test scenario platforms to add in document head: i.e. Jira tickets
string[] supportContacts: List of contacts to replace in content.
bool openExports: dev tool to open exported files on success.
reacted with thumbs up emoji reacted with thumbs down emoji reacted with laugh emoji reacted with hooray emoji reacted with confused emoji reacted with heart emoji reacted with rocket emoji reacted with eyes emoji
-
Hi,
we have a use case, where our client demands a statically built manual as a project deliverable.
I implemented automation for this case and perhaps it could be used as an addition to piranha.core, since it seems to completement the piranha.core.docs project somwhat. I intend to add automatic archiving support from Clickup, maybe Jira, and render task contents into the document.
Please let me know if such feature is useful to Piranha project.
Requirements
Command Arguments
Proposed automation command arguments during build would look somewhat like this:
Beta Was this translation helpful? Give feedback.
All reactions