Skip to content
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

Updating index.md and other pages #524

Open
wants to merge 16 commits into
base: master
Choose a base branch
from
Open

Conversation

azarboon
Copy link
Contributor

@azarboon azarboon commented Jun 9, 2024

I've updated a number of pages to include latest changes / to inform readers about their choices and associated complexities.

Issue #, if available:

Description of changes:

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

Readers should be informed that there is an equivalent managed service available.
@azarboon azarboon requested a review from a team as a code owner June 9, 2024 08:40
@azarboon
Copy link
Contributor Author

azarboon commented Jun 20, 2024

@geoffcline as per your advice, I've combined all my PRs into one. Kindly please review this. Thanks a lot for your constructive feedbacks and your support. I really appreciate it.

@Tim-AWS FYI

@azarboon azarboon changed the title Update application.md Updating index.md and other pages Jun 20, 2024
@geoffcline
Copy link
Contributor

Thank you for combining them @azarboon !

content/index.md Outdated Show resolved Hide resolved
@svennam92
Copy link
Collaborator

@CodiumAI-Agent /improve

@CodiumAI-Agent
Copy link

PR Code Suggestions ✨

CategorySuggestion                                                                                                                                    Score
Clarity
Clarify the sentence structure and improve link accessibility with descriptive texts

It's recommended to clarify the sentence structure and improve the link accessibility by
using descriptive link texts instead of generic terms like "here" or "this".

content/performance/performance.md [148]

-To enable VPA you need to use Kubernetes metrics server, which is an aggregator of resource usage data in your cluster. It is not deployed by default in Amazon EKS clusters. You need to configure it before [configure VPA](https://docs.aws.amazon.com/eks/latest/userguide/vertical-pod-autoscaler.html) alternatively you can also use Prometheus or Amazon Managed Service for Prometheus to provide metrics for the Vertical Pod Autoscaler.
+To enable VPA, first deploy the Kubernetes metrics server, an aggregator of resource usage data in your cluster. Since it is not deployed by default in Amazon EKS clusters, configure it following the [Vertical Pod Autoscaler setup guide](https://docs.aws.amazon.com/eks/latest/userguide/vertical-pod-autoscaler.html). Alternatively, you can use Prometheus or Amazon Managed Service for Prometheus to provide metrics for the Vertical Pod Autoscaler.
 
Suggestion importance[1-10]: 8

Why: The suggestion clarifies the sentence structure and improves link accessibility by using descriptive link texts. This enhances both readability and usability, making the instructions clearer and more user-friendly.

8
Specify monitoring tools and provide direct links to enhance clarity and precision

To enhance clarity and precision, specify the type of monitoring tools recommended and
provide direct links to their documentation or setup guides.

content/reliability/docs/application.md [118]

-The metrics server doesn’t retain any data, and it’s not a monitoring solution. Its purpose is to expose CPU and memory usage metrics to other systems. If you want to track your application's state over time and get notified, you need a monitoring tool like Amazon Managed Service for Prometheus or Amazon CloudWatch.
+The metrics server doesn’t retain any data as it is not a monitoring solution. Its primary function is to expose CPU and memory usage metrics to other systems. For ongoing tracking and notifications about your application's state, consider using a dedicated monitoring tool. Recommended options include [Amazon Managed Service for Prometheus](https://aws.amazon.com/prometheus/) or [Amazon CloudWatch](https://aws.amazon.com/cloudwatch/).
 
Suggestion importance[1-10]: 8

Why: The suggestion enhances clarity and precision by specifying the recommended monitoring tools and providing direct links to their documentation. This makes the information more actionable and easier to follow.

8
Readability
Improve readability by breaking down complex sentences into simpler, shorter ones

Consider breaking down the long sentence into multiple shorter sentences for better
readability and comprehension. This will help readers to understand each point clearly
without overwhelming them with too much information at once.

content/cost_optimization/cost_opt_compute.md [191]

-Each capacity type has different trade-offs for management overhead, availability, and long term commitments and you will need to decide which is right for your environment. No environment should rely on a single capacity type and you can mix multiple run types in a single cluster to optimize specific workload requirements and cost. For example, you can use Savings Plans to serve your regular traffic and use Spot instances to serve your irregular peak demands.
+Each capacity type has different trade-offs for management overhead, availability, and long term commitments. You will need to decide which is right for your environment. No environment should rely on a single capacity type. You can mix multiple run types in a single cluster to optimize specific workload requirements and cost. For example, use Savings Plans to serve your regular traffic and Spot instances for your irregular peak demands.
 
Suggestion importance[1-10]: 7

Why: The suggestion improves readability by breaking down a long, complex sentence into shorter, more digestible sentences. This enhances comprehension without altering the original meaning.

7
Refine sentence structure for better readability and ensure consistent punctuation

Refine the sentence structure for better flow and readability, and ensure consistent use
of the Oxford comma.

content/reliability/docs/controlplane.md [37]

-You can use Prometheus or Amazon Managed Service for Prometheus to collect and store these metrics. In May 2020, CloudWatch added support for monitoring Prometheus metrics in CloudWatch Container Insights. So you can also use Amazon CloudWatch to monitor the EKS control plane. You can use [Tutorial for Adding a New Prometheus Scrape Target: Prometheus KPI Server Metrics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/ContainerInsights-Prometheus-Setup-configure.html#ContainerInsights-Prometheus-Setup-new-exporters) to collect metrics and create CloudWatch dashboard to monitor your cluster’s control plane.
+You can collect and store metrics using Prometheus or Amazon Managed Service for Prometheus. Since May 2020, CloudWatch has supported monitoring Prometheus metrics through CloudWatch Container Insights, allowing you to also use Amazon CloudWatch for monitoring the EKS control plane. Follow the [tutorial for adding a new Prometheus scrape target](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/ContainerInsights-Prometheus-Setup-configure.html#ContainerInsights-Prometheus-Setup-new-exporters) to collect metrics and create a CloudWatch dashboard for your cluster’s control plane.
 
Suggestion importance[1-10]: 7

Why: The suggestion refines the sentence structure for better readability and ensures consistent use of punctuation, improving the overall flow and clarity of the text.

7

@svennam92
Copy link
Collaborator

@azarboon Thank you for this PR! There's a lot of great additions here. I've left comments on a couple things I'd rather not include. Please also review the suggestions from the Codium AI Agent.

Removed the sentence as per suggestion
Removed the section as suggested
Removed the section as suggested
Applied this suggestion from CodiumAI agent: "Clarify the sentence structure and improve link accessibility with descriptive texts"
Applied this suggestion from CodiumAI "Specify monitoring tools and provide direct links to enhance clarity and precision"
Applied 3rd suggestion from CodiumAI
Applied 4th suggestion from CodiumAI
@azarboon
Copy link
Contributor Author

azarboon commented Jul 3, 2024

@svennam92 thanks for the constructive feedback. I've committed all the suggestions by you and Codium. Kindly please merge the PR.

@azarboon
Copy link
Contributor Author

@svennam92 and @geoffcline I've already incorporated your suggested changes since two weeks ago. Can you please merge this?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants