From 1aab9247aff5441a190a645cec04f56fcc8c8868 Mon Sep 17 00:00:00 2001 From: leecalcote Date: Tue, 6 Oct 2020 16:18:34 -0500 Subject: [PATCH] fix yaml lint issues Signed-off-by: leecalcote --- README.md | 33 +++++++++++++++++---------------- 1 file changed, 17 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 33e6984b..8ae05a86 100644 --- a/README.md +++ b/README.md @@ -1,44 +1,45 @@ # NGINX Service Mesh + --- -**Support** +## Support -Thank you for your interest in NGINX Service Mesh (NSM). NSM is currently +Thank you for your interest in NGINX Service Mesh (NSM). NSM is currently available to download via downloads.f5.com, under the NGINX Product Family. -*Resources* +### Resources - [Product Details](https://www.nginx.com/nginx-service-mesh) - [Download NSM](https://downloads.f5.com/esd/product.jsp?sw=NGINX-Public&pro=NGINX_Service_Mesh) - [NSM Documentation](https://docs.nginx.com/nginx-service-mesh) - [NGINX Plus Kubernetes Ingress Controller](https://www.nginx.com/products/nginx/kubernetes-ingress-controller/) -- [NGINX Plus Product Details]( https://www.nginx.com/products/nginx/) +- [NGINX Plus Product Details](https://www.nginx.com/products/nginx/) -*Git Issues* +### Git Issues For NSM support or issues not addressed by documentation, please reach out via the issues tab, [NSM Git -Issues](https://github.com/nginxinc/nginx-service-mesh/issues) +Issues](https://github.com/nginxinc/nginx-service-mesh/issues). -We use issues for bug reports and to discuss new features. -Creating issues is good, creating good issues is even better. +We use issues for bug reports and to discuss new features. +Creating issues is good, creating good issues is even better. Filing meaningful bug reports with lots of information in them helps us figure out what to fix when and how it impacts our users. We like bugs because it means people are using our code, and we like fixing them even more. Please follow these guidelines for filing issues: -* Describe the problem. Include version of k8s, `nginx-meshctl version`, and what K8s platform. -* Include detailed information about how to recreate the issue. -* Include relevant configurations, error messages, and logs. -* Sanitize the data. For example, be mindful of IPs, ports, application names, and URLs +- Describe the problem. Include version of k8s, `nginx-meshctl version`, and what K8s platform. +- Include detailed information about how to recreate the issue. +- Include relevant configurations, error messages, and logs. +- Sanitize the data. For example, be mindful of IPs, ports, application names, and URLs. -**NOTE** +## NOTE Support for NSM is not currently available via traditional NGINX or F5 -support channels. All support is through the community at [NSM Git -Issues](https://github.com/nginxinc/nginx-service-mesh/issues) +support channels. All support is through the community at [NSM Git +Issues](https://github.com/nginxinc/nginx-service-mesh/issues). -**NGINX Plus KIC Support** +## NGINX Plus KIC Support If you are using NSM with NGINX Plus Ingress Controller for Kubernetes, you can get support through your usual channels.