README

RIC Wordpress -plugin

1. Project Description

Wordpress plugin for Responsive Image Cache (RIC) https://github.com/phzfi/ric

1.1. Business Vision

Resize and cache images exactly to the view port to increase performance, in comparison to traditional caches that might provide 3 image sizes, non being optimal, and having the client to resize the image.

1.2. Task Management

1.3. Personas

1.4. Use Cases

1.5. Non-Functional Requirements

PHZ-PERF-1 Load the page in less than 1000ms.

2. Architecture

2.1. Technologies

Dev

TODO

PHZ internal Jenkins

Staging

PHZ.fi staging (internal)

Production

Published on https://packagist.org/packages/phz/ric-wordpress
Used by https://phz.fi and other sites

2.2. Naming, Terms and Key Concepts

Environments and the configs should be named as

dev: docker-compose.yml (i.e. use the default names for dev env), but .env.dev
(ci): use the dev -env on CI
stg: docker-compose.stg.yml, .env.stg
prod: docker-compose.prod.yml, .env.prod

2.3. Coding Convention

Directory structure

doc/ for UML documents
etc/ for nginx, ssh etc configs. Can be cp -pr etc/ /etc to the virtual machine during provisioning and matches the os directory structure
results/ test results
reports/ for e.g. code coverage reports
src/ for source code ** Note! Source code should be placed under a single folder (src) that can be mounted over Docker -volume or Vagrant -shared folder inside the virtual machine so that node_modules or vendor directory are not on the shared folder. See https://wiki.phz.fi/Docker and https://wiki.phz.fi/Vagrant for further details how to circumvent the problems.
tests/ for tests

2.4. Development Guide

Add here examples and hints of good ways how to code the project. Convert the silent knowledge as tacit knowledge here.

See https://en.wikipedia.org/wiki/Knowledge_management

3. Development Environment

Note! PHZ Coding Convention: name this environment as dev. Note! However, please use the default files for dev env, such as docker-compose.yml (instead of docker-compose.dev.yml).

3.1. Prerequisites

3.2. Start the Application

3.3. Access the Application

3.4. Run Tests

3.5. IDE Setup and Debugging

3.6. Version Control

3.7. Databases and Migrations

3.8. Continuous Integration

4. Staging Environment

Note! PHZ Coding Convention: name this environment as stg.

4.1. Access

4.2. Deployment

4.3. Smoke Tests

4.3.1. Automated Test Cases

4.3.2. Manual Test Cases

4.4. Rollback

4.5. Logs

4.6. Monitoring

5. Production Environment

Note! PHZ Coding Convention: name this environment as prod.

5.1. Access

5.2. Deployment

5.3. Smoke Tests

5.3.1. Automated Test Cases

5.3.2. Manual Test Cases

5.4. Rollback

5.5. Logs

5.6. Monitoring

6. Operating Manual

6.1. Scheduled Jobs

6.2. Manual Processes

7. Problems

7.1. Environments

7.2. Coding

7.3. Dependencies

Add here TODO and blockers that you have found related to upgrading to newer versions. List the library/framework/service, version, and then the error message.

phz / ric-wordpress

Maintainers

Details