[TT-12266] Add Rate Limit Smoothing Docs (5.4.0)

[titpetric]

User description

For internal users - Please add a Jira DX PR ticket to the subject!

• Updates rate limiter docs with rate limit smoothing
• Updates key and policy creation examples documenting the value

---

Preview Link

Description

Screenshots (if appropriate)

Checklist

• I have added a preview link to the PR description.
• I have reviewed the guidelines for contributing to this repository.
• I have read the technical guidelines for contributing to this repository.
• Make sure you have started your change off our latest master.
• I labelled the PR

---

PR Type

Documentation

---

Description

• Added JSON formatting to API key creation examples.
• Introduced rate limit smoothing configuration in API key creation and security policy creation.
• Updated explanations and examples for new fields in API key creation and security policy creation.
• Added detailed explanation and example configuration for rate limit smoothing in rate limiting concepts.

---

Changes walkthrough 📝

Relevant files

Documentation

create-api-key.md Add rate limit smoothing configuration to API key creation tyk-docs/content/getting-started/create-api-key.md Added JSON formatting to API key creation examples. Introduced rate limit smoothing configuration in API key creation. Updated explanations for new fields in API key creation. +28/-6    create-security-policy.md Add rate limit smoothing configuration to security policy creation tyk-docs/content/getting-started/create-security-policy.md Added rate limit smoothing configuration to security policy creation. Updated rate limit and quota values in policy examples. +17/-9    rate-limiting.md Add detailed documentation for rate limit smoothing            tyk-docs/content/getting-started/key-concepts/rate-limiting.md Added detailed explanation of rate limit smoothing. Provided example configuration for rate limit smoothing. Updated Redis Rate Limiter section with new smoothing options. +55/-2

---

💡 PR-Agent usage:
Comment /help on the PR to get a list of all available PR-Agent tools and their descriptions

[github-actions]

PR Reviewer Guide 🔍

⏱️ Estimated effort to review [1-5]	3
🧪 Relevant tests	No
🔒 Security concerns	No
⚡ Key issues to review	JSON Formatting: The PR adds JSON formatting to the documentation examples. Ensure that the JSON is valid and properly formatted.
	Rate Limit Smoothing: The PR introduces documentation for a new feature called "Rate Limit Smoothing". It's crucial to verify the accuracy of the configuration details and their implications.
	Consistency in Documentation: Ensure that the terminology and formatting remain consistent throughout the document. Changes like adding periods at the end of sentences for consistency should be checked across all documents.

[github-actions]

PR Code Suggestions ✨

Category	Suggestion	Score
Maintainability	Add a closing JSON block and triple backticks to properly close the JSON code block Ensure that the JSON code block is properly closed with a closing triple backticks () to maintain the markdown formatting standards and prevent rendering issues on the documentation site. tyk-docs/content/getting-started/create-api-key.md [27-30] ```json { "api_model": {}, "key_id": "59bf9159adbab8abcdefghijac9299a1271641b94fbaf9913e0e048c", +} +``` Suggestion importance[1-10]: 10 Why: The suggestion correctly identifies the missing closing brace and triple backticks for the JSON code block, which is crucial for maintaining proper markdown formatting and preventing rendering issues on the documentation site.	10
	Ensure the JSON code block is properly closed to maintain markdown formatting Add a closing triple backticks () after the JSON code block to ensure proper formatting and readability in the markdown file. tyk-docs/content/getting-started/create-api-key.md [44-49] ```json { "action": "create", "key": "c2cb92a78f944e9a46de793fe28e847e", "status": "ok" } +``` Suggestion importance[1-10]: 10 Why: This suggestion accurately points out the need to close the JSON code block with triple backticks, which is essential for correct markdown rendering and readability.	10

[netlify]

✅ PS. Pls add /docs/nightly to the end of url

Name	Link
🔨 Latest commit	6307096
🔍 Latest deploy log	https://app.netlify.com/sites/tyk-docs/deploys/666759592501e000081e70ca
😎 Deploy Preview	https://deploy-preview-4771--tyk-docs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site configuration.

[netlify]

✅ PS. Pls add /docs/nightly to the end of url

Name	Link
🔨 Latest commit	e03e18f
🔍 Latest deploy log	https://app.netlify.com/sites/tyk-docs/deploys/6671a0d5c6b37d0008752f37
😎 Deploy Preview	https://deploy-preview-4771--tyk-docs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site configuration.

[dcs3spp]

@titpetric PRLGTM I have made some minor suggestions. Why the additional spacing in front matter for aliases?

[dcs3spp]

@titpetric Is there rate limiting content that needs to be added to Self Managed and Cloud tabs for create security policies and access api keys?

[andyo-tyk]

Corrected typos

[andyo-tyk]

Correcting local links

[andyo-tyk]

Recommend not making changes to the getting started guides at this stage.

[dcs3spp]

@titpetric I have approved the PR and removed the rate limit smoothing in the examples. @andyo-tyk are you ok with the changes? If so I will merge ready for release

[jeffy-mathew]

@titpetric @dcs3spp lgtm, I've approved.

[dcs3spp]

Many thanks @jeffy-mathew I will merge ready for release