Added linting rules #458
Added linting rules #458
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
![hyperlint-ai[bot]](https://avatars.githubusercontent.com/in/718456?s=60&v=4){kind=small}
docs/dedicated/architecture.md
Outdated
| provider that supports it, a dedicated VPC as well. This document outlines the | ||
| components and architecture of a managed dedicated instance of a Zuplo API | ||
| Gateway. | ||
| Gateway is isolated to its own instances and when running in on a cloud provider |
There was a problem hiding this comment.
| Gateway is isolated to its own instances and when running in on a cloud provider | |
| The gateway operates in isolation on its own instances and when running on a cloud provider. |
Issues:
- Style Guide - (Microsoft.Passive-suggestion) 'is isolated' looks like passive voice.
Fix Explanation:
The original sentence uses passive voice ('is isolated'), which can be rephrased to active voice for clarity. The revised sentence specifies that 'The gateway operates in isolation', making it clear who is performing the action. This change enhances readability and aligns with active voice guidelines.
docs/dedicated/architecture.md
Outdated
| components and architecture of a managed dedicated instance of a Zuplo API | ||
| Gateway. | ||
| Gateway is isolated to its own instances and when running in on a cloud provider | ||
| that supports it, a dedicated VPC as well. This document outlines the components |
There was a problem hiding this comment.
| that supports it, a dedicated VPC as well. This document outlines the components | |
| that supports it, a dedicated Virtual Private Cloud (VPC) as well. This document outlines the components |
Issues:
- Style Guide - (Microsoft.Acronyms-suggestion) 'VPC' has no definition.
Fix Explanation:
The acronym 'VPC' should be defined as 'Virtual Private Cloud' to ensure clarity and adherence to documentation standards. This change provides the necessary context for readers who may not be familiar with the acronym.
docs/dedicated/architecture.md
Outdated
| availability zones, or data centers to provide high availability and low | ||
| latency. | ||
| - **Developer Portal Hosting** - The developer portal is typically hosted from a | ||
| CDN managed by Zuplo. Our default configuration serves the developer portal's | ||
| static assest from a global CDN, but we can configure your developer portal to | ||
| static assets from a global CDN, but we can configure your developer portal to |
There was a problem hiding this comment.
| static assets from a global CDN, but we can configure your developer portal to | |
| static assets from a global CDN, but your developer portal can be configured to |
Issues:
- Style Guide - (Microsoft.We-warning) Try to avoid using first-person plural like 'we'.
Fix Explanation:
Rephrased the sentence to avoid using 'we' by changing the structure to passive voice, which aligns with the style guide's recommendation.
docs/dedicated/architecture.md
Outdated
| your use case or that don't meet your security or compliance requirements. For | ||
| example, if you don't want to use the built-in API analytics and instead want | ||
| to use your own analytics, we can disable the built-in analytics. When our | ||
| built-in analytics is disabled, we do not collect or store analytics data for | ||
| built-in analytics is disabled, we don't collect or store analytics data for |
There was a problem hiding this comment.
| built-in analytics is disabled, we don't collect or store analytics data for | |
| The built-in analytics feature is turned off, and no analytics data is collected or stored. |
Issues:
- Style Guide - (Microsoft.Passive-suggestion) 'is disabled' looks like passive voice.
- Style Guide - (Microsoft.Accessibility-suggestion) Don't use language (such as 'disabled') that defines people by their disability.
- Style Guide - (Microsoft.We-warning) Try to avoid using first-person plural like 'we'.
Fix Explanation:
Rephrased to use active voice and avoid first-person plural. Replaced 'disabled' with 'turned off' to avoid potential insensitivity.
No description provided.