[CASSANDRA-15618] add docs for production recommendations

• Type: Task
• Status: Resolved
• Priority: Normal
• Resolution: Fixed
• Fix Version/s: 4.0-alpha4, 4.0
• Component/s: Documentation/Website
• Labels: pull-request-available
• Change Category: Quality Assurance
• Complexity: Low Hanging Fruit
• Platform: All

Source Control Link

https://github.com/apache/cassandra/commit/4dcee71b2de36b52feddf720564f6e58ad8fcc6d

Test and Documentation Plan

To build the sphinx docs and preview locally:

cd docs
export SKIP_NODETOOL=1 # don't build the nodetool docs
docker-compose build build-docs
docker-compose run build-docs

• Assignee: Jon Haddad
• Reporter: Jon Haddad

Authors

Jon Haddad

Reviewers

Jon Haddad, Jordan West

• Created: 02/Mar/20 21:55
• Updated: 15/May/20 08:53
• Resolved: 30/Mar/20 21:11

Description

We have some inline comments in our yaml, but I think it would be helpful if we had a more lengthy section in the docs detailing the settings people should be using in production. Some of these are unrelated to the yaml itself (like reducing read ahead), and putting them in the YAML doesn’t make much sense. There are also other settings (like compression chunk length) that don’t fit there. Let’s add a page under getting started called Production Recommendations.

Issue Links

• links to: GitHub Pull Request #487