• wp-cli origin
• changes
• current status
• how we try to keep two project in sync

Explain how we have written tests, how to invoke them and how to add additional tests

Need documentation for setting up MYSQLTuner with EasyEngine v4.

Our docker PHP image has few PHP modules baked in. What a user needs to do for an additional module?

Issues like: https://community.easyengine.io/t/cannot-create-start-proxy-container-please-make-sure-port-80-and-443-are-free-only-2-sites-are-on-server/11818 got reported after EasyEngine v4.0.8 update. Which switched to using global-services with docker-compose generated names post this update.

This issue is very specific on to docker-compose version 1.23.0 and 1.23.1, version 1.23.0 had a naming scheme update: the old scheme project>_<service>_<index> was updated to
<project>_<service>_<index>_<slug>, where <slug> is a randomly-generated
hexadecimal string.

This change is present for people who had installed EasyEngine between 31st October 2018 to 29th November 2018. Which crosses over with the time line of rc and stable release.

On 29th November this change was reverted back in docker-compose version 1.23.2.

A blogpost needs to written stating this issue and manual steps to resolve them need to be give. Due to this no existing sites got affected, only creation of new sites got hampered.

Steps to resolve this issue: (To be provided in blog for users):

1. Update docker-compose to latest version.

sudo curl -L https://github.com/docker/compose/releases/download/1.23.2/docker-compose-`uname -s`-`uname -m` -o /usr/local/bin/docker-compose
sudo chmod +x /usr/local/bin/docker-compose

2. Restart global-services:

cd /opt/easyengine/services && \
docker-compose down && \
docker-compose up -d 

3. Restart sites:

for site in $(ee site list --format=text); do ee site disable $site && ee site enable $site; done

New site creation should start after this.

based on https://github.com/wp-cli/handbook and https://make.wordpress.org/cli/handbook/

Some work already done https://git.rtcamp.com/sagar.nasit/markdown-importer (internal)

Since there are two nginx involved in v4, it isn't clear where should we edit configuration. See - https://community.easyengine.io/t/www-and-non-wwww-not-setup-by-default/11490.

The documentation should specify where a config should be edited in any given scenario.

Need to document why ee shell command would be necessary

https://community.easyengine.io/t/redis-cache-local-redis-cache/11431/

List of admin tools
Dependencies
Usage tips

How a client browser request processed inside EasyEngine. Use Draw.io. Show differences for different site type. For WordPress, show full page cache variation. So total 4 images.

Final docs might look like:

Option - 1

https://easyengine.io/docs/ <= a landing page, manually created using Gutenberg! ❤️🤘
https://easyengine.io/docs/commands/ <= auto-generated based on php docblocks
https://easyengine.io/docs/handbook/ <= auto-generated based on markdown files here
https://easyengine.io/docs/v3/ <= v3 docs will be moved here manually

docs itself will be a CPT in WordPress.

Option - 2

https://easyengine.io/docs/ <= a landing page, manually created using Gutenberg! ❤️🤘
https://easyengine.io/commands/ <= auto-generated based on php docblocks
https://easyengine.io//handbook/ <= auto-generated based on markdown files here

v3 docs will live at a current place for now.

/docs/ will be a normal page
/command/ and /handbook/ will be two CPTs in WordPress.

How to install EasyEngine. Requirement. Troubleshooting for common errors that user may run into.

Covers the number of repos responsible for the EasyEngine v4 project. URL and Purpose purpose of each repo in a tabular format.

Number of docker images managed/maintained by EasyEngine team. URL & purpose of each.

https://github.com/EasyEngine/dockerfiles

Filesystem structure for each site. Config and log locations for different site type.

• Refactor and improve rtBook-2.0 theme code.
• Refactor and improve markdown-importer plugin code.

Following are the most frequently asked questions in EE4 setup and usage and have a need to be documented as soon as possible:

1. How to use wp-cli in EasyEngine sites. (People don't know ee shell. Need to document this and it's importance.)
2. How to modify and update php ini.
3. How to update nginx configuration.

List of support channels
What debug info a user should submit? On lines of https://github.com/EasyEngine/easyengine/blob/develop-v4/.github/CONTRIBUTING.md

How developers can create custom commands. May include:

• Command structure
• Starter/skeleton package
• installing own commands
• distributing own commands to others
• some notes about site type command
• what if command needs additional docker images

Seems like a good idea - https://community.easyengine.io/t/ee-v4-local-dev/11480

Please check screenshot here https://twitter.com/brianjking/status/1067864888041566208

It appears that markdown parser is not working completely or isn't compatible with Gutenberg editor.

We likely need to fix this on WordPress end.

Documentation for enabling MYSQL Slow Query Log in EasyEngine v4.

From https://community.easyengine.io/t/easyengine-v4-and-whatnot/11397/4

Why is it EEv4 was released for the already aging OSs and not for the newer Ubuntu 18.01LTS/18.10 or for Debian 9?

https://easyengine.io/handbook/contribute/ <new section>
https://easyengine.io/handbook/contribute/improve-platform-support/ <new page>

• how EE manages cron?
• how to add own cron job?
• for a site?
• global cron?

It can be generated on the lines of https://developer.wordpress.org/cli/commands/

• What does mailhog command do?
• What does postfix work?
• Mailhog & postfix together?
• How do I use AWS SES?

We should probably write an article on how to setup CI/CD for WordPress projects. The article may include sample configs for Travis, Gitlab CI and CircleCI.

Global file system structure is missing info about logs and config sub folders in global-filesystem-structure.md#sub-folders.

Hi, I love EE & have been working on tidying up some of the docs here. Am I missing the .md file for this page or should I recreate it and any others I may run into with a new file in my fork? Thank you.

As mysql binlog can over a period of time consume a good amount of dics space there is need for documentation displaying how to disable it. There are also community questions that have started coming up like: https://community.easyengine.io/t/ee4-version-of-how-to-delete-ee3s-var-log-mysql-mariadb-bin-logs/11807 for the same.

One for each:

• command - ee cli cmd-dump
• handbook - https://github.com/EasyEngine/docs/tree/master/handbook

Hierarchical

Covers files and folders created by EasyEngine. Path and purpose of each.

Please document

Relevant topic - https://community.easyengine.io/t/how-to-verify-pages-served-by-cache/11410

@kirtangajjar this should be documented as a separate doc "Migration from V3" in handbook

Refer EasyEngine/easyengine#783

Checklist:

• Migration script for v3 -> v4 - remote/local other options
• Breaking changes - removed features/commands.
• Breaking changes - Command whose syntax is changed
• Similar stuff - commands/features which are carried forward without change
• V3 Roadmap - how we plan to support/discontinue v3

Checklist to update existing docs

• If somebody wants to install ee3, there should be a doc with clear instructions. We can also setup rt.cx/ee3 URL.
• Migration guide from ee3 > ee4
• HHVM deprecation #778
• Syntax change for --key=value #778
• Mail stack support drop (or moved to package). #778
• Remove experimental status #779
• Update README.md in GitHub Project.
• Update EasyEngine Homepage

• #782 Prepare v3 command list and v4 mapping for the same - https://docs.google.com/spreadsheets/d/1ybo3z5dImNFmx1LoqNJ2PjJGh4_s2RH3MCKQj_LyRlQ/edit#gid=0
• For missing parts - invite the community to have a discussion early on
• #783 Add parts that can be automated to the migration script
• Create a migration document with link to scripts and other resources