Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updates to the documentation #131

Merged
merged 12 commits into from
Feb 17, 2017
Prev Previous commit
Next Next commit
Minor changes to the developer guide
  • Loading branch information
jmiranda committed Feb 17, 2017
commit 9ea8ed778da6c07c98ce3d26c6549dd2a5ea149f
Original file line number Diff line number Diff line change
Expand Up @@ -2,29 +2,28 @@
# Syncing your fork

## Resources
* https://help.github.com/articles/configuring-a-remote-for-a-fork/

* [Configuring a Remote for a Fork](https://help.github.com/articles/configuring-a-remote-for-a-fork/)
* [Syncing a Fork](https://help.github.com/articles/syncing-a-fork/)

## List your remote repositories

$ git remote -v
origin https://github.com/YOUR_USERNAME/openboxes.git (fetch)
origin https://github.com/YOUR_USERNAME/openboxes.git (push)


## Add the openboxes repository as an upstream remote repository

## Add the upstream remote

$ git remote add upstream https://github.com/openboxes/openboxes.git


## Verify that the new upstream repository has been added.

## Verify upstream remote

$ git remote -v
origin https://github.com/YOUR_USERNAME/YOUR_FORK.git (fetch)
origin https://github.com/YOUR_USERNAME/YOUR_FORK.git (push)
upstream https://github.com/ORIGINAL_OWNER/ORIGINAL_REPOSITORY.git (fetch)
upstream https://github.com/ORIGINAL_OWNER/ORIGINAL_REPOSITORY.git (push)


## Pull changes into your fork as upstream/master

$ git fetch upstream
Expand All @@ -34,11 +33,8 @@
Receiving objects: 100% (4165/4165), 1.83 MiB | 329.00 KiB/s, done.
Resolving deltas: 100% (2728/2728), completed with 583 local objects.
From https://github.com/openboxes/openboxes
* [new branch] 157-integrate-with-keen-io -> upstream/157-integrate-with-keen-io
* [new branch] 2.2 -> upstream/2.2
* [new branch] develop -> upstream/develop
* [new branch] feature/94-upgrade-to-grails-2.5.x -> upstream/feature/94-upgrade-to-grails-2.5.x
* [new branch] gh-pages -> upstream/gh-pages
* [new branch] hotfix/100-improve-performance-qoh-calculation -> upstream/hotfix/100-improve-performance-qoh-calculation
* [new branch] hotfix/161-support-additional-languages -> upstream/hotfix/161-support-additional-languages
* [new branch] hotfix/163-add-health-endpoint-for-monitoring -> upstream/hotfix/163-add-health-endpoint-for-monitoring
Expand All @@ -47,11 +43,12 @@
* [new branch] master -> upstream/master
* [new branch] user-guide-docs -> upstream/user-guide-docs

## Checkout the branch you want to sync (probably either develop or master)
## Checkout the branch you want to sync
This will likely either be `develop` or `master`.

$ git checkout master

## Merge upstream/master into master
## Merge upstream/master into you local master

$ git merge upstream/master

Expand All @@ -61,4 +58,5 @@

## Profit

![Profit](../img/profit.jpg)
![Profit](img/profit.jpg)
File renamed without changes.
6 changes: 3 additions & 3 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ pages:
# Installation
- ['installation/index.md', 'Installation', 'Overview']
- ['installation/ubuntu.md', 'Installation', 'Ubuntu']
- ['installation/mac.md', 'Installation', 'Mac OS X']
- ['installation/macos.md', 'Installation', 'Mac OS']
- ['installation/windows.md', 'Installation', 'Windows']

# Configuration
Expand All @@ -31,8 +31,8 @@ pages:
# Developer Guide
- ['developer-guide/introduction.md', 'Developer Guide', 'Introduction']
- ['developer-guide/getting-started.md', 'Developer Guide', 'Getting Started']
- ['developer-guide/contributing/index.md', 'Contributing', 'Introduction']
- ['developer-guide/contributing/syncing-a-fork.md', 'Contributing', 'Syncing a Fork']
- ['developer-guide/contributing.md', 'Developer Guide', 'Contributing']
- ['developer-guide/syncing-a-fork.md', 'Developer Guide', 'Syncing a Fork']
- ['developer-guide/tagging.md', 'Developer Guide', 'Tagging a Release']

# Support - add a page like https://readthedocs.org/support/
Expand Down