-
Notifications
You must be signed in to change notification settings - Fork 16
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #137 from tinnightcap/develop
Updates for lint checks r=gozer
- Loading branch information
Showing
31 changed files
with
4,281 additions
and
1,636 deletions.
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
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 |
---|---|---|
@@ -1 +1,2 @@ | ||
|
||
# Nubis - Feature Requests |
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,43 +1,78 @@ | ||
## Getting started with the Nubis Project | ||
Welcome to the Nubis Project. We hope you will find that it meets your requirements and is easy to use. In this document I will introduce you to the Nubis Project and give you a number of links to other documents that will help you along. | ||
|
||
|
||
The Nubis Project is in essence a framework for deploying applications to the cloud. At this time we support only Amazon Web Services (AWS). For an overview of our design principles I recommend you read our [manifesto](https://github.com/Nubisproject/nubis-docs/blob/master/MANIFESTO.md). | ||
# Getting started with the Nubis Project | ||
|
||
### Familiarize yourself with the Nubis Project | ||
Now, to get you up to speed with everything you will need to know to use the Nubis Project, I will provide for you a reading list. Not to worry, while this list looks long, most of the documents are quite short. | ||
* [Nubis Overview](https://github.com/Nubisproject/nubis-docs/blob/master/SYSTEM_OVERVIEW.md) will give you an outline of the pieces of the project. | ||
* [Git & GitHub](https://github.com/Nubisproject/nubis-docs/blob/master/GIT_GITHUB.md) provides some advice specific to Nubis. | ||
* [CloudFormation](https://github.com/Nubisproject/nubis-docs/blob/master/CLOUDFORMATION.md) walks through some recomendations on structure and workflow. | ||
* [Prerequisites](https://github.com/Nubisproject/nubis-docs/blob/master/PREREQUISITES.md) will get you set up with all the necessary tools. | ||
* [Project Onbording](https://github.com/Nubisproject/nubis-docs/blob/master/PROJECT_ONBOARDING.md) will guide you through onboarding your first application. | ||
Welcome to the Nubis Project. We hope you will find that it meets your | ||
requirements and is easy to use. In this document I will introduce you to the | ||
Nubis Project and give you a number of links to other documents that will help | ||
you along. | ||
|
||
### Deployment | ||
Now that you are familiar with the project and the process, it is time to get coding. The first step is to assemble your deployment repository. Then it will be time to deploy into the sandbox. | ||
The Nubis Project is in essence a framework for deploying applications to the | ||
cloud. At this time we support only Amazon Web Services (AWS). For an overview | ||
of our design principles I recommend you read our [manifesto](https://github.com/Nubisproject/nubis-docs/blob/master/MANIFESTO.md). | ||
|
||
As we have seen in various examples throughout these documents, you will need to create a deployment repository. Take a look at the [System Overview](link) document for details. | ||
## Familiarize yourself with the Nubis Project | ||
|
||
Once your repository is all set up the next step it to deploy into the sandbox. You can deploy following the procedures outlined in the [Project Onbording](https://github.com/Nubisproject/nubis-docs/blob/master/PROJECT_ONBOARDING.md#Application Build Out) doc. Some example commands can be found in our trusty [nubis-mediawiki](https://github.com/Nubisproject/nubis-mediawiki/blob/master/nubis/cloudformation/README.md) repository. | ||
Now, to get you up to speed with everything you will need to know to use the | ||
Nubis Project, I will provide for you a reading list. Not to worry, while this | ||
list looks long, most of the documents are quite short. | ||
|
||
* [Nubis Overview](https://github.com/Nubisproject/nubis-docs/blob/master/SYSTEM_OVERVIEW.md) | ||
will give you an outline of the pieces of the project. | ||
* [Git & GitHub](https://github.com/Nubisproject/nubis-docs/blob/master/GIT_GITHUB.md) | ||
provides some advice specific to Nubis. | ||
* [CloudFormation](https://github.com/Nubisproject/nubis-docs/blob/master/CLOUDFORMATION.md) | ||
walks through some recomendations on structure and workflow. | ||
* [Prerequisites](https://github.com/Nubisproject/nubis-docs/blob/master/PREREQUISITES.md) | ||
will get you set up with all the necessary tools. | ||
* [Project Onbording](https://github.com/Nubisproject/nubis-docs/blob/master/PROJECT_ONBOARDING.md) | ||
will guide you through onboarding your first application. | ||
|
||
### Bugs, Contributions and more | ||
We are super excited to have you here! If you have stumbled into an issue there are several ways to address it. | ||
## Deployment | ||
|
||
First, you can fix the issue yourself and file a pull request. You will find a guide in our [Contributing Doc](https://github.com/Nubisproject/nubis-docs/blob/master/CONTRIBUTING.md). | ||
Now that you are familiar with the project and the process, it is time to get | ||
coding. The first step is to assemble your deployment repository. Then it will | ||
be time to deploy into the sandbox. | ||
|
||
Next, you can file an issue. Simply navigate to the Nubis Project space on Github [here](https://github.com/Nubisproject), select the appropriate repository and click on the issues link. For example, to file an issue against nubis-stacks you would go [here](https://github.com/Nubisproject/nubis-stacks/issues) | ||
As we have seen in various examples throughout these documents, you will need to | ||
create a deployment repository. Take a look at the [System Overview](link) | ||
document for details. | ||
|
||
Finally if you are looking for a new feature to be supported, simply follow the [Feature Requests](https://github.com/Nubisproject/nubis-docs/blob/master/FEATURE_REQUESTS.md) guide. | ||
Once your repository is all set up the next step it to deploy into the sandbox. | ||
You can deploy following the procedures outlined in the [Project Onbording](https://github.com/Nubisproject/nubis-docs/blob/master/PROJECT_ONBOARDING.md#application-build-out) | ||
doc. Some example commands can be found in our trusty [nubis-mediawiki](https://github.com/Nubisproject/nubis-mediawiki/blob/master/nubis/cloudformation/README.md) | ||
repository. | ||
|
||
## Bugs, Contributions and more | ||
|
||
We are super excited to have you here! If you have stumbled into an issue there | ||
are several ways to address it. | ||
|
||
First, you can fix the issue yourself and file a pull request. You will find a | ||
guide in our [Contributing Doc](https://github.com/Nubisproject/nubis-docs/blob/master/CONTRIBUTING.md). | ||
|
||
Next, you can file an issue. Simply navigate to the Nubis Project space on | ||
Github [here](https://github.com/Nubisproject), select the appropriate | ||
repository and click on the issues link. For example, to file an issue against | ||
nubis-stacks you would go [here](https://github.com/Nubisproject/nubis-stacks/issues) | ||
|
||
Finally if you are looking for a new feature to be supported, simply follow the | ||
[Feature Requests](https://github.com/Nubisproject/nubis-docs/blob/master/FEATURE_REQUESTS.md) | ||
guide. | ||
|
||
--- | ||
|
||
## TODO | ||
|
||
Document these things | ||
|
||
* set up git repo | ||
* add nubis directory | ||
* add nubis directory | ||
* link to structure doc | ||
* discuss packer and nubis-builder | ||
* discuss packers use of puppet | ||
* discuss packer and nubis-builder | ||
* discuss packers use of puppet | ||
* describe cloudformation template system | ||
* link to cloudformation layout doc? | ||
* link to cloudformation layout doc? | ||
* discuss what is and is not appropritae to place in the bin directory | ||
* walk through deployment of application | ||
* need to link to set up for Nubis doc (set up aws, git, github, etc...) |
Oops, something went wrong.