index-dev-env

Local development environment for CreativeCommons.org (project name: index).

Overview

This repository manages the local development environment for CreativeCommons.org (project name: index). It relies on Docker and requires the component repositories.

Code of conduct

CODE_OF_CONDUCT.md:

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. Please report unacceptable behavior to conduct@creativecommons.org per our reporting guidelines.

Contributing

See CONTRIBUTING.md.

Index components

The CreativeCommons.org website (project name: index) is comprised of five components that are split into two categories:

1. Static components

• CC Legal Tools ("licenses")
• Chooser
• FAQ
• Platform Toolkit

2. Dynamic component

• WordPress (Vocabulary Theme)

Static component repositories

Component name	Component repositories
CC Legal Tools	cc-legal-tools-app, cc-legal-tools-data
Chooser	chooser
FAQ	faq
Platform Toolkit	mp

Static component URIs

The following URIs and their children/subpaths mustn't be used by WordPress. They are reserved for the static components:

Path	Component name
/cc-legal-tools	CC Legal Tools
/choose	Chooser
/chooser	Chooser
/faq	FAQ
/licence	CC Legal Tools
/licences	CC Legal Tools
/license	CC Legal Tools
/licenses	CC Legal Tools
/ns	CC Legal Tools
/ns.html	CC Legal Tools
/platform	Platform Toolkit
/rdf	CC Legal Tools
/schema.rdf	CC Legal Tools

These URIs are controlled by Apache2 configurations:

• Dev: config/web-sites-available/000-default.conf
• Prod: sre-salt-prime: states/apache2/files/index.conf
  • (Also see Stage and Prod configuration, below)
• shared: cc-legal-tools-data: config/language-redirects

Dynamic component repository

Component name	Component repository
WordPress	vocabulary-theme

Dynamic component URIs

WordPress is the default handler for URIs. WordPress handles all URIs except the Static component URIs, listed above.

Docker containers

The docker-compose.yml file defines the following containers:

1. index-db - Database server for WordPress
2. index-phpmyadmin - Database administration
   • localhost:8003
3. index-web - Web server (WordPress and static HTML components)
   • localhost:8080

Setup

1. Ensure the following repositories are cloned adjacent to this repository:

   PARENT_DIR
   ├── cc-legal-tools-data
   ├── chooser
   ├── dev-index-env
   ├── faq
   └── mp
   

   • [creativecommons/cc-legal-tools-data][gh-data]
   • [creativecommons/chooser][gh-chooser]
   • [creativecommons/faq][gh-faq]
   • [creativecommons/mp][gh-mp]
2. Create the .env file:

   cp .env.example .env
   

3. Update .env to set desired values for variables (WP_VERSION, WP_MOD_TYPE, WP_MOD_NAME, etc.)
4. Build/start Docker:

   docker compose up
   

5. Wait for build and initialization to complete
6. Setup WordPress:

   ./setup-wordpress.sh
   

7. Optional (CC staff only): import production data
   1. Ensure you have access to the production server and your local machine is properly configured to access it
   2. Pull production data

      ./staff_migrate.sh pull
      

   3. Import production data

      ./staff_migrate.sh import
      

Environment URLs

Path label	Dev link	Stage link	Prod link
Chooser	Dev /choose	Stage /choose	Prod /choose
FAQ	Dev /faq	Stage /faq	Prod /faq
Licenses	Dev /licenses	Stage /licenses	Prod /licenses
Platform Toolkit	Dev /platform/toolkit	Stage /platform/toolkit	Prod /platform/toolkit
Public Domain	Dev /publicdomain	Stage /publicdomain	Prod /publicdomain
WordPress	Dev / (default)	Stage / (default)	Prod / (default)
WordPress Admin	Dev /wp-admin	Stage /wp-admin	Prod /wp-admin

Dev configuration

Apache2

See config/web-sites-available/000-default.conf.

WordPress core

Name	Version
WordPress	6.3.1

Also see .env.example.

WordPress plugins

Name	Version
Advanced Custom Fields	6.2.1
Advanced Custom Fields: Menu Chooser	1.1.0
Classic Editor	1.6.3
Monster Insights Google Analytics	8.19
Redirection	5.3.10
Tablepress	2.1.7
Wordfence	7.10.4
WordPress Importer	0.8.1
Yoast SEO	21.2

Also see config/composer/composer.json.

WordPress themes

Name	Version
[Vocabulary Theme][gh-vocab-theme]	2.9

Also see config/composer/composer.json.

vocabulary-theme QA Checklist

vocabulary-theme release testing QA checklist (click to expand)

1. run setup-wp script (again to make sure WP is current version)
2. be sure to clear/disable caches locally
3. review any new context/template/page
4. review pages:
   • home-page
   • sub-page
   • team-index
   • search-index
   • archive-page
   • blog-index
   • blog-post
   • faq
   • mp
   • licenses list
   • license deed | EN
   • license legal code | EN
   • license deed | AR
   • license legal code | AR

Stage and Prod configuration

The staging server and production server are configured via Salt managed in the creativecommons/sre-salt-prime repository. The list below include the specifics (is non-exhaustive):

• pillars/
  • 3_HST/index/
  • 5_HST__POD/index__stage
• states/
  • apache2/files/index.conf
  • wordpress/files/index-composer.json
  • wordpress/index.sls

Copying

COPYING: All the content within this repository is dedicated to the public domain under the CC0 1.0 Universal (CC0 1.0) Public Domain Dedication.