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

Update documentation #4981

Merged
merged 11 commits into from
Dec 11, 2023
Merged

Update documentation #4981

merged 11 commits into from
Dec 11, 2023

Conversation

ferrarimarco
Copy link
Collaborator

@ferrarimarco ferrarimarco commented Dec 11, 2023

Proposed Changes

  1. Update the documentation to better describe how to use super-linter.
  2. Remove outdated information.

Readiness Checklist

Author/Contributor

  • I included all the needed documentation for this change.
  • I provided the necessary tests.

Reviewing Maintainer

  • Label as breaking if this is a large, fundamental change.
  • Label as either: automation, bug, documentation, enhancement, infrastructure.

BEGIN_COMMIT_OVERRIDE
chore: update documentation (#4981)
END_COMMIT_OVERRIDE

@ferrarimarco ferrarimarco added the documentation Improvements or additions to documentation label Dec 11, 2023
@ferrarimarco ferrarimarco self-assigned this Dec 11, 2023
@ferrarimarco ferrarimarco mentioned this pull request Dec 11, 2023
6 tasks
Copy link
Contributor

@zkoppert zkoppert left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like if we are removing the TEMPLATES/linter.yml file it should also be removed from the test: https://github.com/super-linter/super-linter/blob/main/test/inspec/super-linter/controls/super_linter.rb#L405

@ferrarimarco
Copy link
Collaborator Author

Yes, good catch!

Copy link
Contributor

@zkoppert zkoppert left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

:shipit:

@ferrarimarco ferrarimarco added this pull request to the merge queue Dec 11, 2023
Merged via the queue into main with commit d465382 Dec 11, 2023
3 checks passed
@ferrarimarco ferrarimarco deleted the update-docs branch December 11, 2023 22:02
ferrarimarco added a commit that referenced this pull request Dec 12, 2023
* main:
  Reduce duplication in CI and CD workflows (#4982)
  Move instructions from the wiki to docs (#4957)
  Update documentation (#4981)
ferrarimarco added a commit that referenced this pull request Dec 12, 2023
* main:
  Group log output on GitHub Actions (#4961)
  Reduce duplication in CI and CD workflows (#4982)
  Move instructions from the wiki to docs (#4957)
  Update documentation (#4981)
  Bump com.puppycrawl.tools:checkstyle in /dependencies/checkstyle (#4966)
  Bump isort from 5.12.0 to 5.13.0 in /dependencies/python (#4967)
  Bump pylint from 3.0.2 to 3.0.3 in /dependencies/python (#4968)
  Bump cfn-lint from 0.83.3 to 0.83.4 in /dependencies/python (#4969)
  Bump npm-groovy-lint from 13.0.0 to 13.0.2 in /dependencies (#4970)
  Bump typescript from 5.3.2 to 5.3.3 in /dependencies (#4972)
  Bump next from 14.0.3 to 14.0.4 in /dependencies (#4973)
  Bump react-redux from 9.0.1 to 9.0.3 in /dependencies (#4974)
  Bump renovate from 37.83.5 to 37.89.7 in /dependencies (#4975)
  Bump prettier from 3.1.0 to 3.1.1 in /dependencies (#4976)
  Bump stylelint-scss from 5.3.1 to 5.3.2 in /dependencies (#4977)
  Bump golang from 1.21.4-alpine to 1.21.5-alpine (#4978)
  Bump actions/stale from 8 to 9 (#4980)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants