Create a suite of tools to replace the web-based documentation generator
The current documentation generator does a few things. It started off life as a relatively simple tool that generated NOTICE and CONTRIBUTING files, and copyright and licence headers. It was extended to generate default security files and provide other advice. It was further extended to provide a summary of the files that were present or missing from the project's Git repositories.
My thinking is that we can replace the generator's behaviour with an open source CLI implementation. I would like to leave a path open to possibly integrate with tools like the Eclipse IDE, Eclipse Theia, or VisualStudio Code (for example).
These tools should be easy to obtain, install, and run. I'm thinking that all the cool kids are using Python these days and that most of our community should be comfortable with Python based tools (and using, for example, pip
to install things).
I've presented a solution as potentially being multiple separate tools, but having a solution manifest in this manner is not a requirement.
I'm inspired by the REUSE.software tool that can be used to both review the status of a project (e.g., reuse lint
) and fix it (e.g., reuse download
). I do not mean that we should replicate the functionality of the REUSE tool, but rather we should take inspiration by the manner in which it interacts with the user.
Random: we might consider having the tool(s) work with local metadata (e.g., a file that includes the project id in the repository).
Anything that we implement should be moved to open source as soon as possible and developed completely in the open. The Eclipse Dash project is the obvious home for this. Let's keep our discussion at a relatively high level here: once work begins, we can cover more detailed discussion in an Eclipse Dash project repository's issue tracker.