From 782873ad46b2b2f038e4b78b6745aa0e603951d2 Mon Sep 17 00:00:00 2001 From: Dipankar Das <65275144+dipankardas011@users.noreply.github.com> Date: Sun, 18 Feb 2024 15:59:36 +0530 Subject: [PATCH] feat(docs): updated the documentation Signed-off-by: Dipankar Das <65275144+dipankardas011@users.noreply.github.com> --- .github/ISSUE_TEMPLATE/bug-report.md | 2 +- .github/ISSUE_TEMPLATE/enhancement-proposal.md | 2 +- .github/ISSUE_TEMPLATE/feature-proposal.md | 2 +- .github/pull_request-template.md | 2 +- CONTRIBUTING.md | 2 +- README.md | 17 +++++++++++++---- SECURITY.md | 2 +- 7 files changed, 19 insertions(+), 10 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md index 8b5e35d..62969c9 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.md +++ b/.github/ISSUE_TEMPLATE/bug-report.md @@ -31,4 +31,4 @@ Add here # Additional context Add any other context about the problem here. -Check [Contribution's guidelines](https://kubesimplify.github.io/ksctl/docs/contributions) +Check [Contribution's guidelines](https://docs.ksctl.com/docs/contribution-guidelines/) diff --git a/.github/ISSUE_TEMPLATE/enhancement-proposal.md b/.github/ISSUE_TEMPLATE/enhancement-proposal.md index e21a246..c0012d8 100644 --- a/.github/ISSUE_TEMPLATE/enhancement-proposal.md +++ b/.github/ISSUE_TEMPLATE/enhancement-proposal.md @@ -13,4 +13,4 @@ assignees: '' ## Additional context -Check [Contribution's guidelines](https://kubesimplify.github.io/ksctl/docs/contributions) +Check [Contribution's guidelines](https://docs.ksctl.com/docs/contribution-guidelines/) diff --git a/.github/ISSUE_TEMPLATE/feature-proposal.md b/.github/ISSUE_TEMPLATE/feature-proposal.md index dc13a6c..d4a639f 100644 --- a/.github/ISSUE_TEMPLATE/feature-proposal.md +++ b/.github/ISSUE_TEMPLATE/feature-proposal.md @@ -24,4 +24,4 @@ assignees: '' - Kubeadm ## Additional context -Check [Contribution's guidelines](https://kubesimplify.github.io/ksctl/docs/contributions) +Check [Contribution's guidelines](https://docs.ksctl.com/docs/contribution-guidelines/) diff --git a/.github/pull_request-template.md b/.github/pull_request-template.md index ce5d4d7..2430b9b 100644 --- a/.github/pull_request-template.md +++ b/.github/pull_request-template.md @@ -19,4 +19,4 @@ - [ ] Ran Tests locally -- [ ] Checked [Contribution's guidelines](https://kubesimplify.github.io/ksctl-docs/docs/contribution-guidelines/) +- [ ] Checked [Contribution's guidelines](https://docs.ksctl.com/docs/contribution-guidelines/) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 34fcd96..ab35ffd 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1 +1 @@ -The contents are moved to [docs](https://kubesimplify.github.io/ksctl/docs/contributions) \ No newline at end of file +The contents are moved to [docs](https://docs.ksctl.com/docs/contribution-guidelines/) diff --git a/README.md b/README.md index 7cf0296..0711aca 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,15 @@ -# ksctl-cli -ksctl cli repo +# Ksctl (CLI): Cloud Agnostic Kubernetes Management tool -[![Go Reference](https://pkg.go.dev/badge/github.com/kubesimplify/ksctl-cli.svg)](https://pkg.go.dev/github.com/kubesimplify/ksctl-cli) +![CoverPage Social Media](https://raw.githubusercontent.com/ksctl/ksctl/main/img/ksctl-cover.png) -source of ksctl core https://github.com/kubesimplify/ksctl +

+ Discord | + Website

+ Intro | + Contribute | + Roadmap

+

+ +[![Go Reference](https://pkg.go.dev/badge/github.com/ksctl/cli.svg)](https://pkg.go.dev/github.com/ksctl/cli) + +source of ksctl core https://github.com/ksctl/ksctl diff --git a/SECURITY.md b/SECURITY.md index 79e1d39..17a18a9 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -10,4 +10,4 @@ ## Reporting a Vulnerability -Check [contribution guide](./CONTRIBUTING.md) and also [website contribution page](https://kubesimplify.github.io/ksctl/docs/contributions) +Check [contribution guide](./CONTRIBUTING.md) and also [website contribution page](https://docs.ksctl.com/docs/contribution-guidelines/)