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

Documentation refactoring #2352

Merged
merged 1 commit into from Aug 29, 2022
Merged

Documentation refactoring #2352

merged 1 commit into from Aug 29, 2022

Conversation

ssbarnea
Copy link
Member

@ssbarnea ssbarnea commented Aug 28, 2022 •
edited

  • each rule documentation has its own page
  • usage documentation about rules moved under usage guide
  • all rules are listed directly under Rule topic (1st level)
  • few other minor changes

@ssbarnea ssbarnea requested review from a team as code owners August 28, 2022 13:28
@github-actions github-actions bot added the skip-changelog Can be missed from the changelog. label Aug 28, 2022
@ssbarnea ssbarnea changed the title Refactored documentation Documentation refactoring Aug 28, 2022
@ssbarnea ssbarnea force-pushed the chore/xx branch 7 times, most recently from 95cc1b1 to 8e606c7 Compare August 28, 2022 15:14
cognifloyd
cognifloyd previously requested changes Aug 28, 2022
View reviewed changes
Copy link
Member

@cognifloyd cognifloyd left a comment

Choose a reason for hiding this comment

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

Some wording suggestions.

src/ansiblelint/generate_docs.py Outdated Show resolved Hide resolved
docs/index.md Outdated Show resolved Hide resolved
docs/index.md Show resolved Hide resolved
docs/philosophy.md Outdated Show resolved Hide resolved
docs/philosophy.md Outdated Show resolved Hide resolved
docs/philosophy.md Outdated Show resolved Hide resolved
docs/philosophy.md Outdated Show resolved Hide resolved
docs/philosophy.md Outdated Show resolved Hide resolved
docs/philosophy.md Outdated Show resolved Hide resolved
docs/philosophy.md Outdated Show resolved Hide resolved
@ssbarnea
Documentation refactoring
4ed858d 
- each rule documentation has its own page
- usage documentation about rules moved under usage guide
- all rules are listed directly under Rule topic (1st level)
- grammar fixes
@ssbarnea ssbarnea merged commit 2293a93 into ansible:main Aug 29, 2022
@ssbarnea ssbarnea added bug and removed skip-changelog Can be missed from the changelog. labels Aug 29, 2022
@ssbarnea ssbarnea deleted the chore/xx branch August 30, 2022 13:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@cognifloyd cognifloyd cognifloyd left review comments

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

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

@shatakshiiii shatakshiiii Awaiting requested review from shatakshiiii shatakshiiii 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.

None yet
2 participants
@ssbarnea @cognifloyd