docs icon indicating copy to clipboard operation
docs copied to clipboard

"Getting Started with DebOps" to pole position

Open AnBuKu opened this issue 9 years ago • 3 comments

Currently Getting Started with DebOps is in the section Guides of the chapter DebOps playbooks. Path: Docs » DebOps playbooks » Guides » Getting Started with DebOps. - Short: Somewhere in the documentation.

Imagine, you are in the shoes of a DebOps Newbie and want to have a quick overview. Is DebOps for me? How do I get started? Can I quickly (20-30 minutes) do an initial set-up as a starter? Therefore I propose to rethink current place of Getting Started with DebOps . As a future place in the pole position (index on left side) in documentation, above DebOps scripts would make sense.

AnBuKu avatar Nov 19 '16 22:11 AnBuKu

Without having read all the intro again, I think that would make sense to have a more generic entry for new people and not start with the DebOps tools (one peace of the puzzle) first.

ypid avatar Nov 19 '16 22:11 ypid

Sounds good. This probably means that with current documentation system the guides should be moved to the debops/docs repository to be properly placed.

drybjed avatar Nov 22 '16 09:11 drybjed

@drybjed Could be done. Another way would be a separate repo like debops-intro or so. This would have the advantage of separate docs tests for PR which results in faster tests and easier to spot error messages.

ypid avatar Nov 22 '16 09:11 ypid