Merge pull request #244 from sensu/update_readme_v2

Update readme v2

Author: pzupan

.env.example

@@ -1,33 +1,41 @@
+# postgres specific variables
 POSTGRES_MAX_THREADS=5
 POSTGRES_PASSWORD=YOUR_BONSAI_DATABASE_PASSWORD
 
+# app server specific variables
 RAILS_MAX_THREADS=5
+SECRET_KEY_BASE=YOUR_SECRET_KEY_BASE
 
+# background jobs database
 REDIS_URL=redis://redis:6379
 
-SECRET_KEY_BASE=YOUR_SECRET_KEY_BASE
-
+# email specific ** REQUIRED **
 SENDGRID_API_KEY=YOUR_SEND_GRID_API_KEY
 FROM_EMAIL=[email protected]
 MAILER_DOMAIN=www.example.com
 
+# development enviroment domain variables ** REQUIRED **
 HOST=localhost
 APP_PORT=3000
 PROTOCOL=http
 
+# organizational variables ** REQUIRED **
 HOST_ORGANIZATION=sensu
 HOST_EMAIL=[email protected]
+# logo file should be in app/assets/images
 HOST_LOGO=sensu.png
+# ranked higher in search results
 HOST_PREFERRED_OWNER_NAMES="'sensu','sensu-plugins'"
 
-OAUTH_ACCOUNT_PROVIDER=github
-
+# error reporting
 AIRBRAKE_PROJECT_ID=YOUR_AIRBRAKE_ID
 AIRBRAKE_API_KEY=YOUR_AIRBRAKE_KEY
 
+# Google Tag variables
 GOOGLE_TAG_MANAGER_ID=YOUR_TAG_ID
 GOOGLE_ANALYTICS_ID=YOUR_ANALYTICS_ID
 
+# Amazon S3 variables ** REQUIRED **
 AWS_S3_KEY_ID=YOUR_AWS_S3_KEY_ID
 AWS_S3_ACCESS_KEY=YOUR_AWS_S3_ACCESS_KEY
 AWS_S3_REGION=YOUR_AWS_S3_REGION
@@ -40,25 +48,31 @@ AWS_S3_ASSETS_BUCKET=YOUR_AWS_S3_ASSETS_BUCKET
 # See https://docs.aws.amazon.com/AmazonS3/latest/dev/VirtualHosting.html#VirtualHostingCustomURLs
 # AWS_S3_VANITY_HOST=YOUR_AWS_S3_VANITY_HOST
 
+# github variables ** REQUIRED **
 GITHUB_CLIENT_ID=GITHUB_CLIENT_ID
 GITHUB_CLIENT_SECRET=GITHUB_CLIENT_SECRET
 GITHUB_ACCESS_TOKEN=GITHUB_ACCESS_TOKEN
 
+# oauth variables ** REQUIRED **
+OAUTH_ACCOUNT_PROVIDER=github
 OAUTH2_VERIFY_SSL=false
 
+# optional CLA variables
 CLA_SIGNATURE_NOTIFICATION_EMAIL=[email protected]
 CLA_REPORT_EMAIL=[email protected]
 CCLA_VERSION=99999-2621/LEGAL14767024.1
 ICLA_VERSION=99999-2621/LEGAL14767024.1
 
+# optional PubSub variables
 PUBSUBHUBBUB_SECRET=YOUR_PUBSUBHUBBUB_SECRET
 PUBSUBHUBBUB_CALLBACK_URL=http://example.com
 
 FEATURES=tools,hosted_extensions
 
+# optional Fieri variables
 FIERI_URL=http://example.com
 FIERI_KEY=YOUR_FIERI_KEY
 
 ROBOTS_ALLOW=/
 
-ENFORCE_PRIVACY=true
+ENFORCE_PRIVACY=true

LICENSE

@@ -0,0 +1,201 @@
+                              Apache License
+                        Version 2.0, January 2004
+                     http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+       Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+       stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+       that You distribute, all copyright, patent, trademark, and
+       attribution notices from the Source form of the Work,
+       excluding those notices that do not pertain to any part of
+       the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+       distribution, then any Derivative Works that You distribute must
+       include a readable copy of the attribution notices contained
+       within such NOTICE file, excluding those notices that do not
+       pertain to any part of the Derivative Works, in at least one
+       of the following places: within a NOTICE text file distributed
+       as part of the Derivative Works; within the Source form or
+       documentation, if provided along with the Derivative Works; or,
+       within a display generated by the Derivative Works, if and
+       wherever such third-party notices normally appear. The contents
+       of the NOTICE file are for informational purposes only and
+       do not modify the License. You may add Your own attribution
+       notices within Derivative Works that You distribute, alongside
+       or as an addendum to the NOTICE text from the Work, provided
+       that such additional attribution notices cannot be construed
+       as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+   To apply the Apache License to your work, attach the following
+   boilerplate notice, with the fields enclosed by brackets "[]"
+   replaced with your own identifying information. (Don't include
+   the brackets!)  The text should be enclosed in the appropriate
+   comment syntax for the file format. We also recommend that a
+   file or class name and description of purpose be included on the
+   same "printed page" as the copyright notice for easier
+   identification within third-party archives.
+
+Copyright 2013 Chef, Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

README.md

@@ -1,24 +1,77 @@
-# README
+# Bonsai
 
-This README would normally document whatever steps are necessary to get the
-application up and running.
+Bonsai is Sensu's community repository for assets, currently
+hosted at [bonsai.sensu.io](bonsai.sensu.io). 
 
-Things you may want to cover:
+This is an open source project, with a Ruby on Rails framework. The code is designed to be easy for you to understand and facilitate your contributions. To that end, the goal of this README is to introduce you to the project and get you up and running. 
 
-* Ruby version
+If you want to contribute to Bonsai Asset Index, read the [contributor's
+workflow](https://github.com/sensu/bonsai/blob/update_readme/CONTRIBUTING.md)
+for license information and helpful tips to get you started. 
 
-* System dependencies
+If you have questions, feature ideas, or other suggestions, please [open a
+GitHub Issue](https://github.com/sensu/bonsai/issues/new).
 
-* Configuration
+## Requirements
 
-* Database creation
+- Ruby 2.5.1
+- PostgreSQL 9.2+
+- Redis 2.4+
 
-* Database initialization
+## Development
 
-* How to run the test suite
+### Setup Using Docker Compose
 
-* Services (job queues, cache servers, search engines, etc.)
+1. Make sure [Docker](https://www.docker.com/get-started) and [Docker Compose](https://docs.docker.com/compose/gettingstarted/) are installed locally.
+2. In the project root, copy the file .env.example to .env and change the keys and secrets to work in your local environment (see below).
+3. From the project root, run "docker-compose build" to create your docker images
+4. Create the database:  "docker-compose run web rake db:create"
+5. Run migrations:  "docker-compose run web rake db:migrate"
+6. Run seeds:  "docker-compose run web rake db:seed"
+7. Launch app & services: "docker-compose up"
+8. The app should now be available at http://localhost:3000
+9. (Optional) To run byebug; docker-compose run --service-ports web. Be aware, the background jobs do not run with this operation.
+11. (Optional) To run tests; docker-compose run -e "RAILS_ENV=test" web rspec
 
-* Deployment instructions
+### ENV Variable Descriptions
+The ENV file allows you to customize your environmental variables.  Most work by default, but there are several that require information to function properly.  You should copy the env.example file to a file named env and change the variables with your information. The required variables are indicted in the env.example file.
 
-* ...
+### Setting up Admin
+1. In the rails console find your user record `user = User.find_by(email: "[email protected]")`
+2. Add Admin authority `user.roles(:admin)`
+
+
+## Production
+
+### Setup on Heroku
+You can create the Heroku application via the Heroku CLI or use the app.example.json file in the root to generate it.  You must copy the app.example.json file to app.json and add your ENV variable values before using it.
+
+## API Documents
+Once you have set up the environment and have the application running, you will find the API Docs at [/apidoc](http://localhost:3000/apidoc).
+
+## Example Bonsai Asset on Github
+An example of a github asset with annotated bonsai.yml file can be found at [https://github.com/sensu/sensu-slack-handler](https://github.com/sensu/sensu-slack-handler)
+
+## Example of the file structure for hosted assets
+TBD
+
+# License
+
+|                      |                                          |
+|:---------------------|:-----------------------------------------|
+| **Copyright:**       | Copyright (c) 2018 Sensu, Inc.
+| **License:**         | Apache License, Version 2.0
+
+```text
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+```