From 6bb586885522548f68734590a4f6e45f8d889244 Mon Sep 17 00:00:00 2001 From: Subin Kim <32478597+sudosubin@users.noreply.github.com> Date: Mon, 11 Sep 2023 09:13:16 +0900 Subject: [PATCH] docs: Update to use markdownlint compatible markdown contents (#11787) Signed-off-by: sudosubin --- .github/ISSUE_TEMPLATE/enhancement_proposal.md | 2 +- .github/ISSUE_TEMPLATE/mentoring_request.md | 3 ++- .github/pull_request_template.md | 6 +++--- CODEOWNERS | 1 - CONTRIBUTING.md | 1 + README.md | 3 ++- SECURITY.md | 9 +++------ USERS.md | 6 +++--- docs/CONTRIBUTING.md | 4 ++-- examples/README.md | 2 +- manifests/README.md | 1 - sdks/CONTRIBUTING.md | 2 +- 12 files changed, 19 insertions(+), 21 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/enhancement_proposal.md b/.github/ISSUE_TEMPLATE/enhancement_proposal.md index 4f83528b87b6..971b2e901acb 100644 --- a/.github/ISSUE_TEMPLATE/enhancement_proposal.md +++ b/.github/ISSUE_TEMPLATE/enhancement_proposal.md @@ -7,7 +7,7 @@ labels: 'enhancement' What change needs making? -# Use Cases +## Use Cases When would you use this? diff --git a/.github/ISSUE_TEMPLATE/mentoring_request.md b/.github/ISSUE_TEMPLATE/mentoring_request.md index cef954af29d2..b22f1c0f9e23 100644 --- a/.github/ISSUE_TEMPLATE/mentoring_request.md +++ b/.github/ISSUE_TEMPLATE/mentoring_request.md @@ -4,6 +4,7 @@ about: Request a mentor to help contribute to this project labels: ['mentoring', 'triage'] --- + **Question: Have you read the [mentoring guide](https://argoproj.github.io/argo-workflows/mentoring/)? Please only submit this request for general mentoring (not GSoC).** Answer: **Yes I have read the mentoring guide.** @@ -18,4 +19,4 @@ Answer: **I would like to work with issue #7920** **Do you want to work with your mentor async (i.e. by Slack messaging or issue comments), or sync (e.g. using Zoom video)?** Please include your time-zone if you want to work sync. -Answer: (async/sync) (timezone) \ No newline at end of file +Answer: (async/sync) (timezone) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index da38bc5010a7..99399333d82a 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,12 +1,13 @@ + + - Fixes #TODO diff --git a/CODEOWNERS b/CODEOWNERS index 854da5ba61f0..c30e3e08d271 100644 --- a/CODEOWNERS +++ b/CODEOWNERS @@ -1,2 +1 @@ *.proto @jessesuen @alexec @terrytangyuan @sarabala1979 - diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e445d367aff5..8d7d04a058a8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1 +1,2 @@ + See [docs/CONTRIBUTING.md](docs/CONTRIBUTING.md). diff --git a/README.md b/README.md index 7dd13a8da8c1..cc6e7f8e028a 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,4 @@ + [![slack](https://img.shields.io/badge/slack-argoproj-brightgreen.svg?logo=slack)](https://argoproj.github.io/community/join-slack) [![CI](https://github.com/argoproj/argo-workflows/workflows/CI/badge.svg)](https://github.com/argoproj/argo-workflows/actions?query=event%3Apush+branch%3Amaster) [![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/3830/badge)](https://bestpractices.coreinfrastructure.org/projects/3830) @@ -67,7 +68,7 @@ Just some of the projects that use or rely on Argo Workflows (complete list [her Check out our [Java, Golang and Python clients](docs/client-libraries.md). -## Quickstart +## Quickstart * [Get started here](docs/quick-start.md) * [Walk-through examples](https://argoproj.github.io/argo-workflows/walk-through/) diff --git a/SECURITY.md b/SECURITY.md index 3cea3dd83577..71fcb9eb70a2 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -1,4 +1,4 @@ -# Security +# Security ## Reporting a Vulnerability @@ -6,11 +6,11 @@ If you find a security related bug in Argo Workflows, we kindly ask you for resp disclosure and for giving us appropriate time to react, analyze and develop a fix to mitigate the found security vulnerability. -Please report vulnerabilities by e-mail to the following address: +Please report vulnerabilities by e-mail to the following address: * cncf-argo-security@lists.cncf.io -All vulnerabilities and associated information will be treated with full confidentiality. +All vulnerabilities and associated information will be treated with full confidentiality. ## Public Disclosure @@ -39,6 +39,3 @@ claiming a bounty, and also on how to claim it. ## Securing Argo Workflows See [docs/security.md](docs/security.md) for information about securing your Argo Workflows instance. - - - diff --git a/USERS.md b/USERS.md index 3f95bac363fd..a52d02d719c8 100644 --- a/USERS.md +++ b/USERS.md @@ -1,4 +1,4 @@ -## Argo Workflows User Community Surveys & Feedback +# Argo Workflows User Community Surveys & Feedback Please find [here](https://github.com/argoproj/argoproj/blob/master/community/user_surveys/ArgoWorkflows2020SurveySummary.pdf) Argo Workflows user community 2020 survey results and the 2021 results [here](https://blog.argoproj.io/argo-workflows-2021-survey-results-d6fa890030ee?gi=857daaa1faa9). @@ -27,7 +27,7 @@ Currently, the following organizations are **officially** using Argo Workflows: 1. [AppDirect](https://www.appdirect.com/) 1. [Arabesque](https://www.arabesque.com/) 1. [Argonaut](https://www.argonaut.dev/) -1. [ArthurAI](https://arthur.ai/) +1. [ArthurAI](https://arthur.ai/) 1. [Astraea](https://astraea.earth/) 1. [Atlan](https://atlan.com/) 1. [BasisAI](https://basis-ai.com/) @@ -83,7 +83,7 @@ Currently, the following organizations are **officially** using Argo Workflows: 1. [Fynd Trak](https://trak.fynd.com/) 1. [Galixir](https://www.galixir.com/) 1. [Gardener](https://gardener.cloud/) -2. [Gepardec](https://gepardec.com/) +1. [Gepardec](https://gepardec.com/) 1. [GitHub](https://github.com/) 1. [Gitpod](https://www.gitpod.io/) 1. [Gladly](https://gladly.com/) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 4121ee73fcca..59b619be8666 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -56,9 +56,9 @@ Example, should we add `fasttemplate` | Test | Outcome | |-----------------------------------------|-------------------------------------| | A strong use case. | ❌ Fail. We can use `text/template`. | -| It has an acceptable license (e.g. MIT) | ✅ Pass. MIT license. | +| It has an acceptable license (e.g. MIT) | ✅ Pass. MIT license. | | It is actively maintained. | ❌ Fail. Project is inactive. | -| It has no security issues. | ✅ Pass. No known security issues. | +| It has no security issues. | ✅ Pass. No known security issues. | No, we should not add that dependency. diff --git a/examples/README.md b/examples/README.md index 8cb416a8781b..f1a8956c76a3 100644 --- a/examples/README.md +++ b/examples/README.md @@ -1,3 +1,3 @@ # Documentation by Example -This has been moved to [the docs](https://argoproj.github.io/argo-workflows/walk-through/). \ No newline at end of file +This has been moved to [the docs](https://argoproj.github.io/argo-workflows/walk-through/). diff --git a/manifests/README.md b/manifests/README.md index d671b387d0a6..87ee62942ada 100644 --- a/manifests/README.md +++ b/manifests/README.md @@ -1,4 +1,3 @@ # Argo Install Manifests Please read [installation](https://argoproj.github.io/argo-workflows/installation/) - diff --git a/sdks/CONTRIBUTING.md b/sdks/CONTRIBUTING.md index 817ba95690d3..010205cd6a50 100644 --- a/sdks/CONTRIBUTING.md +++ b/sdks/CONTRIBUTING.md @@ -13,4 +13,4 @@ Make it contributor friendly: Make it user friendly: * Commit enough for users to learn how to use it. Use `.gitignore` to exclude files. -* Add a [README.md](java/README.md) to help users get started. \ No newline at end of file +* Add a [README.md](java/README.md) to help users get started.