Documentation

[happymcplaksin]

• General
  • What is noodle?
  • Who would benefit from using noodle?
  • How do we use noodle?
• Getting started
  • Quick start
  • Puppet module
  • Misc.? (Docker, package, etc.)
• Tutorials
  • Query syntax
  • Usage with Puppet
  • Adding ilks
  • Extensibility
• API

[tminor]

Wee!

WDYT about https://yardoc.org/? Or are you thinking more generic operational type documentation?

[tminor]

Oh, heh. I realize now that you probably mean this.

[happymcplaksin]

Oh, heh. I realize now that you probably mean this.

Well, maybe :) First, I'm surprised to see I wrote that much down! And I'm open to anything in terms of making the documentation better. I haven't used YARD before but, Shiley, it's great :)

doc.md is maybe OK for an overview with examples but it's really traditional documentation which covers all the details, explains how to install/configure/run/use/extend/etc. So I'd love any and all help and know you'll have great ideas!

[tminor]

Perhaps yard-sinatra could be a good way for documenting the API? I'll investigate further!

[happymcplaksin]

Thanks! Oh, also, learning/using OpenAPI (AKA Swagger) would probably be dreamy but that might be a bigger/v2 job

[tminor]

Markdown seems like the easiest/most straightforward way to handle documentation. What do you think about Read the Docs? It looks easy to use, but we could just start by creating a docs directory with markdown files in it. Maybe something like this as a start?

docs/
├── configuration.md
├── deployment.md
├── installation.md
└── overview.md