Include setup command to checkout git submodule
Change-Id: Ifdbfd30ff1cb35951a6ba8cbe2b14c8d87325c59
Signed-off-by: Joey Armstrong <jarmstrong@linuxfoundation.org>
diff --git a/gerrit/README.md b/gerrit/README.md
index d2fc2ed..baea5a6 100644
--- a/gerrit/README.md
+++ b/gerrit/README.md
@@ -1,17 +1,18 @@
-VOLTHA: Gerrit Queries
-======================
+# Gerrit Queries
A script for constructing gerrit JCL queries
```bash
% git clone ssh://gerrit.opencord.org/onf-scripts
-% cd onf-scripts/gerrit/bin
-% ./gerrit.sh –help
+# Checkout git submodules
+% make -C onf-scripts
+
+% cd onf-scripts/gerrit/bin
+% gerrit.sh –help
```
-Gerrit by patch or user
------------------------
+## Gerrit by patch or user
| Jira | Command | Description |
| ---- | ------- | ----------- |
@@ -20,37 +21,32 @@
| [x](https://gerrit.opencord.org/q/status:open) | gerrit.sh --all voltha-lib-go | Display metadata for a repo: branches, tags, source |
| [x](https://gerrit.opencord.org/q/status:merged) | gerrit.sh --status merged [--user u] | View merged patches |
-Search for unmerged patches
--------------------
+## Search for unmerged patches
| Jira | Command | Description |
| ---- | ------- | ----------- |
| [x](https://gerrit.opencord.org/q/owner:joey@opennetworking.org+status:open) | gerrit.sh --wip --me | Display my unmerged patches |
-Pending code reviews
------------------------
+## Pending code reviews
| Jira | Command | Description |
| ---- | ------- | ----------- |
| [x](https://gerrit.opencord.org/q/reviewer:self) | gerrit.sh --review --my | Display my pending code reviews |
| [x](https://gerrit.opencord.org/q/reviewer:self) | gerrit.sh --reviewer [u] --reviewer [u]| Display pending code reviews by user |
-By repository
--------------
+## By repository
| Jira | Command | Description |
| ---- | ------- | ----------- |
| [x](https://gerrit.opencord.org/q/voltha-lib-go+status:open) | gerrit.sh --patch voltha-lib-go | View open patches by repository |
-Misc
-----
+## Misc
| Jira | Command | Description |
| ---- | ------- | ----------- |
| [x](https://gerrit.opencord.org/plugins/gitiles/voltha-lib-go/+/refs/heads/master/VERSION) | gerrit.sh --view repo voltha-lib-go | View repository VERSION file |
-See Also
---------
+# See Also
- [Gerrit: Searching Changes](https://gerrit-review.googlesource.com/Documentation/user-search.html)
diff --git a/jenkins/README.md b/jenkins/README.md
new file mode 100644
index 0000000..fbf9966
--- /dev/null
+++ b/jenkins/README.md
@@ -0,0 +1,29 @@
+# Jenkins Queries
+
+WIP
+This scirpt will load jenkins URLs based on command line arguments.
+
+```bash
+% git clone ssh://gerrit.opencord.org/onf-scripts
+
+# Checkout git submodules
+% make -C onf-scripts
+
+% cd onf-scripts/jenkins/bin
+% jenkins.sh –help
+```
+
+### Command Line args
+
+| Switches | Description |
+| -------- | ----------- |
+| --help | Display command help |
+| --server opencord | View opencord desktop |
+| --computer | View jenkins UI node screen |
+
+```bash
+% jenkins.sh --help
+% jenkins.sh --server opencord
+```
+
+# See Also
diff --git a/jira/README.md b/jira/README.md
index 39abf41..05cbd08 100644
--- a/jira/README.md
+++ b/jira/README.md
@@ -4,8 +4,11 @@
```bash
% git clone ssh://gerrit.opencord.org/onf-scripts
-% cd onf-scripts/jira/bin
+# Checkout git submodules
+% make -C onf-scripts
+
+% cd onf-scripts/jira/bin
% ./jira-search.sh –help
```
@@ -15,7 +18,7 @@
% jira-search.sh --server opencord --unresolved ({search-by-flags})
```
-##### Search Switches
+### Search Switches
| Jira | Switches | Description |
| ---- | -------- | ----------- |
@@ -34,3 +37,4 @@
| ./jira-search.sh --usage-resolved | Display use cases for resolved based searches |
| ./jira-search.sh --help-user | Display assigned, requested-by or 'my' jira tickets' |
+# See Also