forked from mikeyp-dell/core
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Rob Hirschfeld
committed
Feb 28, 2014
1 parent
970984c
commit cffc2b2
Showing
11 changed files
with
184 additions
and
50 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
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
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
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,112 @@ | ||
_Autogenerated, do not edit!_ | ||
#OpenCrowbar Documentation Index | ||
|
||
1. [Index](./Index.md) | ||
1. [OpenCrowbar Directory Structure](./OpenCrowbar-DirectoryLayout.md) | ||
1. [Deploy Guide](./deployment-guide/README.md) | ||
1. [OpenCrowbar RPM Deployment on CentOS 6.5](./deployment-guide/Install-CentOS-RHEL-6.5-AdminNode.md) | ||
1. [OpenCrowbar Developers' Guide](./development-guides/README.md) | ||
1. [translation missing: en.docs.missing](./development-guides/api/README.md) | ||
1. [OpenCrowbar API](./development-guides/api/api.md) | ||
1. [Attribute (aka Attrib) APIs](./development-guides/api/attrib.md) | ||
1. [Barclamp APIs](./development-guides/api/barclamp.md) | ||
1. [Logging Barclamp API extensions](./development-guides/api/barclamp_logging.md) | ||
1. [CMDB APIs](./development-guides/api/cmdb.md) | ||
1. [Barclamp/Config APIs](./development-guides/api/deployment.md) | ||
1. [Deployment-Role API](./development-guides/api/deployment_role.md) | ||
1. [DHCP Database](./development-guides/api/dhcp_database.md) | ||
1. [Group APIs](./development-guides/api/group.md) | ||
1. [Interface (NICs) API](./development-guides/api/interfaces.md) | ||
1. [Jig (aka CMDB interface) APIs](./development-guides/api/jig.md) | ||
1. [Network API](./development-guides/api/network.md) | ||
1. [Node APIs](./development-guides/api/node.md) | ||
1. [Node Role APIs](./development-guides/api/node_role.md) | ||
1. [Range API](./development-guides/api/range.md) | ||
1. [Role APIs](./development-guides/api/role.md) | ||
1. [Run APIs](./development-guides/api/run.md) | ||
1. [Snapshot API](./development-guides/api/snapshot.md) | ||
1. [Status APIs](./development-guides/api/status.md) | ||
1. [Test APIs](./development-guides/api/test.md) | ||
1. [translation missing: en.docs.missing](./development-guides/barclamps/README.md) | ||
1. [Crowbar Barclamps](./development-guides/barclamps/barclamps.md) | ||
1. [OpenCrowbar Suite Barclamps](./development-guides/barclamps/crowbar.md) | ||
1. [OpenCrowbar Barclamp](./development-guides/barclamps/crowbar/barclamp.md) | ||
1. [Deployer Barclamp](./development-guides/barclamps/crowbar/deployer.md) | ||
1. [DNS Barclamp](./development-guides/barclamps/crowbar/dns.md) | ||
1. [Logging Barclamp](./development-guides/barclamps/crowbar/logging.md) | ||
1. [Network Barclamp](./development-guides/barclamps/crowbar/network.md) | ||
1. [NTP Barclamp](./development-guides/barclamps/crowbar/ntp.md) | ||
1. [Test Barclamp](./development-guides/barclamps/crowbar/test.md) | ||
1. [Creating a New OpenCrowbar Barclamp](./development-guides/barclamps/new_barclamp.md) | ||
1. [NOT UPDATED >>> Barclamp Info](./development-guides/barclamps/wrong_name.md) | ||
1. [translation missing: en.docs.missing](./development-guides/code-contribution/README.md) | ||
1. [Contributing to OpenCrowbar](./development-guides/code-contribution/contributing.md) | ||
1. [translation missing: en.docs.missing](./development-guides/concepts/README.md) | ||
1. [Core OCB Objects Design Information](./development-guides/concepts/OCB-DesignInfo.md) | ||
1. [OpenCrowbar Concepts](./development-guides/concepts/concepts.md) | ||
1. [translation missing: en.docs.missing](./development-guides/database/README.md) | ||
1. [OpenCrowbar Database (Postgresql 9.3)](./development-guides/database/database.md) | ||
1. [translation missing: en.docs.missing](./development-guides/dev-systems/README.md) | ||
1. [openSUSE images <== This info is not current -- FixMe](./development-guides/dev-systems/dev-openSUSE-images.md) | ||
1. [Configuration Guide - Ubuntu 12.04.03](./development-guides/dev-systems/dev-ubuntu-12.04.03.md) | ||
1. [Crowbar Development Environment Using Fedora](./development-guides/dev-systems/dev-vm-Fedora.md) | ||
1. [Crowbar Development Based Upon SUSE](./development-guides/dev-systems/dev-vm-SUSE.md) | ||
1. [OpenCrowbar Development Environment Based Upon Ubuntu](./development-guides/dev-systems/dev-vm-Ubuntu.md) | ||
1. [Getting started with Crowbar development](./development-guides/dev-systems/dev-vm.md) | ||
1. [Docker Workload Containers](./development-guides/dev-systems/docker/README.md) | ||
1. [translation missing: en.docs.missing](./development-guides/doc-format-guides/README.md) | ||
1. [Adding Documentation](./development-guides/doc-format-guides/doc-dev-guide.md) | ||
1. [Formatting Documentation](./development-guides/doc-format-guides/formatting.md) | ||
1. [Topic Documentation](./development-guides/doc-format-guides/topic.md) | ||
1. [translation missing: en.docs.missing](./development-guides/jigs/README.md) | ||
1. [Chef Jig](./development-guides/jigs/chef.md) | ||
1. [Configuration Managers (aka Jigs)](./development-guides/jigs/jigs.md) | ||
1. [Noop Jig](./development-guides/jigs/noop.md) | ||
1. [Script Jig](./development-guides/jigs/script.md) | ||
1. [translation missing: en.docs.missing](./development-guides/model/README.md) | ||
1. [OpenCrowbar Design Topics](./development-guides/model/00100_CB2_Design_Topics.md) | ||
1. [Attrib Model](./development-guides/model/attrib.md) | ||
1. [Barclamp Model](./development-guides/model/barclamp.md) | ||
1. [Experimental OpenCrowbar Model](./development-guides/model/crowbar_model.md) | ||
1. [Deployment Model](./development-guides/model/deployment.md) | ||
1. [Deployment Role Model](./development-guides/model/deployment_role.md) | ||
1. [Group Model](./development-guides/model/group.md) | ||
1. [OpenCrowbar Data Models](./development-guides/model/model.md) | ||
1. [Node Model](./development-guides/model/node.md) | ||
1. [Node Role Model](./development-guides/model/node_role.md) | ||
1. [Role Model](./development-guides/model/role.md) | ||
1. [Run / Delayed Job](./development-guides/model/run.md) | ||
1. [Snapshot Model](./development-guides/model/snapshot.md) | ||
1. [User Model](./development-guides/model/user.md) | ||
1. [translation missing: en.docs.missing](./development-guides/testing/README.md) | ||
1. [BDD Testing](./development-guides/testing/bdd.md) | ||
1. [BDD Domain Specific Language (DSL)](./development-guides/testing/bdd/dsl.md) | ||
1. [BDD Internals](./development-guides/testing/bdd/internals.md) | ||
1. [What are the BDD *rats?](./development-guides/testing/bdd/rats.md) | ||
1. [Extending the DSL](./development-guides/testing/bdd/steps.md) | ||
1. [BDD testing RESTful APIs](./development-guides/testing/bdd/steps_rest.md) | ||
1. [BDD Tips and Tricks](./development-guides/testing/bdd/tips.md) | ||
1. [OpenCrowbar Environment Simulator](./development-guides/testing/simulator.md) | ||
1. [translation missing: en.docs.missing](./development-guides/training/README.md) | ||
1. [OpenCrowbar Video Library](./development-guides/training/videos.md) | ||
1. [translation missing: en.docs.missing](./development-guides/ui/README.md) | ||
1. [Adding Localizations (i18n)](./development-guides/ui/localization.md) | ||
1. [Adding Menu Items](./development-guides/ui/navigation.md) | ||
1. [Tips & Tricks (UI Developer)](./development-guides/ui/tips_and_tricks.md) | ||
1. [translation missing: en.docs.missing](./development-guides/workflow/README.md) | ||
1. [Workflow Overview](./development-guides/workflow/dev-workflow-overview.md) | ||
1. [Interact with Chef](./development-guides/workflow/knife-config.md) | ||
1. [translation missing: en.docs.missing](./faq/README.md) | ||
1. [Do you have a question?](./faq/do_you_have_a_question.md) | ||
1. [Frequently Asked Questions (FAQ)](./faq/faq.md) | ||
1. [translation missing: en.docs.missing](./licenses/README.md) | ||
1. [Crowbar Framework Licenses](./licenses/crowbar.md) | ||
1. [Deployer Barclamp Licenses](./licenses/crowbar/deployer.md) | ||
1. [DNS Barclamp Licenses](./licenses/crowbar/dns.md) | ||
1. [Crowbar Barclamp Licenses](./licenses/crowbar/licenses.md) | ||
1. [Logging Barclamp Licenses](./licenses/crowbar/logging.md) | ||
1. [Network Barclamp Licenses](./licenses/crowbar/network.md) | ||
1. [Deployer Barclamp Licenses](./licenses/crowbar/ntp.md) | ||
1. [Provisioner Barclamp Licenses](./licenses/crowbar/provisioner.md) | ||
1. [Test Barclamp Licenses](./licenses/crowbar/test.md) | ||
1. [NOT UPDATED >>> Licenses](./licenses/wrong_name.md) |
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 |
---|---|---|
@@ -1,4 +1,4 @@ | ||
# OpenCrowbar Developers' Guide | ||
# Development Guide | ||
|
||
Welcome to the amazing fuzziness of OpenCrowbar! | ||
|
||
|
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,24 @@ | ||
##Contributing Code | ||
|
||
###Fork The Code | ||
|
||
> we assume you already have a clone of `https://github.com/opencrowbar/core` | ||
1. create a personal fork of the `https://github.com/opencrowbar/core` | ||
1. Fork the code if you want to be able to submit changes | ||
1. You may want to rename your fork in Github to something like 'crowbar-core' to make it easier to track. We'll assume that you did that in these directions | ||
1. setup your git identity (one time only) | ||
1. `git config --global user.name "user.name"` | ||
1. `git config --global user.email "email.address"` | ||
1. add a personal remote: `git remote add personal `https://github.com/[yourgitnamehere]/[crowbar-core]` | ||
1. you can check your remotes using `git remote -v` | ||
|
||
##To create a pull request | ||
|
||
1. make your change and commit it: `git commit -a -m "I cut and pasted this"` | ||
1. get the latest code from origin: `git fetch` | ||
1. sync your code into the trunk: `git rebase` | ||
1. you may have to merge changes using `git add [file]= and =git rebase --continue--` | ||
1. run and pass all the BDD tests, [[link missing]] | ||
1. push your change to your personal repo in a branch: `git push personal master:[my-pull-request-branch]` | ||
1. from your Github fork UI, create a pull request from my-pull-request-branch |
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
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
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
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
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