forked from crowbar/barclamp-network
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'master' of https://github.com/crowbar/barclamp-network
- Loading branch information
Showing
3 changed files
with
26 additions
and
20 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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. | ||
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.