Skip to content

Commit aec9c39

Browse files
docs: add CLI tooling setup section
Stub a section for Hop
1 parent 036e8af commit aec9c39

File tree

1 file changed

+26
-6
lines changed

1 file changed

+26
-6
lines changed

README.md

Lines changed: 26 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -27,27 +27,45 @@ cd ./devop-tools/docker/data-source-services && docker-compose up --build -d
2727
```
2828

2929
#### Specific Setup - Windows
30+
3031
* Kill, and optionally disable, the `World Wide Web Publishing Service`
3132
* Run `set COMPOSE_CONVERT_WINDOWS_PATHS=1` in your CMD or PowerShell terminal
3233
* Optionally, [read](https://github.com/docker/compose/issues/4303#issuecomment-379563170) this bug report.
3334

3435
### Optional: Data Source Tools
36+
3537
* Optionally included is the following tools:
36-
* phpMyAdmin
38+
* phpMyAdmin
3739
* `cd ./devop-tools/docker/data-source-tools && docker-compose up --build -d`
3840

3941
## phpMyAdmin
42+
4043
If the optional tools are launched, you can find phpMyAdmin at: localhost:8080
44+
4145
* It supports the following databases...
42-
* mariadb106 (lts)
43-
* mariadb1011 (lts)
46+
* mariadb106 (lts)
47+
* mariadb1011 (lts)
4448

4549
## Scripts
50+
4651
Inside the `scripts` folder you will find one-off scripts to help with tasks.
4752

4853
* `db_migrate.sh` - Helps migrate databases between versions of mysql.
4954

55+
## CLI Tooling Setup
56+
57+
Add the `bin` directory to your path to use **Hop** and **Git Scripts**.
58+
59+
```shell
60+
ln -s /path/to/DevopsToolKit/bin /usr/local/bin/sidt
61+
```
62+
63+
## Hop
64+
65+
**MISSING DESCRIPTION**
66+
5067
## Git Scripts
68+
5169
Custom scripts that extend Git functionality, to streamline the process of tracking tickets and managing releases
5270

5371
### `git-tickets`
@@ -75,16 +93,17 @@ git tickets [options] [arguments]
7593
```
7694

7795
### `git-make-release`
96+
7897
This command automates the process of preparing a new software release.
7998
It creates a release branch from the current branch, increments the version number, updates the `CHANGELOG.md`
8099

81100
```shell
82101
git make-release [options]
83102
```
84103

85-
| Options | Description | Default |
86-
|----------|-----------------------------------------------------------|---------|
87-
| --dry | Perform a dry run without any changes to branches or tags | N/A |
104+
| Options | Description | Default |
105+
|---------|-----------------------------------------------------------|---------|
106+
| --dry | Perform a dry run without any changes to branches or tags | N/A |
88107

89108
### Make Release Example
90109

@@ -93,6 +112,7 @@ git make-release --dry
93112
```
94113

95114
## Docs
115+
96116
* [Setting up Nginx-Proxy](docs/nginx-proxy/README.md)
97117
* [Setting up PHP Testing in PhpStorm](docs/phpstorm-docker/README.md)
98118
* [Leveraging Yii2 Shell](docs/yii2/yii-shell.md)

0 commit comments

Comments
 (0)