ReachableCEO
544d1c31e5
TSYS Group Development Stack - Toolboxes - DocsAndDiagrams - Product Requirements Document - ## Docker Image Boilerplate Image name: tsysdevstack-toolboxes-docs Image username: tsysdevstack Image base: latest Debian stable - ALL operations MUST be as the tsysdevstack user - NO ROOT ACCESS should be possible at runtime (no sudo, no su) - The ONLY permitted use of root is during build time, and that MUST be to the ABSOLUTE MINIMUM extent possible (just for apt-get operations and creating the tsysdevstack user). Switching to tsysdevstack as early as possible. - mise (as the tsysdevstack user) MUST be used to install all language runtimes (node/python/rust/ruby). - If an application is installed via npm/pip/cargo/gem, those application installs MUST be done via mise managed versions of npm/pip/cargo/gem. - NO system wide (apt-get) installs of language runtimes are allowed - This is a production container. Use ALL best common practices for the building and securing of docker containers. (Buildx, multi stage, hardened ) - Use yamllint/hadolint/shellcheck (available via docker images on this system) as a QA gate BEFORE attempting to build the image. If ANY changes to Dockerfile/run.sh/build.sh/test.sh are made, run them through hadolint/shellcheck respectively. - ALL hadolint/yamllint/shellcheck issues MUST be FULLY RESOLVED always. The only acceptable QA outcome is when those tools return no warnings/errors. - Think about how to efficiently create the Dockerfile, keeping caching of layers in mind , especially how layers can be cached across multiple different image builds. - Utilize buildkit/buildx - This container needs to run on PC/Raspberry Pi/Mac M series. - Reproducibility of the build is PARAMOUNT! Use version pinning for EVERYTHING. Do the research to find the latest stable version and update Dockerfile and other files accordingly. Do not "just use latest", that is never acceptable. You MUST pin the Debian package versions, and any of the tooling you install via mise managed runtimes. - Use the examples subdirectory and create example artifacts and workflow scripts to fully QA the functionality of the container - Create a README.md file that is BEAUTIFULLY formatted (using table of contents/headers/icons/graphics/whitespace/tables (with left justified text)). Document the container image thoroughly. - Use the documentation subdirectory and creaate the following artifacts: - TROUBLESHOOTING.md - CHEATSHEET.md - USAGE.md - Use the output subdirectory and create the following artifacts (ensure they will pass strict QA testing/auditing): - Dockerfile - docker-compose.yml - devcontainer.json - run.sh - build.sh - test.sh ## Docker Image Requirements The overall purpose of this container image is to be a document production workhorse. Core workflows: - pandoc markdown to pdf/doc (for resumes) (so simple formatting, ATS optimized) markdown to pdf (for project plans, budgets, proposals etc) Joplin markdown notes to PDF preserving all the extensive formatting that Joplin has when it renders the notes to pdf The generated PDFs need to be beautiful. Rich fonts, graphics, formatting of the code listings etc. We will be heavily leaning into texlive/xetex for this. I would also like to explore using wkhtmltopdf so that CSS can be used to style the output. - mdbook - typst - marp - markwhen - kroki cli - quarto - bibtool - vale Add in any other common support tools you think may be needed (such as jq/yq). Generally this image will be used "headless" to run a generation workflow (or mdbook serve during active development of an mdbook site). It should have fish as it's shell (and also bash/zsh) for the occasional interactive use. Follow test-driven-development for this project without fail. Ensure that the image is built successfully and fully validated against this PRD Use the /home/localuser/TSYSDevStack/Toolbox/docs/output directory for all of the work you do for this task.
1.8 KiB
1.8 KiB
Example Documents for TSYSDevStack Toolboxes Docs
This directory contains example documents and workflow scripts that demonstrate the capabilities of the document production workhorse container.
📄 Document Examples
1. Basic Markdown to PDF
basic-markdown.md- Simple markdown document for conversion to PDFbasic-markdown.pdf- Output PDF generated from the markdown
2. Resume/CV Generation
resume-template.tex- LaTeX template for ATS-optimized resumesresume.md- Markdown source for a resumeresume.pdf- Generated PDF resume
3. Project Documentation
project-plan.md- Example project plan in markdownproject-plan.pdf- Generated PDF project plan
4. Joplin Notes Conversion
joplin-note.md- Example Joplin note markdownjoplin-note.pdf- Converted PDF preserving formatting
5. mdBook Example
mybook/- Complete mdBook project examplemybook/src/SUMMARY.md- Book structuremybook/src/chapter_1.md- Sample chapter
6. Typst Document
scientific-document.typ- Example Typst documentscientific-document.pdf- Generated PDF
7. Marp Presentation
presentation.md- Example Marp presentationpresentation.pdf- Generated PDF slides
8. Quarto Document
analysis.qmd- Example Quarto document with code executionanalysis.pdf- Generated analysis document
🛠️ Workflow Scripts
1. Batch Conversion Script
batch-convert.sh- Script to convert multiple markdown files to PDF
2. Document Pipeline
document-pipeline.sh- Complete pipeline from source to final document
3. Quality Assurance
qa-check.sh- Script to verify document quality and consistency
4. Custom Styling
custom-templates/- Directory containing custom templates for various document types