A starter template for authoring your own Nasdanika product management model. Create a repository from this repository as a template, enable GitHub pages with GitHub actions. Edit legacy-modernization.pm.md, push - a GitHub Action publishes the rendered documentation site to GitHub Pages for free.
Example output: https://nasdanika-templates.github.io/product-management/
When you instantiate this template you get:
- A markdown files with personas, concerns, capabilities, and providers - the structure the metamodel expects
- A GitHub Actions workflow that builds your model into a documentation site
- Automatic publishing of that site to GitHub Pages on every push to
main
- Use this template to create your own repository (the green Use this template button at the top of the GitHub UI).
- Enable GitHub Pages in your new repository's Settings ? Pages, with the source set to "GitHub Actions".
- Edit the legacy-modernization.pm.md file to describe your own personas, concerns, capabilities, and providers. You can rename the file from
legacy-modernization.pm.mdto the name of your product model, just keep.pm.mdat the end. If you rename the file, also edit.github\workflows\site.ymlfile to reflect the change. - Push to
main. The workflow runs, builds the site, publishes tohttps://<your-org>.github.io/<your-repo>/.
The GitHub Actions workflow invokes the Nasdanika CLI's model/html-app/site command pipeline.
The pipeline:
- Loads your markdown file and maps to the product management model
- Renders the resulting model as an interactive documentation site
- Publishes the result to the GitHub Pages
The CLI is open source. The pipeline is deterministic. The site is the output; the model is the source.
Descriptions in the model accept Markdown as the default authoring format. For richer documentation embedded directly in version-controlled text, see the drawio-site template - its conventions for Markdown authoring with draw.io diagrams embedded inline apply here as well.
- Read the full documentation for the metamodel
- Browse the example site generated from this template
EPL-2.0 (template). Your derived model's license is your choice.