-
-
Notifications
You must be signed in to change notification settings - Fork 78
Description
Describe the bug
Describe the Bug:
Several typos and unclear sentences have been found in the documentation Explanations section. These issues affect the readability and professionalism of the documentation. Below is a detailed list of improvements, including spelling corrections, sentence rewording, and some clarifications.
1. Deployment topologies:
Typos:
- "Globaly" → "Globally": Correct spelling.
- "toplogy" → "topology": Correct spelling.
Improvements:
- No other major changes necessary here, just a typo fix.
2. Conformance testing:
Typos:
- "Watirmelon" → "Watermelon": Correct spelling.
Improvements:
- Sentence improvement:
-
Current Sentence-1:
"It is likely you experienced the painful situation of deploying to production only to find out that an API or Services you integrate with has broken its contract." -
Suggested Change:
"You may have experienced the frustration of deploying to production, only to discover that an API or service you integrate with has broken its contract." -
Reason: The original sentence sounds a bit awkward, and simplifying the phrasing makes it more readable. Using "frustration" instead of "painful situation" is more natural in technical writing.
-
Current Sentence-2:
"Microcks clearly allows you to realize Automated API Tests and focus more precisely on Contract conformance testing." -
Suggested Change:
"Microcks enables you to automate API tests and focus specifically on contract conformance testing." -
Reason: "Realize" is an awkward word choice in this context, and "automate" fits better. Replacing "focus more precisely" with "focus specifically" improves clarity and flow.
-
3. service accounts:
Typos:
- "Credetnials" → "Credentials": Typo correction.
- "Keycloack" → "Keycloak": Correct spelling.
Improvements:
- No additional sentence improvements needed here.
4. monitoring:
Typos:
- "ca neasily" → "can easily": Correct spelling.
- "dashbaord" → "dashboard": Correct spelling.
Improvements:
- No additional sentence improvements needed here.




