Skip to content

docs: simplifies some of the Runtime State Sharing docs #516

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
May 6, 2025

Conversation

migue1s
Copy link
Contributor

@migue1s migue1s commented May 4, 2025

Proposed changes

This is related to #364.

The docs for Azure Runtime State Sharing is overly complex, this PR attempts to simplify one part of it.

According to https://hemingwayapp.com, the complexity rating has still not decreased overall. But the following improvements have been made:

  • Net 4 sentences have been removed from "very hard to read"
  • Net 2 sentences have been added as "hard to read" (some were slightly improved from above)
  • 2 weakeners have been removed

Many of the "complex" sentences either include many links or use very specific (and long) terms.

Checklist

Before merging a pull request, run through this checklist and mark each as complete.

  • I have read the contributing guidelines
  • I have signed the F5 Contributor License Agreement (CLA)
  • I have rebased my branch onto main
  • I have ensured my PR is targeting the main branch and pulling from my branch from my own fork
  • I have ensured that the commit messages adhere to Conventional Commits
  • I have ensured that documentation content adheres to the style guide
  • If the change involves potentially sensitive changes1, I have assessed the possible impact
  • If applicable, I have added tests that prove my fix is effective or that my feature works
  • I have ensured that existing tests pass after adding my changes
  • If applicable, I have updated README.md and CHANGELOG.md

Footnotes

  1. Potentially sensitive changes include anything involving code, personally identify information (PII), live URLs or significant amounts of new or revised documentation. Please refer to our style guide for guidance about placeholder content.

@migue1s migue1s requested a review from a team as a code owner May 4, 2025 22:26
@github-actions github-actions bot added documentation Improvements or additions to documentation product/nginxaas NGINX as a Service for Azure labels May 4, 2025
Copy link

github-actions bot commented May 4, 2025

✅ All required contributors have signed the F5 CLA for this PR. Thank you!
Posted by the CLA Assistant Lite bot.

@migue1s
Copy link
Contributor Author

migue1s commented May 4, 2025

I have hereby read the F5 CLA and agree to its terms

@migue1s
Copy link
Contributor Author

migue1s commented May 4, 2025

recheck

Copy link
Contributor

@mjang mjang left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks so much for your contribution! It helps!

Before accepting your PR, I'd appreciate your thoughts on my feedback.

@mjang mjang merged commit b93011a into nginx:main May 6, 2025
2 checks passed
@mjang mjang added the community label May 6, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
community documentation Improvements or additions to documentation product/nginxaas NGINX as a Service for Azure
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants