Merge branch 'main' into feat/wp-cli

Author: TimidRobot

.env

@@ -0,0 +1 @@
+COMPOSE_FILE=./dev/docker-compose.yml

CODE_OF_CONDUCT.md

@@ -1,4 +1,4 @@
-<div align="center">  
+<div align="center">
 <img src="https://mirrors.creativecommons.org/presskit/icons/cc.xlarge.png" height="150">
 
 <h2 align="center">CC WordPress Plugin</h2>
@@ -22,6 +22,20 @@ License](https://creativecommons.org/choose/)) on their WordPress website. This
 includes default, post, page and media attribution.
 
 
+## Code of conduct
+
+[`CODE_OF_CONDUCT.md`][org-coc]:
+> The Creative Commons team is committed to fostering a welcoming community.
+> This project and all other Creative Commons open source projects are governed
+> by our [Code of Conduct][code_of_conduct]. Please report unacceptable
+> behavior to [conduct@creativecommons.org](mailto:conduct@creativecommons.org)
+> per our [reporting guidelines][reporting_guide].
+
+[org-coc]: https://github.com/creativecommons/.github/blob/main/CODE_OF_CONDUCT.md
+[code_of_conduct]: https://opensource.creativecommons.org/community/code-of-conduct/
+[reporting_guide]: https://opensource.creativecommons.org/community/code-of-conduct/enforcement/
+
+
 ## Installation
 
 Download the latest version from this project's [releases][releases]. You can
@@ -107,65 +121,16 @@ At a glance, with WP CC Plugin you can:
   license required (Gutenberg License Blocks)
 
 
-## Contributing
-
-Contributions will be very appreciated. See
-[`CONTRIBUTING.md`](CONTRIBUTING.md).
-
-### Using a localized Docker Setup
-
-A local `docker-compose.yml` file is included in the `./dev/` directory. It includes an Apache webserver, the latest WordPress installation files, and a mySQL db server utilizing MariaDB. We have also included a copy of wp-cli for ease of developement and testing.
-
-It is modelled after the official example, given here by WordPress: https://hub.docker.com/_/wordpress/
-
-To run a local development environment for building and testing contributions you can run the following pattern from the root directory of this repository after cloning it.
-
-`docker compose -f ./dev/docker-compose.yml [command]`
-
-Be sure to substitute `[command]` for a valid docker compose command, such as: 
-
-`docker compose -f ./dev/docker-compose.yml up` to build and start containers
-
-OR
-
-`docker compose -f ./dev/docker-compose.yml down` to stop containers
-
-The first time the build process is run via `docker compose -f ./dev/docker-compose.yml up`, docker will create two directories within your local repository clone:
+## Contributing and development
 
-- `./dev/db` where the database and relevant config will be stored
-- `./dev/wordpress` where the WordPress files will be stored
+**See [`development.md`](development.md).**
 
-It will then mount this plugin's root directory into the `/wp-content/plugins/` directory of the WordPress installation. Edits made to your local plugin clone will reflect within the build.
 
-You can then navigate to `http://localhost:8080/` and proceed with a manual WordPress installation. After the initial installation the WordPress install will persisist between docker sessions. 
-
-If you need to reset the WordPress install to a "clean slate" you can simply delete the `db` and `wordpress` directories respectively, and then run `docker compose -f ./dev/docker-compose.yml up` again to initialize a clean install build. 
-
-#### WP-CLI
-
-To access `wp-cli`, you should have:
-
-- Started the docker container
-- Completed wordpress setup from dashboard
-
-You can run wp-cli commands like this:
-
-```
-docker compose -f ./dev/docker-compose.yml exec wpcli wp core version
-```
-The above command will display the wp core version.
-
-You can also use the container's shell to execute wp-cli commands:
-```
-docker compose -f ./dev/docker-compose.yml exec wpcli bash -i
-```
-
-## Release Schedule
+## License
 
-We will release a new version every month that there are substantial changes.
-See [milestones][milestones] for how GitHub issues are assigned for release.
+- [`license.txt`](license.txt) ([GPLv2 or later][gplv2] License)
 
-[milestones]: https://github.com/creativecommons/wp-plugin-creativecommons/milestones
+[gplv2]: https://opensource.org/licenses/GPL-2.0 "GNU General Public License version 2 | Open Source Initiative"
 
 
 ## History
@@ -191,13 +156,7 @@ Yergler.
 - Tarmo Toikkanen
 
 
-## License
-
-* [`license.txt`](license.txt) ([GPLv2 or later][gplv2] License)
-
-[gplv2]: https://opensource.org/licenses/GPL-2.0 "GNU General Public License version 2 | Open Source Initiative"
-
-## Contributors ✨
+### Contributors ✨
 
 Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
 

README.md

@@ -1,4 +1,4 @@
-# Development and Deployment
+# Deployment
 
 
 ## WordPress.org Plugin Deployment

dev/README.md

@@ -1,17 +1,5 @@
 *.swp
-.DS_Store
-.cc-metadata.yml
-.editorconfig
-.eslintignore
-.eslintrc.json
-.git
-.gitattributes
-.github
-.gitignore
+.*
+dev*
+package*
 README.md
-dev/db
-dev/excludes.txt
-dev/prep_svn_release.sh
-dev/wordpress
-package-lock.json
-package.json

dev/excludes.txt

@@ -1,36 +1,31 @@
-# Contributing to CC WordPress Plugin
+# Contributing and development
 
 Thank you for your interest in contributing to CC WordPress Plugin! This
 document is a set of guidelines to help you contribute to this project.
 
 
-## Code of Conduct
+## Code of conduct
 
-By participating in this project, you are expected to uphold our [Code of
-Conduct][code_of_conduct].
+[`CODE_OF_CONDUCT.md`][org-coc]:
+> The Creative Commons team is committed to fostering a welcoming community.
+> This project and all other Creative Commons open source projects are governed
+> by our [Code of Conduct][code_of_conduct]. Please report unacceptable
+> behavior to [conduct@creativecommons.org](mailto:conduct@creativecommons.org)
+> per our [reporting guidelines][reporting_guide].
 
+[org-coc]: https://github.com/creativecommons/.github/blob/main/CODE_OF_CONDUCT.md
 [code_of_conduct]: https://opensource.creativecommons.org/community/code-of-conduct/
+[reporting_guide]: https://opensource.creativecommons.org/community/code-of-conduct/enforcement/
 
 
-## Project Documentation
+## Contributing
 
-The `README` in the root of the repository should contain or link to project
-documentation. If you cannot find the documentation you're looking for, please
-file a GitHub issue with details of what you'd like to see documented.
+See [`CONTRIBUTING.md`][org-contrib].
 
+[org-contrib]: https://github.com/creativecommons/.github/blob/main/CONTRIBUTING.md
 
-## How to Contribute
 
-Please follow the processes in our general [Contributing Code][contributing]
-guidelines on the Creative Common Open Source website.
-
-[contributing]: https://opensource.creativecommons.org/contributing-code/
-
-
-### Development
-
-
-### WordPress Coding Standards
+## WordPress Coding Standards
 
 Creative Commons plugin for WordPress follows [WordPress Coding
 Standards][standards] and [WordPress Documentation Standards][inline].  Before
@@ -128,14 +123,13 @@ If you are not setup to detect WPCS errors, consider the following steps.
 [phpcs]: https://marketplace.visualstudio.com/items?itemName=ikappas.phpcs
 
 
-### Contributing to Gutenberg Blocks
+## Contributing to Gutenberg Blocks
 
 CC plugin for WordPress uses Gutenberg blocks built by **create-guten-block**
 tool.  If you are interested, you can read its detailed and well-written
 [documentation](https://github.com/ahmadawais/create-guten-block). If you want
 to test/make changes to these blocks, follow the following steps.
 
-
 1. **Setup npm**
 
    First off, make sure you have Node version 8+ and npm 5.3 or more. Clone the
@@ -170,7 +164,7 @@ to test/make changes to these blocks, follow the following steps.
    It optimizes and builds production code for your block inside `dist` folder.
 
 
-### Using @wp-env for our local development environment
+## Using @wp-env for our local development environment
 
 1. **Start the @wp-env envrionment using the command**
 
@@ -193,9 +187,71 @@ to test/make changes to these blocks, follow the following steps.
     ```
 
 
-## Questions or Thoughts?
+## Using a localized Docker setup
+
+A local `docker-compose.yml` file is included in the `./dev/` directory. It
+includes an Apache webserver, the latest WordPress installation files, and a
+mySQL db server utilizing MariaDB. We have also included a copy of `wp-cli` for
+ease of developement and testing.
+
+It is modelled after the official example: [wordpress - Official Image | Docker
+Hub](https://hub.docker.com/_/wordpress/).
+
+To run a local development environment for building and testing contributions
+you can run the following pattern from the root directory of this repository
+after cloning it.
+
+```shell
+docker compose [command]
+```
+
+Be sure to substitute `[command]` for a valid docker compose command, such as
+the following to build and start containers:
+
+```shell
+docker compose up
+```
+
+Or to stop containers:
+
+```shell
+docker compose down
+```
+
+The first time the build process is run via `docker compose -f
+./dev/docker-compose.yml up`, docker will create two directories within your
+local repository clone:
+- `./dev/db` where the database and relevant config will be stored
+- `./dev/wordpress` where the WordPress files will be stored
+
+It will then mount this plugin's root directory into the `/wp-content/plugins/`
+directory of the WordPress installation. Edits made to your local plugin clone
+will reflect within the build.
+
+You can then navigate to `http://localhost:8080/` and proceed with a manual
+WordPress installation. After the initial installation the WordPress install
+will persisist between docker sessions.
+
+If you need to reset the WordPress install to a "clean slate" you can simply
+delete the `db` and `wordpress` directories respectively, and then run `docker
+compose up` again to initialize a clean install
+build.
+
+
+### WP-CLI
+
+To access `wp-cli`, you should have:
 
-Talk to us on [one of our community forums][community].
+- Started the docker container
+- Completed wordpress setup from dashboard
 
-[community]: https://opensource.creativecommons.org/community/
+For example, the following command uses wp-cli to display the version of
+WordPress installed:
+```shell
+docker compose exec wpcli wp core version
+```
 
+You can also use the container's shell to execute wp-cli commands:
+```shell
+docker compose exec wpcli bash -i
+```