sebastianbergmann / phpunit-documentation-english

English Documentation for PHPUnit
https://docs.phpunit.de/
85 stars 136 forks source link

[Feedback wanted] Contribution ideas #331

Closed two-plus-two-equals-five closed 1 year ago

two-plus-two-equals-five commented 1 year ago

Hey @sebastianbergmann and co.

I wanted to see if the following two contribution ideas for this repo would be wanted / welcomed:

  1. Supply a Dockerfile in the repo to:

    • handle keeping all of the Python and Sphinx dependencies automatically up-to-date without requiring contributors to manually install these dependencies themselves on their machines

    • remove the need to supply and update a `/tools` directory (instead leveraging packages like `composer` to handle this via a PHP base Docker image)

  2. Build a deployment pipeline for this repo to:

    1. automatically pull the latest stable release of PHPUnit the instant it's out (or whenever a still-supported version is updated)

    2. then automatically run the assertion output generator script + the HTML documentation script (`make html`) - having a Dockerfile to set up these scripts' dependencies would aid with this

    3. then either:
      1. upload the generated HTML files somewhere to some hosting server to be propagated to the "production" 'Read the doc' documentation site once it has been manually approved, or

      2. just dump the generated files out to your local machine for viewing + manual propagation.


Reasons behind the suggestions above: reducing manual tasks reduces the chances of documentation going stale + makes contributions more straightforward todo as there is an improved development experience (reducing the number of things for contributors to do and get right in order to make a contribution).


Side question:



I hope the above is useful, but if not, then no worries!

sebastianbergmann commented 1 year ago
  1. Supply a Dockerfile in the repo to:

             * handle keeping all of the Python and Sphinx dependencies automatically up-to-date without requiring contributors to manually install these dependencies themselves on their machines* remove the need to supply and update a `/tools` directory (instead leveraging packages like `composer` to handle this via a PHP base Docker image)

I am not interested in this.

  1. Build a deployment pipeline for this repo to:

We already have this (just not as a GitHub Action): the documentation is built and deployed after each push.