Skip to content

Fix Linter issues in Markdown files #21

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.

Sign up for GitHub

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

Open
VimukthiPerera wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Fix Linter issues in Markdown files #21

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
50 changes: 31 additions & 19 deletions .github/linters/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ framework:
- terraform

skip-check:
- CKV_TF_1 # Ensure Terraform module sources use a commit hash
- CKV_TF_1 # Ensure Terraform module sources use a commit hash
- CKV_AWS_18 # Ensure S3 bucket has access logging enabled

skip-path:
Expand Down Expand Up @@ -57,14 +57,15 @@ resource "aws_instance" "example" {
```

### Documentation

- [Checkov CLI Reference](https://www.checkov.io/2.Basics/CLI%20Command%20Reference.html)
- [Checkov Suppressions](https://www.checkov.io/2.Basics/Suppressing%20and%20Skipping%20Policies.html)

---

## TFLint (Terraform Linting)

**Config file:** `.github/linters/.tflint.hcl` or `.tflint.hcl` in repo root
**Config file:** `.github/linters/.tflint.hcl` or `.tflint.hcl` in repository root

### Global suppressions (config file)

Expand Down Expand Up @@ -110,6 +111,7 @@ resource "aws_instance" "example" {
```

### Documentation

- [TFLint Configuration](https://github.com/terraform-linters/tflint/blob/master/docs/user-guide/config.md)
- [TFLint Annotations](https://github.com/terraform-linters/tflint/blob/master/docs/user-guide/annotations.md)

Expand Down Expand Up @@ -147,6 +149,7 @@ resource "aws_s3_bucket" "example" {
```

### Documentation

- [Terrascan Config](https://runterrascan.io/docs/usage/config_options/)
- [Terrascan Skip Rules](https://runterrascan.io/docs/usage/in_file_instrumentation/)

Expand All @@ -159,6 +162,7 @@ resource "aws_s3_bucket" "example" {
### Handling format issues

1. Run locally before committing:

```bash
terraform fmt -recursive
```
Expand Down Expand Up @@ -186,13 +190,13 @@ rules:
line-length:
max: 120
level: warning

comments:
min-spaces-from-content: 1

truthy:
check-keys: false

# Disable specific rules
document-start: disable
indentation:
Expand Down Expand Up @@ -223,14 +227,15 @@ another_key: no
```

### Documentation

- [yamllint Configuration](https://yamllint.readthedocs.io/en/stable/configuration.html)
- [yamllint Rules](https://yamllint.readthedocs.io/en/stable/rules.html)

---

## ShellCheck (Bash/Shell)

**Config file:** `.github/linters/.shellcheckrc` or `.shellcheckrc` in repo root
**Config file:** `.github/linters/.shellcheckrc` or `.shellcheckrc` in repository root

### Global suppressions (config file)

Expand Down Expand Up @@ -279,6 +284,7 @@ another_unused="value"
```

### Documentation

- [ShellCheck Wiki](https://www.shellcheck.net/wiki/)
- [ShellCheck Directives](https://www.shellcheck.net/wiki/Directive)

Expand Down Expand Up @@ -318,6 +324,7 @@ steps:
```

### Documentation

- [actionlint Configuration](https://github.com/rhysd/actionlint/blob/main/docs/config.md)

---
Expand Down Expand Up @@ -347,33 +354,38 @@ Or YAML format:
```yaml
# .github/linters/.markdownlint.yaml
default: true
MD013: false # Line length
MD033: false # Inline HTML
MD041: false # First line heading
MD013: false # Line length
MD033: false # Inline HTML
MD041: false # First line heading
```

### Inline suppressions

```markdown
<!-- markdownlint-disable MD013 -->

This is a very long line that would normally trigger the line length warning but we want to allow it here.

<!-- markdownlint-enable MD013 -->

<!-- markdownlint-disable-next-line MD041 -->

This paragraph doesn't start with a heading.
```

### File-level suppression

```markdown
<!-- markdownlint-disable -->

(Entire file content ignored)

<!-- Or at top of file: -->
<!-- markdownlint-disable-file MD013 MD033 -->
```

### Documentation

- [markdownlint Rules](https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md)
- [markdownlint Configuration](https://github.com/DavidAnson/markdownlint#configuration)

Expand All @@ -392,10 +404,10 @@ In your workflow file:
VALIDATE_ALL_CODEBASE: false
DEFAULT_BRANCH: main
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

# Exclude paths (regex)
FILTER_REGEX_EXCLUDE: .*examples/.*|.*vendor/.*|.*node_modules/.*

# Or include only specific paths
FILTER_REGEX_INCLUDE: .*modules/.*|.*\.github/.*
```
Expand All @@ -418,14 +430,14 @@ Super-linter respects `.gitignore` by default. Files in `.gitignore` are not lin

## Quick Reference

| Linter | Config File | Inline Suppression |
|--------|-------------|-------------------|
| Checkov | `.checkov.yaml` | `# checkov:skip=CKV_XXX:reason` |
| TFLint | `.tflint.hcl` | `# tflint-ignore: rule_name` |
| Terrascan | `.terrascan.toml` | `#ts:skip=AC_XXX reason` |
| yamllint | `.yamllint.yml` | `# yamllint disable-line rule:name` |
| ShellCheck | `.shellcheckrc` | `# shellcheck disable=SCXXXX` |
| Linter | Config File | Inline Suppression |
| ------------ | -------------------- | ------------------------------------- |
| Checkov | `.checkov.yaml` | `# checkov:skip=CKV_XXX:reason` |
| TFLint | `.tflint.hcl` | `# tflint-ignore: rule_name` |
| Terrascan | `.terrascan.toml` | `#ts:skip=AC_XXX reason` |
| yamllint | `.yamllint.yml` | `# yamllint disable-line rule:name` |
| ShellCheck | `.shellcheckrc` | `# shellcheck disable=SCXXXX` |
| markdownlint | `.markdownlint.json` | `<!-- markdownlint-disable MDXXX -->` |
| actionlint | `.actionlint.yaml` | Limited support |
| actionlint | `.actionlint.yaml` | Limited support |
Comment thread
VimukthiPerera marked this conversation as resolved.

All config files go in `.github/linters/` for super-linter to auto-detect them.
32 changes: 16 additions & 16 deletions CODE_OF_CONDUCT.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,24 +16,24 @@ diverse, inclusive, and healthy community.

To uphold pledges we make concerning our community, we expect and promote behavior that contributes to a positive environment for our community, such as:

* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our mistakes,
- Demonstrating empathy and kindness toward other people
- Being respectful of differing opinions, viewpoints, and experiences
- Giving and gracefully accepting constructive feedback
- Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
* Focusing on what is best not just for us as individuals, but for the
- Focusing on what is best not just for us as individuals, but for the
overall community

Examples of unacceptable behavior include:

* Any illegal actions
* The use of sexualized language or imagery, and sexual attention or
- Any illegal actions
- The use of sexualized language or imagery, and sexual attention or
advances of any kind
* Trolling, insulting or derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or email
- Trolling, insulting or derogatory comments, and personal or political attacks
- Public or private harassment
- Publishing others' private information, such as a physical or email
address, without their explicit permission
* Any other conduct which could reasonably be considered inappropriate in a
- Any other conduct which could reasonably be considered inappropriate in a
professional setting

## Enforcement Responsibilities
Expand All @@ -52,7 +52,7 @@ decisions when appropriate.

This Code of Conduct applies within all community spaces, and also applies when
an individual is officially representing the community in public spaces.
Examples of representing our community include using an official e-mail address,
Examples of representing our community include using an official email address,
posting via an official social media account, or acting as an appointed
representative at an online or offline event.

Expand Down Expand Up @@ -104,7 +104,7 @@ Violating these terms may lead to a permanent ban.
### 4. Permanent Ban

**Community Impact**: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behavior, harassment of an
standards, including sustained inappropriate behavior, harassment of an
individual, or aggression toward or disparagement of classes of individuals.

**Consequence**: A permanent ban from any sort of public interaction within
Expand All @@ -114,13 +114,13 @@ the community.

This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.0, available at
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
<https://www.contributor-covenant.org/version/2/0/code_of_conduct.html>.

Community Impact Guidelines were inspired by [Mozilla's code of conduct
enforcement ladder](https://github.com/mozilla/diversity).

[homepage]: https://www.contributor-covenant.org

For answers to common questions about this code of conduct, see the FAQ at
https://www.contributor-covenant.org/faq. Translations are available at
https://www.contributor-covenant.org/translations.
<https://www.contributor-covenant.org/faq>. Translations are available at
<https://www.contributor-covenant.org/translations>.
6 changes: 4 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,10 @@ The Open Cloud Data Center initiative is focused on providing a standardized, sc

## Overview

The Open Cloud Data Center simplifies the deployment and management of cloud infrastructure through a modular, open-source architecture.
The Open Cloud Data Center simplifies the deployment and management of cloud infrastructure through a modular, open-source architecture.

**Why choose Open Cloud Data Center?**

- **Sovereignty**: Complete control over your data and infrastructure.
- **Portability**: Move workloads across cloud providers or on-premises hardware.
- **Cost-Efficiency**: Optimize resource usage and avoid vendor lock-in.
Expand All @@ -15,6 +16,7 @@ The Open Cloud Data Center simplifies the deployment and management of cloud inf
---

## Quick Start

```bash
git clone https://github.com/wso2/open-cloud-datacenter.git
cd open-cloud-datacenter
Expand All @@ -24,7 +26,7 @@ cd open-cloud-datacenter

## Reporting Product Issues

* **GitHub Issues**: [Report bugs or request features](https://github.com/wso2/open-cloud-datacenter/issues)
- **GitHub Issues**: [Report bugs or request features](https://github.com/wso2/open-cloud-datacenter/issues)

---

Expand Down
30 changes: 15 additions & 15 deletions docs/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,20 +8,20 @@ All contributors are expected to follow our [Code of Conduct](https://github.com

## How to Contribute

1. **Search for Issues**: Before starting work, check if an issue already exists for what you want to do.
2. **Report Bugs**: If you find a bug, please create a new issue with a clear description and steps to reproduce.
3. **Feature Requests**: We welcome ideas for new features! Create an issue to discuss your proposal.
4. **Submit Pull Requests**:
* Fork the repository.
* Create a new branch for your changes.
* Ensure your code follows our style guidelines.
* Include tests for new functionality.
* Make your changes and commit them with a descriptive message.
* Push your changes to your forked repository.
* Create a pull request against the `main` branch of the primary repository.
* Ensure your code adheres to the project's coding standards.
* Provide a clear description of your changes and the reason for them in the pull request.
* For more information, refer to [https://wso2.github.io/](https://wso2.github.io/)
1. **Search for Issues**: Before starting work, check if an issue already exists for what you want to do.
2. **Report Bugs**: If you find a bug, please create a new issue with a clear description and steps to reproduce.
3. **Feature Requests**: We welcome ideas for new features! Create an issue to discuss your proposal.
4. **Submit Pull Requests**:
- Fork the repository.
- Create a new branch for your changes.
- Ensure your code follows our style guidelines.
- Include tests for new functionality.
- Make your changes and commit them with a descriptive message.
- Push your changes to your forked repository.
- Create a pull request against the `main` branch of the primary repository.
- Ensure your code adheres to the project's coding standards.
- Provide a clear description of your changes and the reason for them in the pull request.
- For more information, refer to [https://wso2.github.io/](https://wso2.github.io/)

## Code Quality and Linting

Expand All @@ -35,6 +35,6 @@ If you're new to the project, look for issues tagged with `Good First Issue`. Th

## Community Engagement

- **Star the repo**: If you find Open Cloud Data Center useful, please give it a star!
- **Star the repository**: If you find Open Cloud Data Center useful, please give it a star!
- **Spread the word**: Share Open Cloud Data Center with your network.
- **Participate in discussions**: Join our GitHub discussions.
9 changes: 6 additions & 3 deletions issue_template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,18 +1,21 @@
**Description:**

<!-- Give a brief description of the issue -->

**Suggested Labels:**

<!-- Optional comma separated list of suggested labels. Non committers can’t assign labels to issues, so this will help issue creators who are not a committer to suggest possible labels-->

**Suggested Assignees:**

<!--Optional comma separated list of suggested team members who should attend the issue. Non committers can’t assign issues to assignees, so this will help issue creators who are not a committer to suggest possible assignees-->
Comment thread
VimukthiPerera marked this conversation as resolved.

**Affected Product Version:**

**OS, DB, other environment details and versions:**
**OS, DB, other environment details and versions:**

**Steps to reproduce:**


**Related Issues:**
<!-- Any related issues such as sub tasks, issues reported in other repositories (e.g component repositories), similar problems, etc. -->

<!-- Any related issues such as sub tasks, issues reported in other repositories (e.g component repositories), similar problems, etc. -->
Loading