Skip to content

Commit 5e8eb61

Browse files
Merge pull request #2 from creativecommons/document-wp-setup
Document WordPress plugins/themes setup, include as Composer dependencies
2 parents ebdc65b + 3e0a2aa commit 5e8eb61

File tree

3 files changed

+171
-20
lines changed

3 files changed

+171
-20
lines changed

README.md

+40-9
Original file line numberDiff line numberDiff line change
@@ -30,19 +30,33 @@ containers:
3030
- [creativecommons/chooser][gh-chooser]
3131
- [creativecommons/faq][gh-faq]
3232
- [creativecommons/mp][gh-mp]
33-
1. Create the `.env` file:
33+
2. Create the `.env` file:
3434
```shell
3535
cp .env.example .env
3636
```
37-
2. Update `.env` to set desired values for variables (`WP_VERSION`,
37+
3. Update `.env` to set desired values for variables (`WP_VERSION`,
3838
`WP_MOD_TYPE`, `WP_MOD_NAME`, etc.)
39-
3. Build/start Docker:
39+
4. Build/start Docker:
4040
```shell
4141
docker compose up
4242
```
43-
4. Wait for build and initialization to complete
44-
5. Install WordPress initially through the GUI.
45-
- **TODO:** Script help here
43+
5. Wait for build and initialization to complete
44+
6. Install WordPress initially through the GUI.
45+
- **TODO:** Script help here
46+
7. Install WordPress plugins/themes managed through Composer:
47+
```shell
48+
composer install
49+
```
50+
8. Activate all installed plugins, excluding `wordfence`
51+
```shell
52+
wp plugin activate --all --exclude=wordfence
53+
```
54+
9. Activate `vocabulary-theme`
55+
```shell
56+
wp theme activate vocabulary-theme
57+
```
58+
10. Optionally: manually activate/configure `wordfence` in the GUI for now.
59+
- **TODO:** Script help here
4660
4761
[gh-cc-legal-tools-data]: https://github.com/creativecommons/cc-legal-tools-data
4862
[gh-chooser]: https://github.com/creativecommons/chooser
@@ -73,10 +87,27 @@ containers:
7387
7488
| Name | Version |
7589
| -------------------------------------------------------- | -------- |
76-
| [Advanced Custom Fields][adv-custom-fields] | `^1.6` |
77-
| [Advanced Custom Fields: Menu Chooser][acf-menu-chooser] | `v1.1.0` |
78-
| [Classic Editor][classic-editor] | `^6.1` |
90+
| [Advanced Custom Fields][adv-custom-fields] | `6.1` |
91+
| [Advanced Custom Fields: Menu Chooser][acf-menu-chooser] | `1.1.0` |
92+
| [Classic Editor][classic-editor] | `1.6` |
93+
| [Redirection][redirection] | `4.8` |
94+
| [Tablepress][tablepress] | `1.12` |
95+
| [Wordfence][wordfence] | `7.10.3` |
96+
7997
8098
[adv-custom-fields]: https://wordpress.org/plugins/advanced-custom-fields/
8199
[acf-menu-chooser]: https://github.com/reyhoun/acf-menu-chooser
82100
[classic-editor]: https://wordpress.org/plugins/classic-editor/
101+
[redirection]: https://wordpress.org/plugins/redirection/
102+
[tablepress]: https://wordpress.org/plugins/tablepress/
103+
[wordfence]: https://wordpress.org/plugins/wordfence/
104+
105+
106+
## Themes
107+
108+
| Name | Version |
109+
| -------------------------------------------------------- | -------- |
110+
| [Vocabulary Theme][vocabulary-theme] | `0.1.0` |
111+
112+
113+
[vocabulary-theme]: https://github.com/creativecommons/vocabulary-theme

config/composer/composer.json

+33-3
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,45 @@
33
{
44
"type":"composer",
55
"url":"https://wpackagist.org"
6+
},
7+
{
8+
"type": "package",
9+
"package": {
10+
"name": "creativecommons/vocabulary-theme",
11+
"version": "0.1",
12+
"type": "wordpress-theme",
13+
"dist": {
14+
"type": "zip",
15+
"url": "https://github.com/creativecommons/vocabulary-theme/archive/refs/tags/v.0.1.0.zip"
16+
}
17+
}
18+
},
19+
{
20+
"type": "package",
21+
"package": {
22+
"name": "reyhoun/acf-menu-chooser",
23+
"version": "1.1",
24+
"type": "wordpress-plugin",
25+
"dist": {
26+
"type": "zip",
27+
"url": "https://github.com/reyhoun/acf-menu-chooser/archive/refs/tags/v1.1.0.zip"
28+
}
29+
}
630
}
731
],
832
"require": {
9-
"wpackagist-plugin/classic-editor": "^1.6",
10-
"wpackagist-plugin/advanced-custom-fields": "^6.1"
33+
"creativecommons/vocabulary-theme": "0.1",
34+
"reyhoun/acf-menu-chooser": "1.1",
35+
"wpackagist-plugin/classic-editor": "1.6",
36+
"wpackagist-plugin/advanced-custom-fields": "6.1",
37+
"wpackagist-plugin/redirection": "4.8",
38+
"wpackagist-plugin/tablepress": "1.12",
39+
"wpackagist-plugin/wordfence": "7.10.3",
40+
"wpackagist-theme/twentytwentythree": "1.1"
1141
},
1242
"config": {
1343
"allow-plugins": {
1444
"composer/installers": true
1545
}
1646
}
17-
}
47+
}

config/composer/composer.lock

+98-8
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)