Document configs

[zuiderkwast]

Currently, we just refer to valkey.conf (the template config file) where the fields are described in comments. This isn't very good documentation.

Document each config parameter in the proper page valkey.conf.md. Instead of referring to the config files of different versions, we can mention for each field in which version it was introduced.

[melroy89]

in which version it was introduced.

And if applicable when it's depreciated.

[rjd15372]

I also think this is a good idea. Having the config options description in our documentation is the way to go. But there's a maintenance burden here that we need to decide how to tackle on, because we will have duplicate information (in the valkey.conf file, and here in the documentation).

My take on this is that whenever a developer opens a PR with changes to the valkey.conf file in the valkey repo, the reviewers should ask the developer to also open a PR in the valkey-doc repo with updating the documentation. This way we distribute the burden of maintenance between all developers.

[zuiderkwast]

Yes, for any feature that requires doc changes, we ask the developer to do it and we add the tag 'doc-pr-needed' to the PR.

Can I assign you to this issue? ;)

[rjd15372]

@zuiderkwast you can assign it to @nastena1606

[madolson]

zuiderkwast you can assign it to @nastena1606

Done. We still need to decide what we want to do though.

[zuiderkwast]

Ideas:

1. Minimal. Change the link to valkey.conf to point to valkey.conf in unstable branch. Remove the old links to Valkey 7 config files and old redis.conf.
2. Automated. We could write a script to include the contents of valkey.conf (the example config with comments) in a code block on this page. In this way, contributors that modify configs don't need to make a doc PR. We only need to run the script when we make a new release.
3. Full. Add proper documentation of the configs in this file. Some drawbacks: We will have duplicated information (new docs + the comments valkey.conf) and contributors will have to make a doc PR when changing some configs.