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

docs(readme): show only one level in table of contents #62

Merged

Conversation

myii
Copy link
Member

@myii myii commented May 4, 2020

PR progress checklist (to be filled in by reviewers)

  • Changes to documentation are appropriate (or tick if not required)
  • Changes to tests are appropriate (or tick if not required)
  • Reviews completed

What type of PR is this?

Primary type

  • [build] Changes related to the build system
  • [chore] Changes to the build process or auxiliary tools and libraries such as documentation generation
  • [ci] Changes to the continuous integration configuration
  • [feat] A new feature
  • [fix] A bug fix
  • [perf] A code change that improves performance
  • [refactor] A code change that neither fixes a bug nor adds a feature
  • [revert] A change used to revert a previous commit
  • [style] Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc.)

Secondary type

  • [docs] Documentation changes
  • [test] Adding missing or correcting existing tests

Does this PR introduce a BREAKING CHANGE?

No.

Related issues and/or pull requests

Describe the changes you're proposing

Pillar / config required to test the proposed changes

Debug log showing how the proposed changes work

Documentation checklist

  • Updated the README (e.g. Available states).
  • Updated pillar.example.

Testing checklist

  • Included in Kitchen (i.e. under state_top).
  • Covered by new/existing tests (e.g. InSpec, Serverspec, etc.).
  • Updated the relevant test pillar.

Additional context

@pull-assistant
Copy link

pull-assistant bot commented May 4, 2020

Score: 1.00

Best reviewed: commit by commit


Optimal code review plan

     docs(readme): show only one level in table of contents

Powered by Pull Assistant. Last update 081c77a ... 081c77a. Read the comment docs.

@commit-lint
Copy link

commit-lint bot commented May 4, 2020

Documentation

  • readme: show only one level in table of contents (a5e384a)

Contributors

@myii

@myii
Copy link
Member Author

myii commented May 4, 2020

Actually, I was using this very basic PR to test https://github.com/marketplace/actions/commit-linter, which I've set up in the main .github repo for this org. It didn't pick it up so I'll have to arrange for the workflow to be managed using the ssf-formula.

@myii myii force-pushed the docs/show-only-one-level-in-readme-toc branch from a5e384a to 081c77a Compare May 4, 2020 08:12
@myii myii merged commit e1375cf into saltstack-formulas:master May 4, 2020
@myii myii deleted the docs/show-only-one-level-in-readme-toc branch May 4, 2020 08:26
@saltstack-formulas-travis

🎉 This PR is included in version 0.10.1 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants