Skip to content

Commit 3cd039b

Browse files
authored
📝🎨 Adding Wiki link to top & emoji's to the headers PR (#12)
* 💡 Moved comments on error codes to wiki * 📝 updated pipeline console log after logic checks added * 🔖 marking version 1.0.1 after enhancements The changes were not breaking to anything useing v1.0.0 commands. This update only improves effiency * 📝 added link to wiki page on argument value explination and fixed broken img links * 📝 Changed capital formating for Wiki * 📝🎨 Adding emoji's to the headers of the README file ✏️ Also addressed a missing word at the bottom talking about the kanban board
1 parent 56d8241 commit 3cd039b

File tree

1 file changed

+23
-18
lines changed

1 file changed

+23
-18
lines changed

README.md

Lines changed: 23 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33
**Creator:** Ryan Valizan -- [@devnetkc](https://github.com/devnetkc)
44
**Latest Release:** [v1.0.1](https://github.com/devnetkc/wordpress-ssh-git-ci/releases/tag/v1.0.1)
5+
**Wiki:** [How To Use](https://github.com/devnetkc/wordpress-ssh-git-ci/wiki)
56
**Tags:** git, WordPress, Bash, ci, Azure Azure DevOps, SiteGround, SSH, Azure Pipeline
67
**License:** GPLv3
78
**License URI:** [https://www.gnu.org/licenses/gpl-3.0.en.html](https://www.gnu.org/licenses/gpl-3.0.en.html)
@@ -14,11 +15,13 @@ If there's SSH & Git, you can sync WordPress and Azure DevOps using git.
1415

1516
Let your CI Pipeline manage getting those plugin updates from your unix WordPress server.
1617

17-
#### Live WordPress Branch History
18+
If you like the project, don't forget to click the ⭐up top!
19+
20+
#### 🔴 Live WordPress Branch History
1821

1922
![AzureHistory](https://raw.githubusercontent.com/devnetkc/readme-assets/master/Images/WordPress-commit-history.png)
2023

21-
### How To Use
24+
### 💻 How To Use
2225

2326
````cmd
2427
bash ~/wp-git-sync.sh \
@@ -30,9 +33,9 @@ bash ~/wp-git-sync.sh \
3033
-u $(DevOpsTokenUser)
3134
````
3235

33-
More information on the [arguments](https://github.com/devnetkc/wordpress-ssh-git-ci/wiki/How-To-Use#arguments) is available on the [WIKI](https://github.com/devnetkc/wordpress-ssh-git-ci/wiki) page [__How to Use__](https://github.com/devnetkc/wordpress-ssh-git-ci/wiki/How-To-Use)
36+
More information on the [arguments](https://github.com/devnetkc/wordpress-ssh-git-ci/wiki/How-To-Use#arguments) is available on the [Wiki](https://github.com/devnetkc/wordpress-ssh-git-ci/wiki) page [__How to Use__](https://github.com/devnetkc/wordpress-ssh-git-ci/wiki/How-To-Use)
3437

35-
#### Azure Pipeline
38+
#### 🔧Azure Pipeline
3639

3740
YAML Example:
3841
*note: This example uses Azure Key store variables*
@@ -61,27 +64,27 @@ Console Log:
6164
![WordPress-SSH-Git-CI](https://user-images.githubusercontent.com/26221344/91645717-0eae4d80-ea0d-11ea-81d9-b1e072766767.png)
6265

6366
<!-- markdownlint-disable -->
64-
#### Requirements:
67+
#### 🔲Requirements:
6568
<!-- markdownlint-restore -->
6669

67-
- **Web server have git capability** -- think this is the most important one
68-
- A method to store your secrete variables such as
70+
- [ ] **Web server have git capability** -- think this is the most important one
71+
- [ ] A method to store your secrete variables such as
6972
- username
7073
- password/token
71-
- SSH access to execute scripts on WordPress server
74+
- [ ] SSH access to execute scripts on WordPress server
7275
- *note: `cron` can serve as a slower alternative to SSH*
73-
- Some kind of CI pipeline or `cron` job to hook into after a branch update event triggers an agent to run the script remotely
76+
- [ ] Some kind of ci pipeline or `cron` job to hook into after a branch update event triggers an agent to run the script remotely
7477

7578
<!-- markdownlint-disable -->
76-
#### What it has:
79+
#### 🚘What it has:
7780
<!-- markdownlint-restore -->
7881

7982
- Parameter options for dynamic use
8083
- Separated functions
8184
- Is executed through an ssh call to your WordPress web server
8285

8386
<!-- markdownlint-disable -->
84-
#### What it does is:
87+
#### 🚗 What it does is:
8588
<!-- markdownlint-restore -->
8689

8790
- Check a git repo on a WordPress web server for changes
@@ -96,25 +99,25 @@ Console Log:
9699

97100
Essentially, it allows WordPress developers to be more hands off with their shared hosting WordPress server backends, while still fully benefitting from any of the many source control repository and project board sites for git — but while using WordPress at the same time.
98101

99-
## Contributing
102+
## 📈 Contributing
100103

101104
Contrabutions are welcome!
102105

103-
### Getting Started
106+
### 📚 Getting Started
104107

105-
#### [Kanban Roadmap Board](https://github.com/devnetkc/wordpress-ssh-git-ci/projects/1)
108+
#### 📌 [Kanban Roadmap Board](https://github.com/devnetkc/wordpress-ssh-git-ci/projects/1)
106109

107110
This is a simple script project to automate a painful manual process I dealt with every day at the office. This gets a WordPress git repository on a unix server and Azure DevOps to play nice with one another.
108111

109112
If you see some adjustments to make, by all means suggest them. This needs some clean up and refactoring yet.
110113

111114
New issues or requests will be tracked on the [kanban board](https://github.com/devnetkc/wordpress-ssh-git-ci/projects/1) for the project.
112115

113-
#### Emoji's in commits
116+
#### :bowtie: Emoji's in commits
114117

115118
Emoji guide can be found here on the [gimoji project site](https://gitmoji.carloscuesta.me/). Choose an emoji from the list provided above that fitst the fix or change you are submitting
116119

117-
#### Submitting a pull request
120+
#### :twisted_rightwards_arrows: Submitting a pull request
118121

119122
1) Fork the repository [wordpress-ssh-git-ci](https://github.com/devnetkc/wordpress-ssh-git-ci)
120123
2) Create a new branch off of [master](https://github.com/devnetkc/wordpress-ssh-git-ci/tree/master)
@@ -126,8 +129,10 @@ Emoji guide can be found here on the [gimoji project site](https://gitmoji.carlo
126129

127130
It is also recommended to keep your pull request down to one specific issue or feature at a time.
128131

129-
## WIKI & FAQ
132+
## ❓ Wiki & FAQ
130133

131-
A [WIKI](https://github.com/devnetkc/wordpress-ssh-git-ci/wiki/) is available for the project and is moderatly managed.
134+
A [Wiki](https://github.com/devnetkc/wordpress-ssh-git-ci/wiki/) is available for the project and is moderatly managed.
132135

133136
[FAQ information](https://github.com/devnetkc/wordpress-ssh-git-ci/wiki/FAQ) can be found [here](https://github.com/devnetkc/wordpress-ssh-git-ci/wiki/FAQ).
137+
138+
The [Kanban Roadmap Board](https://github.com/devnetkc/wordpress-ssh-git-ci/projects/1) is also available to track progress or see tasks in querie to be worked on.

0 commit comments

Comments
 (0)