Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
  • Loading branch information
Rob Hirschfeld committed Nov 1, 2013
2 parents 0573996 + c167445 commit 499525a
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 20 deletions.
26 changes: 26 additions & 0 deletions README.md
@@ -0,0 +1,26 @@
# Crowbar Documentation README

_This is not the documentation you are looking for, it is a pointer to the real documentation_

## Looking for Crowbar Resources?

[The Crowbar website](http://crowbar.github.io) has links to all information and is our recommended starting place.

## Specific Crowbar Documentation

We track Crowbar documentation with the code so that we can track versions of documentation with the code.

Here are commonly requested references:

* [Getting Started Guide](https://github.com/crowbar/barclamp-crowbar/tree/master/doc/gettingstarted.md)
* [User Resources](https://github.com/crowbar/barclamp-crowbar/tree/master/doc/userguide.md)
* [Developer Resources](https://github.com/crowbar/barclamp-crowbar/tree/master/doc/devguide.md)
* [Crowbar Release Management](https://github.com/crowbar/barclamp-crowbar/tree/master/doc/releases.md)

> You may need to look in subdirectories under the links below for additional details.
## Background
Crowbar documentation is distributed into multiple places under the /doc directory of each Crowbar module (aka "barclamps"). When the modules are installed, Crowbar combines all the /doc directories into a master documentation set. These directories are structured into subdirectories for general topics. This structure is common across all barclamps in the [Crowbar project](https://github.com/crowbar/)

> Please, do NOT add documentation in locations besides /doc! If necessary, expand this README to include pointers to important /doc information.
16 changes: 0 additions & 16 deletions README.txt

This file was deleted.

4 changes: 0 additions & 4 deletions doc/network.yml

This file was deleted.

0 comments on commit 499525a

Please sign in to comment.