Updates to README and docs for v0.10.0

[ml-evs]

• Updated dead links in README
• Move development info into CONTRIBUTING.md file.
• Add information about index meta-database
• Explain new server.cfg file

Please add any changes to the README or associated files to this PR.

[codecov]

Codecov Report

Merging #68 into master will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master      #68   +/-   ##
=======================================
  Coverage   82.81%   82.81%           
=======================================
  Files          39       39           
  Lines        1810     1810           
=======================================
  Hits         1499     1499           
  Misses        311      311

Flag	Coverage Δ
#unittests	82.81% <ø> (ø)	⬆️

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update e991b31...790e250. Read the comment docs.

[CasperWA]

Nice - did you change anything in the development instructions upon moving them to CONTRIBUTIONS?

[ml-evs]

I changed the filename references in the final section about developing new transformers, and added a title.

[fekad]

Sorry I referred this PR by mistake ( 68 VS #66 ). I already changed the link in the original one.

[CasperWA]

I have found that for git it is preferrable to have one line per sentence. This will most likely disagree with most linters (and editors), since a sentence may be quite long, but the upshot is a much more readable git diff when committing changes.

I am open to your suggestions, considerations and opinions on this as well, and I think we should decide on a recommended repository format in this PR.

[CasperWA]

I have created an "OPTiMaDe badge". It uses the shield.io endpoint service, where one can pass a URL to a JSON file that defines a badge.
The JSON file is placed in the repository, and the badge points to the version under the master branch (hence it doesn't work at the moment), but it will look like this:

(here pointing to the current branch)

Note: The file .ci/optimade_version_update.py should either be updated to retrieve the config file path from server.cfg introduced in #103 or it should directly import CONFIG from optimade.server.config. However, this demands that optimade is installed for the pre-commit job in the Actions workflow introduced in #92.

[ml-evs]

Missed all of this, sorry @CasperWA.

1. Regarding the one line per sentence comment, I think git diff --word-diff and GitHub's rich diff negate this, no? I certainly don't care enough personally to make the changes!

2. The badges look good, though the OPTiMaDe one seems to be broken at the moment. The gh-actions badge also says our master branch is failing?

I think we need to get this merged before we forget about it, and prepare another docs update for 0.10.1+.

[CasperWA]

Missed all of this, sorry @CasperWA.

No worries.

1. Regarding the one line per sentence comment, I think git diff --word-diff and GitHub's rich diff negate this, no? I certainly don't care enough personally to make the changes!

Sure - I will do it. The git diff --word-diff may work fine, but it's more for future PR's. It makes it easier to see the minor changes to a sentence if it's one sentence per line.

2. The badges look good, though the OPTiMaDe one seems to be broken at the moment. The gh-actions badge also says our master branch is failing?

The OPTiMaDe batch will not work until this PR is merged into master, since it points to master.
For the GItHub Actions badge, it seems there isn't a way to check whether tests are working for a specific branch, but rather if a specific "workflow" is passing generally or not. Since all of our tests are currently "failing" due to pydantic v1, it looks as though our build is failing.

I think we need to get this merged before we forget about it, and prepare another docs update for 0.10.1+.

Okay. I will try to add some information on what I have added to the OP.

[CasperWA]

@ml-evs Could you pass through the README and CONTRIBUTIONS? I know you can't really review it, since you opened the PR, but just to check my additions are all right. Then I'll approve and we can merge.

[ml-evs]

Thanks for tidying this up @CasperWA , shall we get it merged?

EDIT: Whoops, just seen your comment from before Christmas... will have a closer look...

[CasperWA]

Thanks for tidying this up @CasperWA , shall we get it merged?

EDIT: Whoops, just seen your comment from before Christmas... will have a closer look...

Just ping me when you it's ready for a final review and possible merge.

[CasperWA]

Thanks for the work with this @ml-evs.

It all looks good to me.
Minor additions, updates or changes may still happen, but this rewrite/upgrade is very much needed.