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

Polish documentation #69

Closed
dhodovsk opened this issue Apr 9, 2018 · 2 comments
Closed

Polish documentation #69

dhodovsk opened this issue Apr 9, 2018 · 2 comments

Comments

@dhodovsk
Copy link
Member

dhodovsk commented Apr 9, 2018

Update documentation before we can ship it:
Ideas:

  • Provide lists of checks for ecosystem
  • Show how it can be used as python module
@phracek
Copy link
Member

phracek commented Apr 9, 2018

List of checks will be generated automatically by each commit.
I suggest structure like:

  • index.rst ... which will contain a basic information and how it can be used from CLI
    |- check_list ... which will contain a full set of checks
    |- Python API ... shows, how it can be used from python

Any other idea?

@TomasTomecek
Copy link
Member

container

I do the same thing when I intend to write contain. We are cursed.

One nit: s/check_list/list_of_checks/

phracek added a commit that referenced this issue Apr 10, 2018
Signed-off-by: Petr "Stone" Hracek <phracek@redhat.com>
phracek added a commit that referenced this issue Apr 10, 2018
Fixes #69 documentation for colin
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants