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.

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

Jump to bottom

Improve documentation on custom rules #2685

Merged
merged 4 commits into from
Nov 20, 2022
Merged

Improve documentation on custom rules #2685

merged 4 commits into from
Nov 20, 2022

Conversation

oraNod
Copy link
Collaborator

@oraNod oraNod commented Nov 15, 2022

Partially fixes #2672 with documentation for custom lint rules

@oraNod oraNod requested a review from a team as a code owner November 15, 2022 10:58
@oraNod oraNod requested review from a team, ganeshrn, audgirka and trishnaguha November 15, 2022 10:58
ssbarnea
ssbarnea requested changes Nov 17, 2022
View reviewed changes
Copy link
Member

@ssbarnea ssbarnea left a comment

Choose a reason for hiding this comment

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

Please avoid adding ansible-lint to any documentation titles as this will make the sidebar menu harder to read.

There is no need to repeat the name of the product in titles, it is already part of the URL and page structure.

@ssbarnea ssbarnea changed the title Docs: issue #2672 custom rules Improve documentation on custom rules Nov 17, 2022
@ssbarnea ssbarnea added the bug label Nov 17, 2022
@oraNod oraNod requested a review from ssbarnea November 18, 2022 09:53
@ssbarnea ssbarnea merged commit c3e07c6 into ansible:main Nov 20, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ssbarnea ssbarnea ssbarnea approved these changes

@ganeshrn ganeshrn Awaiting requested review from ganeshrn ganeshrn is a code owner automatically assigned from ansible/devtools

@audgirka audgirka Awaiting requested review from audgirka audgirka is a code owner automatically assigned from ansible/devtools

@trishnaguha trishnaguha Awaiting requested review from trishnaguha trishnaguha is a code owner automatically assigned from ansible/devtools

Assignees
No one assigned
Labels
bug
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Docs: Installation and configuration
2 participants
@oraNod @ssbarnea