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

made doc changes #3214

Closed
wants to merge 2 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 40 additions & 0 deletions docs/docs/contribute/docs/markdownlint.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
---
comments: true
---

# Markdownlint

We are using [markdownlint](https://github.com/DavidAnson/markdownlint) to ensure consistent styling
within our Markdown files.
Specifically we are using [markdownlint-cli](https://github.com/igorshubovych/markdownlint-cli).

>
We are using `GNU make` to ensure the same functionality locally and within our CI builds.
This should allow easier debugging and problem resolution.

## Markdownlint execution

To verify that your markdown code conforms to the rules, run the following on your local branch:

```shell
make markdownlint
```

To use the auto-fix option, run:

```shell
make markdownlint-fix
```

## Markdownlint Configuration

We use the default configuration values for `markdownlint`.

This means:

[.markdownlint-cli2.yaml](https://github.com/keptn/lifecycle-toolkit/blob/main/.markdownlint-cli2.yaml)
contains the rule configuration

We use the default values, so tools like
[markdownlint for VSCode](https://marketplace.visualstudio.com/items?itemName=DavidAnson.vscode-markdownlint)
can be used without additional configuration.
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,17 @@
comments: true
---

# Linter Requirements
# Golangci-lint

This project uses a set of linters to ensure good code quality.
This project uses Golangci-lint to ensure good code quality.
In order to make proper use of those linters inside an IDE,
the following configuration is required.

## Golangci-lint

Further information can also be found in
the [`golangci-lint` documentation](https://golangci-lint.run/usage/integrations/).

### Visual Studio Code
## Visual Studio Code

In Visual Studio Code the
[Golang](https://marketplace.visualstudio.com/items?itemName=aldijav.golangwithdidi)
Expand Down Expand Up @@ -43,7 +42,7 @@ configuration file enables all linters used in this project.
},
```

### GoLand / IntelliJ requirements
## GoLand / IntelliJ requirements

* Install either the **GoLand** or **IntelliJ** Integrated Development Environment
(IDE) for the Go programming language, plus the [Go Linter](https://plugins.jetbrains.com/plugin/12496-go-linter) plugin.
Expand All @@ -61,40 +60,3 @@ If you are on Windows, you need to install **make** for the above process to com
> **Note**
When using the make command on Windows, you may receive an `unrecognized command` error for a command that is installed.
This usually indicates that `PATH` for the binary is not set correctly).

## Markdownlint

We are using [markdownlint](https://github.com/DavidAnson/markdownlint) to ensure consistent styling
within our Markdown files.
Specifically we are using [markdownlint-cli](https://github.com/igorshubovych/markdownlint-cli).

>
We are using `GNU make` to ensure the same functionality locally and within our CI builds.
This should allow easier debugging and problem resolution.

### Markdownlint execution

To verify that your markdown code conforms to the rules, run the following on your local branch:

```shell
make markdownlint
```

To use the auto-fix option, run:

```shell
make markdownlint-fix
```

### Markdownlint Configuration

We use the default configuration values for `markdownlint`.

This means:

[.markdownlint-cli2.yaml](https://github.com/keptn/lifecycle-toolkit/blob/main/.markdownlint-cli2.yaml)
contains the rule configuration

We use the default values, so tools like
[markdownlint for VSCode](https://marketplace.visualstudio.com/items?itemName=DavidAnson.vscode-markdownlint)
can be used without additional configuration.
3 changes: 2 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -212,11 +212,12 @@
- docs/contribute/software/index.md
- Software development environment: docs/contribute/software/dev-environ.md
- Add a metrics provider: docs/contribute/software/add-new-metric-provider.md
- Add Golangci-lint: docs/contribute/software/golangci-lint.md
- Documentation contributions:
- docs/contribute/docs/index.md
- Contribution guidelines for documentation: docs/contribute/docs/contrib-guidelines-docs.md
- Build Documentation Locally: docs/contribute/docs/local-building.md
- Linter Requirements: docs/contribute/docs/linter-requirements.md
- Markdown Linting: docs/contribute/docs/markdownlint.md

Check failure on line 220 in mkdocs.yml

View workflow job for this annotation

GitHub Actions / Check Spelling

`Linting` is not a recognized word. (unrecognized-spelling)
- Source File Structure: docs/contribute/docs/source-file-structure.md
- Coding the docs: docs/contribute/docs/code-docs.md
- Spell Checker: docs/contribute/docs/spell-check.md
Expand Down
Loading