Contributing to CNCF.io

Everyone is welcome to contribute to this project. We've created a document that describes guidelines for contributing to the CNCF.io git repository.

CNCF.io Developer Instructions

These instructions are based on you having access to the CNCF.io Pantheon account (and the CNCF.io WordPress database).

Install Local Instance

Requirements

• Install Lando (a Docker Compose utility / abstraction layer). Using Homebrew for installation is not recommended. Lando Docs. Lando includes it's own versions of PHP, Node (14.19.0), NPM.

• When setting up Lando with the Pantheon recipe it will automatically download Terminus (CLI for interaction with Pantheon). Follow all the instructions on that page to setup a machine token and SSH Authentication. Save the machine token for use in step 2 below.

• Get a GitHub personal access token to use in place of a password for performing Git operations over HTTPS.

Lando Setup

(these steps were derived from instructions provided by Pantheon)

1. Clone this repository: git clone git@github.com:cncf/cncf.io.git

• Note that the repo does not contain all of WordPress, 3rd-party themes and plugins. They will be pulled in via composer in step 4.

2. Run lando init and use the following values when prompted:

• From where should we get your app's codebase? > current working directory
• What recipe do you want to use? > pantheon
• Enter a Pantheon machine token > [enter the Pantheon token you got above]
• Which site? > cncfci

If you happen to get an error that looks like this ERROR ==> Need to give this composition a project name! then first run lando init --source pantheon. The command will fail since you already have a git repo. By running it, however, it will remember your auth for Pantheon so you won't have to enter your machine token again and the initial lando init should now work.

3. Open the .lando.yml file and add the following to the file.

keys:
  - pantheon_rsa
proxy:
  node:
    - bs.cncfci.lndo.site:3000
excludes:
  - vendor
  - /app/web/wp-content/themes/cncf-twenty-two/node_modules
services:
  node:
    type: 'node:14'
    ssl: true
    scanner: false
tooling:
  npm:
    service: node
  npx:
    service: node
  node:
    service: node
  phpcs:
    service: appserver
    description: Run PHPCS commands
    cmd: "/app/vendor/bin/phpcs"
  phpcbf:
    service: appserver
    description: Run PHPCBF commands
    cmd: "/app/vendor/bin/phpcbf"
  sniff:
    service: appserver
    cmd: /app/vendor/bin/phpcs -ns
  fix:
    service: appserver
    cmd: /app/vendor/bin/phpcbf -s
  warnings:
    service: appserver
    cmd: /app/vendor/bin/phpcs -s
  debug:
    service: appserver
    cmd: 'touch /app/web/wp-content/debug.log && tail -f /app/web/wp-content/debug.log'
    description: 'Get real-time WP debug log output'
  paths:
    service: appserver
    cmd: "/app/vendor/bin/phpcs -i"
    description: "See sniff paths"

4. Run lando start and note the local site URL provided at the end of the process.

5. Run lando composer install --no-ansi --no-interaction --optimize-autoloader --no-progress to download dependencies

6. Run lando pull --code=none --files=none and follow the prompts to download the media files and database from Pantheon:

• Pull database from? > dev

7. run this script to activate a dev plugin used to load media files from the production server instead of hosting them locally, in addition to other dev plugins, and deactivates some production plugins:

lando wp plugin activate debug-bar && lando wp plugin activate query-monitor && lando wp plugin deactivate shortpixel-image-optimiser && lando wp plugin deactivate pantheon-advanced-page-cache && lando wp plugin activate load-media-from-production

8. You will need to compile the theme css/js before the site will render correctly:

   1. Go to the theme directory: cd web/wp-content/themes/cncf-twenty-two
   2. Install the Node.js dependencies: lando npm install
   3. Compile the files: lando npm run build

9. Visit the local site URL saved from above. To find it again run lando info.

10. In the admin you will need to edit the Search & Filter settings. The full url to the result pages are hardcoded in the "Display Results" of each filter. These will need to be set to the correpsonding local instance url.

11. Get your browser to trust the Lando SSL certificate by following these instructions. This step isn't essential but will stop you having to keep bypassing the privacy warning in your browser.

Notes

• You can stop Lando with lando stop and start it again with lando start. You can turn it off completely with lando poweroff

• Composer, Terminus, npm and wp-cli commands should be run in Lando rather than on the host machine. This is done by prefixing the desired command with lando. For example, after a change to composer.json, run lando composer update rather than composer update.

• Repeat steps 6 and 7 above to download a fresh copy of the database.

---

Theme Development

To activate Browsersync to watch files, run lando npm start in the theme directory. You will then be able to browse the bs.* url listed previously and see the site auto-update whenever there is a change in the underlying source code.

---

Code Sniffs

The CircleCI process will sniff the code to make sure it complies with WordPress coding standards. All Linux Foundation code should comply with these guidelines.

phpcs and the WordPress Coding Standards for PHP_CodeSniffer come as part of the repo and are installed in the vendor directory by composer.

To run recommended tests:

lando sniff

to include warnings which may give hints to improve code:

lando warnings

To run recommended tests and fix issues automatically:

lando fix

To access phpcs or phpcbf on the command line to run your own commands, you can access them via Lando, for instance:

lando phpcs -i

---

Upgrading WordPress core, themes and plugins

The dependencies of this project are managed by Composer. All dependencies of the project are set in composer.json and are pulled in at deploy time according to what is set in composer.lock.

composer.lock is generated from composer.json only when explicitly calling the lando composer update function. Any additional themes or plugins can be added first to composer.json and then lando composer update is run to update composer.lock and pull in the new files. Dependencies are pegged to a version according to the composer versioning rules.

It's good practice to keep WordPress and all plugins set at their latest releases to inherit any security patches and upgraded functionality. Upgrading to a new version, however, sometimes has unintended consequences so it's critical to run all tests before deploying live.