From 7d38e9d576aafbb7185091cee4afd88b0c137b28 Mon Sep 17 00:00:00 2001 From: Adam Ludes Date: Thu, 26 Jan 2023 16:34:50 +0100 Subject: [PATCH] Added pre-commit --- .github/workflows/pre-commit.yml | 14 ++++++++++++++ .markdownlint.yaml | 5 +++++ .pre-commit-config.yaml | 23 +++++++++++++++++++++++ README.md | 1 + content/en/_index.md | 5 +++-- content/en/docs/onboarding/_index.md | 5 ++--- content/en/search.md | 1 - 7 files changed, 48 insertions(+), 6 deletions(-) create mode 100644 .github/workflows/pre-commit.yml create mode 100644 .markdownlint.yaml create mode 100644 .pre-commit-config.yaml diff --git a/.github/workflows/pre-commit.yml b/.github/workflows/pre-commit.yml new file mode 100644 index 00000000..c2f7e71f --- /dev/null +++ b/.github/workflows/pre-commit.yml @@ -0,0 +1,14 @@ +name: pre-commit + +on: + pull_request: + push: + branches: [main] + +jobs: + pre-commit: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + - uses: actions/setup-python@v3 + - uses: pre-commit/action@v3.0.0 diff --git a/.markdownlint.yaml b/.markdownlint.yaml new file mode 100644 index 00000000..e8cd8e24 --- /dev/null +++ b/.markdownlint.yaml @@ -0,0 +1,5 @@ +default: true +# MD013/line-length - Breaks for HTML blocks +MD013: false +# MD033/no-inline-html - Allow inline HTML +MD033: false diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml new file mode 100644 index 00000000..e55f038d --- /dev/null +++ b/.pre-commit-config.yaml @@ -0,0 +1,23 @@ +repos: + - repo: https://github.com/pre-commit/pre-commit-hooks + rev: v4.4.0 + hooks: + - id: check-yaml + - id: end-of-file-fixer + types: [markdown] + exclude: themes/ + - id: trailing-whitespace + types: [markdown] + exclude: themes/ + - repo: https://github.com/codespell-project/codespell + rev: v2.2.2 + hooks: + - id: codespell + types: [markdown] + exclude: themes/ + - repo: https://github.com/igorshubovych/markdownlint-cli + rev: v0.33.0 + hooks: + - id: markdownlint-fix + types: [markdown] + exclude: themes/ diff --git a/README.md b/README.md index 4d40af83..c39833b1 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,3 @@ # Managed Tenants SRE Docs + Documentation for Managed Tenants SRE at Red Hat diff --git a/content/en/_index.md b/content/en/_index.md index 2b038881..6feed6fb 100755 --- a/content/en/_index.md +++ b/content/en/_index.md @@ -1,13 +1,14 @@ - --- title: "Managed Tenants SRE" linkTitle: "MT-SRE" +weight: 10 --- {{< blocks/section color="dark" >}} +

Red Hat Layered Products!

-

Managing managed services on managed OpenShift!

+

Managing managed services on managed OpenShift!

Product Managers / Team Leads

diff --git a/content/en/docs/onboarding/_index.md b/content/en/docs/onboarding/_index.md index caaaaff0..78ecc484 100644 --- a/content/en/docs/onboarding/_index.md +++ b/content/en/docs/onboarding/_index.md @@ -10,8 +10,7 @@ description: > This is a placeholder page that shows you how to use this template site. {{% /pageinfo %}} - -The Overview is where your users find out about your project. Depending on the size of your docset, you can have a separate overview page (like this one) or put your overview contents in the Documentation landing page (like in the Docsy User Guide). +The Overview is where your users find out about your project. Depending on the size of your docset, you can have a separate overview page (like this one) or put your overview contents in the Documentation landing page (like in the Docsy User Guide). Try answering these questions for your user in this page: @@ -21,7 +20,7 @@ Introduce your project, including what it does or lets you do, why you would use ## Why do I want it? -Help your user know if your project will help them. Useful information can include: +Help your user know if your project will help them. Useful information can include: * **What is it good for?**: What types of problems does your project solve? What are the benefits of using it? diff --git a/content/en/search.md b/content/en/search.md index fafc308e..5241dca9 100644 --- a/content/en/search.md +++ b/content/en/search.md @@ -3,4 +3,3 @@ title: Search Results layout: search toc_hide: true --- -