Skip to content

Commit 31b80c1

Browse files
Add bower link instructions to readme under contributing heading
1 parent 5709d8a commit 31b80c1

File tree

1 file changed

+38
-0
lines changed

1 file changed

+38
-0
lines changed

README.md

+38
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,44 @@ If Jenkins complains that the built dist files are different than the committed
9292
3. Run `grunt build`
9393
4. If anything under dist or dist.java has changed, add it to your commit and re-push
9494
95+
#### Contributing to the primary repositories
96+
97+
The web console is currently split into three repositories. The two dependency repos are
98+
[origin-web-common](https://github.com/openshift/origin-web-common) and
99+
[origin-web-catalog](https://github.com/openshift/origin-web-catalog).
100+
To make changes to one of these repositories while working in the web console, it is recommended that you clone down the
101+
repository and create a `bower link`. The following example assumes you clone your forks to `~/git-repos`:
102+
103+
```bash
104+
# fork the origin-web-console & clone:
105+
$ cd ~/git-repos
106+
$ git clone [email protected]:<your-fork>/origin-web-console.git
107+
# fork origin-web-common & clone:
108+
$ cd ~/git-repos
109+
$ git clone [email protected]:<your-fork>/origin-web-common.git
110+
# fork origin-web-catalog & clone:
111+
$ cd ~/git-repos
112+
$ git clone [email protected]:<your-fork>/origin-web-catalog.git
113+
#
114+
# Now, using bower link you can:
115+
$ cd ~/git-repos/origin-web-common
116+
$ bower link
117+
$ cd ~/git-repos/origin-web-catalog
118+
$ bower link
119+
$ cd ~/git-repos/origin-web-console
120+
$ bower link origin-web-common
121+
$ bower link origin-web-catalog
122+
#
123+
# NOTE:
124+
# When you make changes in the linked repos you will need to rebuild
125+
# as origin-web-console pulls from the /dist. `grunt build` or `grunt watch`
126+
# should take care of this.
127+
```
128+
129+
When finished, be sure to `hack/clean-deps.sh` and `hack/install-deps.sh` to remove
130+
the links & avoid having issues with `/dist` conflicts the next time you build.
131+
132+
95133
Architecture
96134
------------
97135

0 commit comments

Comments
 (0)