search

MariaDB / mariadb-docker

Docker Official Image packaging for MariaDB
https://mariadb.org
GNU General Public License v2.0
770 stars 438 forks source link

hub.docker.com Documents incomplete #396

Closed LeamHall closed 2 years ago

LeamHall commented 3 years ago

In the "How to use this image" in https://hub.docker.com/_/mariadb, the recommended code doesn't work. It assumes a password for example-user, but doesn't give one. The root user instructions don't seem to work either, but using "root" vice "example-user", with "some-secret-pw" works.

I apologize for not offering a PR for the page, I don't know your document layout yet.

grooverdan commented 3 years ago

Noted. I have a moderate set of outstanding documentation things that I should address. If you don't get to this first I'll include this too.

Docs are derived from: https://github.com/docker-library/docs/tree/master/mariadb

LeamHall commented 3 years ago

Thanks for the URL! Let me see what I can come up with.

LeamHall commented 3 years ago

Since this is my first effort at contributing, would you mind giving me some feedback?

https://github.com/LeamHall/docs/commit/d027f84b746aa5df62b9ee139749dc8740bc0a99

grooverdan commented 3 years ago

Good start, very small nits commented already. Please keep going, you are doing well.

I assume you're going to continue and remove all of the :tag references?

If you'd like to do any of the things I was going to do you are most welcome to:

LeamHall commented 3 years ago

Looks pretty fun, let me dive into it and give you some more stuff to review.

LeamHall commented 2 years ago

I updated my branch, integrated your suggestions and changes all "tag" tags to "latest". Looking at the other stuff in the next couple of days; I'll probably make a branch for each one and send you the URL for critique.

grooverdan commented 2 years ago

Great, squash those and send a PR to https://github.com/docker-library/docs.

I'm happy to do review other branches on PRs on that site so the Docker Library people can chip in a review too.

LeamHall commented 2 years ago

PR https://github.com/docker-library/docs/pull/2055

LeamHall commented 2 years ago

Not sure what to do on this; thoughts? https://github.com/docker-library/docs/actions/runs/1326521853

grooverdan commented 2 years ago

changes should be in mariadb/content.md. readme is autogenerated

LeamHall commented 2 years ago

Okay, I'll take care of it in the next day or so. I had seen that the stuff was autogenerated, but didn't see any documentation on how to handle whatever the process was.

grooverdan commented 2 years ago

https://github.com/docker-library/docs/#files-related-to-an-images-docs

LeamHall commented 2 years ago

Sorry I got behind, I still have this on my agenda.

grooverdan commented 2 years ago

closed by https://github.com/docker-library/docs/pull/2055

Thanks!