Skip to content

Instantly share code, notes, and snippets.

@konung
Last active February 3, 2018 21:02
Show Gist options
  • Save konung/8f5a4bf18308584f1b8ecead04c12f8b to your computer and use it in GitHub Desktop.
Save konung/8f5a4bf18308584f1b8ecead04c12f8b to your computer and use it in GitHub Desktop.
# ## Docs setup
# ### On Github
# Fork api-docs repo on github to your account.
# Any change you make you should push to your repo first ( into a branch preferably) and then create a pull-request to trailblazer
#
# ## Locally
# Create a local folder like ~/projects/trailblazer/docs ( or whatever)
# Where you are going to keep local copies of the gems.
#
# cd into the said directory
#
# Clone your api-docs repo locally.
cd api-docs
git clone [email protected]:[YOUR GITHUB ACCOUNT NAME]/api-docs
cd ..
#
# Set upstream to trailblazer api-docs, so that you can keep in sync with any changes
git remote add upstream [email protected]:trailblazer/api-docs
git pull upstream
#
# ## Setup local copies of gems
# This is needed so that docs can compile. They need to be cloned into the same parent directory
#
git clone [email protected]:trailblazer/cells
git clone [email protected]:trailblazer/formular
git clone [email protected]:trailblazer/reform
git clone [email protected]:trailblazer/representable
git clone [email protected]:trailblazer/roar
git clone [email protected]:trailblazer/roar-jsonapi
git clone [email protected]:trailblazer/trailblazer
git clone [email protected]:trailblazer/trailblazer-activity
git clone [email protected]:trailblazer/trailblazer-args
git clone [email protected]:trailblazer/trailblazer-cells
git clone [email protected]:trailblazer/trailblazer-compat
git clone [email protected]:trailblazer/trailblazer-context
git clone [email protected]:trailblazer/trailblazer-developer
git clone [email protected]:trailblazer/trailblazer-endpoint
git clone [email protected]:trailblazer/trailblazer-generator
git clone [email protected]:trailblazer/trailblazer-loader
git clone [email protected]:trailblazer/trailblazer-operation
git clone [email protected]:trailblazer/trailblazer-rails-basic-setup
git clone [email protected]:trailblazer/trailblazer-test
git clone [email protected]:trailblazer/trailblazer-transform
git clone [email protected]:apotonick/torture
# ## Startup Docs
cd api-docs
bundle install
bundle exec middleman server
# ## Keeping gems in sync
# To pull ALL changed for all gems you can use this little snippet.
# You can also alias it to a command in in you .bash_profile
# alias git_pull_all 'find . -type d -name .git -exec sh -c "cd \"{}\"/../ && pwd && git pull " \;'
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment