Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document that pentext-docker exists #147

Open
ros-cr opened this issue Jan 10, 2025 · 0 comments
Open

Document that pentext-docker exists #147

ros-cr opened this issue Jan 10, 2025 · 0 comments

Comments

@ros-cr
Copy link
Contributor

ros-cr commented Jan 10, 2025

We have https://github.com/radicallyopensecurity/pentext-docker as a combination of Docker files, GitLab integration, template conversion programs and other glue logic.

I think it would be very relevant to add to Pentext's documentation that pentext-docker exists, and give some hints at what it does. As I understand it @PeterMosmans aims to keep the pentext repository separate from additional software layers and tooling like pentext-docker, and some of pentext-docker is ROS- and CI/CD specific and not useful to the average person. Still, I think it's relevant to let interested readers of the README.md know that this additional software exists, since they likely won't find out otherwise.

To give one example that's probably relevant for individuals interested in pentext: the docbuilder logic in pentext-docker is very useful to convert (= render) pentext documents during local document editing, not just in a CI context. It's not 100% set up for that role and doesn't make use of various local features (e.g., rootless Podman usage, rebuilding on file changes), but it's a better place to start than re-doing the whole container setup on their own 🙂

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant