Skip to content

Improving the ReadMe (and other documentation) #979

@bordenc

Description

@bordenc

I'm struggling to follow the official readme, and I have to draw a lot of web searches to setup a basic container. Some specifics:

  1. The readme omits that the image doesn't ship with its own database server. I haven't dug deep enough to see if there's been a debate on whether to package MariaDB, but the working scripts I've found online need this extra step. Nevertheless, it should be clear that the image doesn't work out-of-the-box;
  2. The readme notes tweaks necessary to get SSL/TLS working, but I haven't been able to get them to work. I get errors when I try to enable TLS. Is there a known configuration with working TLS? Is it something that's beyond the readme's scope?
  3. There appear to be typos in other areas:
  • There are several environment variables strung together under How to use this image. I don't know if this is intentional.
  • Adding additional libraries / extensions seems to have a sentence fragment: "If you need additional PHP extensions, you'll need to create your own image FROM this one."

(I haven't explored the other suggestions in the readme in much depth. They're somewhat over my head)

This is all to say that I'm willing to take a stab at PRing an edit to the readme, and other documentation, to ease the introduction to newcomers. I want some feedback and direction before I attempt to do so.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions