Skip to content

Commit

Permalink
Update readme.md
Browse files Browse the repository at this point in the history
Readme update
  • Loading branch information
EmilyNecciai authored Apr 1, 2019
1 parent 62c8f3c commit 4fc09b4
Showing 1 changed file with 32 additions and 69 deletions.
101 changes: 32 additions & 69 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,80 +1,43 @@
# Success!!
# Welcome to Braze Docs!

This repository houses the content on Braze's [Docs](https://braze.com/docs/), the [User Guide](https://braze.com/docs/user_guide/), and the [Developer Guide](https://braze.com/docs/developer_guide/).
This is where you can contribute to the [Braze Documentation site](www.braze.com/docs).

## Initial Setup
For friends in Success, Product, and Marketing, please find the necessary steps [here](https://github.com/Appboy/success/wiki/Setting-up-your-local-environment).
## What You Need to Know

For friends in Engineering (or anyone using rbenv) - if you are having problems related to ruby versions (i.e. `ruby -v` tells you that you are not on 2.2.4), try adding the following to your .bash_profile:
```
if which rbenv > /dev/null; then eval "$(rbenv init -)"; fi
```
- This is a [Jekyll](https://github.com/Appboy/braze-docs/wiki/Jekyll-Overview) site.
- This branch is merged to our master branch and the production site at least weekly on Tuesdays.

## SITE UPDATE
Documentation is currently being updated and redesigned. If you're having trouble with the new site, and getting build error, try the following steps:
If you would like us to incorporate your changes into the official version of the document, you can submit changes to the Appboy/docs Github Repo and we will review the changes. If we accept any such changes, they will be licensed to us under the CLA found at http://www.braze.com/docs/cla.

* Assume basic Jekyll local installed already done, otherwise follow [Wiki instructions](https://github.com/Appboy/success/wiki/Setting-up-your-local-environment).
* Optional: Upgrade rvm
* `rvm get stable`
* Upgrade Ruby
* `rvm install ruby-2.5.1`
* Have rvm using new Ruby
* `rvm use ruby-2.5.1`
* Update Jekyll and Gems
* `gem install bundler`
* `bundle install`
## Table of Contents
- [About Braze](#about-braze)
- [Our CLA](#braze-cla)
- [Braze Open Source License](#open-source-license)
- [Before You Contribute](#before-you-contribute)

Afterwards, you should be able to do the normal Jekyll build or rake process.

## Wiki
For more information on this repository and making changes to the [User Guide](https://braze.com/docs/user_guide/) and the [Developer Guide](https://braze.com/docs/developer_guide/), please visit the wiki [here](https://github.com/Appboy/success/wiki).
### About Braze
[Braze Home Site](https://www.braze.com/)

## Heroku Setup (ignore unless your name is Sal)
#### Git Config
```
git remote add staging https://git.heroku.com/ab-success.git
git remote add production https://git.heroku.com/ab-success-production.git
git remote add -t master -m master -f secure git@github.com:AppboySecure/success.git
git checkout -b master -t secure/master
git checkout develop
```
#### Ruby
```
brew update && brew upgrade ruby-build && brew upgrade rbenv-gemset;
eval "$(rbenv init -)"
rbenv install 2.2.4
rbenv local 2.2.4
gem install bundler -v 1.11.2
rbenv rehash
bundle install
```
### Heroku
#### Logs
##### Staging
`heroku logs --remote staging`
##### Production
`heroku logs --remote production`
#### Deploy
##### Staging
`git push staging develop:master`
##### Production
`git push production master:master`
[Braze Legal Information](https://www.braze.com/legal)

## Herokou Troubleshooting Pull Request
To view logs for Heroku pull request, get access to ab-success on heroku, and follow heroku documentation to get the [CLI install](https://devcenter.heroku.com/articles/heroku-cli)
### Braze CLA
Before you get started, Braze requires that a Braze Contributor License Agreement (CLA) be filled out by every contributor to the Braze Docs open source project.

### Custom git Pull Request Remote
Add Custom Pull Request to remote (Replace testpr with desire remote name)
```
git remote add testpr https://git.heroku.com/ab-success-pr-[pullrequestnumber].git
```
Or rename existing remote with the Pull Request
```
git remote set-url testpr https://git.heroku.com/ab-success-pr-[pullrequestnumber].git
```
Braze will not merge a pull request made against a Braze Docs open source project until that pull request is associated with a signed CLA. [Sign a CLA here](http://www.braze.com/docs/cla).

### View Pull Request Log
To pull the request log (or replace testpr with previous remote name)
```
heroku logs --remote testpr
```
### Open Source License

![Licence Icon](https://github.com/Appboy/braze-docs/blob/master/assets/img/github/ccimg.png)

Braze Documentation is licensed under the [Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License](https://creativecommons.org/licenses/by-nc-sa/4.0/).

### Before You Contribute
1. Complete our [CLA](http://www.braze.com/docs/cla).
2. Take the [Braze Docs Tour](www.braze.com/docs/tour).
3. Check out [our Wiki](https://github.com/Appboy/braze-docs/wiki) - especially…
- the [Contributor Quick Start Guide](https://github.com/Appboy/braze-docs/wiki/Contributor-Quick-Start-Guide),
- [Set Up Your Local Environment](https://github.com/Appboy/braze-docs/wiki/Set-Up-Your-Local-Environment),
- [the Writing Style Guide](https://github.com/Appboy/braze-docs/wiki/Writing-Style-Guide-&-Best-Practices),
- [the Markdown Formatting Style Guide](https://github.com/Appboy/braze-docs/wiki/Special-Formatting), and
- [the Media Style Guide](https://github.com/Appboy/braze-docs/wiki/Media-Formatting-Guide).

0 comments on commit 4fc09b4

Please sign in to comment.