Documentation improvement [ci skip]

mediagis / nominatim-docker

100% working container for Nominatim

Creative Commons Zero v1.0 Universal

1.07k stars 437 forks source link

Closed gsg-git closed 10 months ago

gsg-git commented 10 months ago

leonardehrenfried suggested me to improve the "readme".

I have added a bit more explanation for peolpe like me wko dont have such a big Nomnatim/Linux/Docker knowledge.

It is 25-30 hours worth of texting and editing - i hope you can use it.

what-the-diff[bot] commented 10 months ago

Addition of "Configuration Example" to README.md This update adds a new section to our README.md file named "Configuration Example". This section aims to guide users through the setup process by providing a concrete example demonstrating various flag options.
Creation of examples.md File We've introduced a new file, examples.md, which offers additional configuration setup examples. This file would assist users in understanding different setup scenarios, further enhancing their ability to utilise our product efficiently.

leonardehrenfried commented 10 months ago

Please resolve the conflicts with the master branch.

gsg-git commented 10 months ago

got it

gsg-git commented 10 months ago

We made it!

I'll let @philipkozeny have a look and then it's good to merge.

@philipkozeny Can you squash all the commits when merging?

Yeah! this went quite fast!

Tank you!

gsg-git commented 10 months ago

Thanks for the PR, here are some small things I caught during review.

@philipkozeny Done! Sorry - I was ill the last week.

philipkozeny commented 10 months ago

@all-contributors please add @gsg-git for docs

allcontributors[bot] commented 10 months ago

@philipkozeny

@gsg-git already contributed before to doc

allcontributors[bot] commented 10 months ago

@philipkozeny

I've put up a pull request to add @gsg-git! :tada: