Skip to content

Commit

Permalink
Update readme and repo urls
Browse files Browse the repository at this point in the history
Signed-off-by: Chris Abraham <[email protected]>
  • Loading branch information
cjyabraham committed May 19, 2024
1 parent a1ff4b1 commit 9882c1f
Show file tree
Hide file tree
Showing 13 changed files with 21 additions and 24 deletions.
3 changes: 0 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,4 @@
[![Build, deploy and test](https://github.com/linuxfoundation/lfevents/actions/workflows/build_deploy_and_test.yml/badge.svg)](https://github.com/linuxfoundation/lfevents/actions/workflows/build_deploy_and_test.yml)
[![Dashboard lfevents](https://img.shields.io/badge/dashboard-lfeventsci-yellow.svg)](https://dashboard.pantheon.io/sites/f74d847c-e689-4631-a91b-24b7f897139b#dev/code)
[![Dev Site lfevents](https://img.shields.io/badge/demo%20site-lfeventsci-lightgrey.svg)](https://dev-lfeventsci.pantheonsite.io/kubecon-cloudnativecon-europe/)
[![Admin Instructions](https://img.shields.io/badge/-admin%20instructions-blue.svg)](https://docs.google.com/document/d/1mvIuw-R9k_gbnZn_iV04qNTjG33u_lXwFlN7s-lgJ1Y/edit?usp=sharing)

## This repository powers these sites
* [LFEvents Main Site](https://events.linuxfoundation.org/)
Expand Down
16 changes: 8 additions & 8 deletions docs/devguide.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# LFEvents Developer Guide

LFEvents uses a Continuous Integration (CI) infrastructure via github, CircleCI and Pantheon. These instructions help you get a local instance up and running and explain how to run the various tests.
LFEvents uses a Continuous Integration (CI) infrastructure via GitHub Actions and Pantheon. These instructions help you get a local instance up and running and explain how to run the various tests.

All these tests are run by CircleCI on each commit to the master branch, whenever a PR is created on a branch, and on each commit to a branch that has a PR open. Such branches will have a multidev env automatically created for them by CircleCI to facilitate showing to stakeholders. Once the PR is merged, the env will be automatically deleted.
Git branches will have a Pantheon multidev env automatically created for them to facilitate testing. Once the PR is merged, the env will be automatically deleted.

For instructions on how to configure [the resulting site](https://events.linuxfoundation.org) to host events, please see the [Admin Instructions](https://docs.google.com/document/d/1mvIuw-R9k_gbnZn_iV04qNTjG33u_lXwFlN7s-lgJ1Y/edit?usp=sharing).

Expand All @@ -21,7 +21,7 @@ For instructions on how to configure [the resulting site](https://events.linuxfo
### Lando Setup
(these steps were derived from [instructions provided by Pantheon](https://github.com/pantheon-systems/example-wordpress-composer#working-locally-with-lando))

1. Clone this repository with HTTPS (not SSH): `git clone https://github.com/LF-Engineering/lfevents.git`
1. Clone this repository with HTTPS (not SSH): `git clone https://github.com/linuxfoundation/lfevents.git`
* Note that the repo does not contain all of WordPress, 3rd-party themes and plugins. They will be pulled in via [composer](https://getcomposer.org/) in step 4.

2. Run `lando init` and use the following values when prompted:
Expand Down Expand Up @@ -113,13 +113,13 @@ lando wp plugin activate debug-bar && lando wp plugin activate query-monitor &&

## Theme Development

LFEvents uses a fork of the [FoundationPress](https://github.com/olefredrik/foundationpress) theme. To optionally use Browsersync, copy `config-default.yml` to `config.yml` (git ignores this file) and change the Browsersync URL (line 4) to `https://lfeventsci.lndo.site/`. Run `lando npm start` to compile CSS and JS to `dist/` (git ignores this directory) as changes are made to the source files. When deployed, `dist/` files are compiled and minified with through the build process on CircleCI.
LFEvents uses a fork of the [FoundationPress](https://github.com/olefredrik/foundationpress) theme. To optionally use Browsersync, copy `config-default.yml` to `config.yml` (git ignores this file) and change the Browsersync URL (line 4) to `https://lfeventsci.lndo.site/`. Run `lando npm start` to compile CSS and JS to `dist/` (git ignores this directory) as changes are made to the source files. When deployed, `dist/` files are compiled and minified by the CI process.

-----

## 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](https://docs.google.com/document/d/1TYqCwG874i6PdJDf5UX9gnCZaarvf121G1GdNH7Vl5k/edit#heading=h.dz20heii56uf).
The CI process will sniff the code to make sure it complies with WordPress coding standards. All Linux Foundation code should comply with [these guidelines](https://docs.google.com/document/d/1TYqCwG874i6PdJDf5UX9gnCZaarvf121G1GdNH7Vl5k/edit#heading=h.dz20heii56uf).

phpcs and the [WordPress Coding Standards for PHP_CodeSniffer](https://github.com/WordPress-Coding-Standards/WordPress-Coding-Standards) come as part of the Lando install and are installed in the vendor directory by composer. phpcs can be run on the command line using `lando phpcs` and phpcbf using `lando phpcbf`. Both commands are setup to use WordPress Coding Standards and to run on the `wp-content/themes/` directory.

Expand All @@ -131,17 +131,17 @@ Since the lfeventsci repo includes phpcs via composer, your text editor should u

## Upgrading WordPress core, themes and plugins

Dependencies of this project are managed by [Composer](https://getcomposer.org/). All dependencies of the project are set in [composer.json](https://github.com/LF-Engineering/lfevents/blob/master/composer.json) and are pulled in at deploy time according to what is set in [composer.lock](https://github.com/LF-Engineering/lfevents/blob/master/composer.lock).
Dependencies of this project are managed by [Composer](https://getcomposer.org/). All dependencies of the project are set in [composer.json](https://github.com/linuxfoundation/lfevents/blob/main/composer.json) and are pulled in at deploy time according to what is set in [composer.lock](https://github.com/linuxfoundation/lfevents/blob/main/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](https://getcomposer.org/doc/articles/versions.md).

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.

To upgrade the version of a dependency, follow these steps:

1. Edit [composer.json](https://github.com/LF-Engineering/lfevents/blob/master/composer.json) to set the new version rule
1. Edit [composer.json](https://github.com/linuxfoundation/lfevents/blob/main/composer.json) to set the new version rule

2. Run `lando composer update [package]` to update [composer.lock](https://github.com/LF-Engineering/lfevents/blob/master/composer.lock) for just that package or run `lando composer update` to upgrade all packages to the latest versions which satisfy the constraints set in composer.json
2. Run `lando composer update [package]` to update [composer.lock](https://github.com/linuxfoundation/lfevents/blob/main/composer.lock) for just that package or run `lando composer update` to upgrade all packages to the latest versions which satisfy the constraints set in composer.json

3. Test the site locally

Expand Down
2 changes: 1 addition & 1 deletion docs/formsguide.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,6 @@ LFEvents runs many forms and most of them submit to the HubSpot platform. The d

We have gone to great lengths to write the LFEvents site to be [as fast as possible](https://events.linuxfoundation.org/2019/11/14/new-website-performance/) and would not want that effort to have gone to waste just because we are using HubSpot forms. So to reduce the impact of the HubSpot form integration, we have delayed the load of the HubSpot js files using [Flying Scripts](https://wordpress.org/plugins/flying-scripts/). To the user, the page now appears to load as fast as before with the HubSpot js files loading a few seconds later. We do this on all pages except for the few pages with [forms above-the-fold](https://events.linuxfoundation.org/about/contact/), in which a longer delay for loading the form would not be appropriate.

We have also added [some preconnect hints](https://github.com/LF-Engineering/lfevents/blob/master/web/wp-content/themes/lfevents/library/lfe-functions.php#L872) to speed up the download of the HubSpot js files.
We have also added [some preconnect hints](https://github.com/linuxfoundation/lfevents/blob/main/web/wp-content/themes/lfevents/library/lfe-functions.php#L872) to speed up the download of the HubSpot js files.

Most HubSpot forms are embedded using the iframe method, however, all newsletter forms are embedded as raw HTML which allows us to fine-tune the styling of them.
2 changes: 1 addition & 1 deletion web/wp-content/mu-plugins/custom/lfevents/lfevents.php
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
*
* @wordpress-plugin
* Plugin Name: LFEvents
* Plugin URI: https://github.com/LF-Engineering/lfevents
* Plugin URI: https://github.com/linuxfoundation/lfevents
* Description: Core functionality for running the LFEvents site.
* Version: 1.0.0
* Author: Chris Abraham
Expand Down
2 changes: 1 addition & 1 deletion web/wp-content/mu-plugins/lfevents.php
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
*
* @wordpress-plugin
* Plugin Name: LFEvents
* Plugin URI: https://github.com/LF-Engineering/lfevents
* Plugin URI: https://github.com/linuxfoundation/lfevents
* Description: Core functionality for running the LFEvents site.
* Version: 1.0.0
* Author: Chris Abraham
Expand Down
2 changes: 1 addition & 1 deletion web/wp-content/plugins/countdown-block/plugin.php
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<?php
/**
* Plugin Name: Countdown Block
* Plugin URI: https://github.com/LF-Engineering/lfevents/tree/master/web/wp-content/plugins/countdown-block
* Plugin URI: https://github.com/linuxfoundation/lfevents/tree/main/web/wp-content/plugins/countdown-block
* Description: Gutenberg block which allows for insertion of a countdown in a page/post.
* Author: fuerzastudio
* Version: 0.1.0
Expand Down
2 changes: 1 addition & 1 deletion web/wp-content/plugins/pricing-block/plugin.php
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<?php
/**
* Plugin Name: Pricing Block
* Plugin URI: https://github.com/LF-Engineering/lfevents/tree/master/web/wp-content/plugins/pricing-block
* Plugin URI: https://github.com/linuxfoundation/lfevents/tree/main/web/wp-content/plugins/pricing-block
* Description: Gutenberg block which inserts a pricing table which dynamically updates "Expired" notices with the date.
* Author: cjyabraham
* Version: 0.1.0
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
<?php
/**
* Plugin Name: Speakers Block
* Description: Gutenberg block which allows for insertion of a Speakers showcase in a page/post. It requires an existing Speakers CPT already setup <a href="https://github.com/LF-Engineering/lfevents/blob/main/web/wp-content/mu-plugins/custom/lfevents/admin/class-lfevents-admin.php#L164">like this</a>.
* Plugin URI: https://github.com/LF-Engineering/lfevents/tree/master/web/wp-content/plugins/speakers-block
* Description: Gutenberg block which allows for insertion of a Speakers showcase in a page/post. It requires an existing Speakers CPT already setup <a href="https://github.com/linuxfoundation/lfevents/blob/main/web/wp-content/mu-plugins/custom/lfevents/admin/class-lfevents-admin.php#L164">like this</a>.
* Plugin URI: https://github.com/linuxfoundation/lfevents/tree/main/web/wp-content/plugins/speakers-block
* Requires at least: 5.8
* Requires PHP: 7.0
* Version: 0.2.0
Expand Down
2 changes: 1 addition & 1 deletion web/wp-content/plugins/speakers-block/package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "block-speakers-block",
"version": "0.2.0",
"description": "Gutenberg block which allows for insertion of a Speakers showcase in a page/post. It requires an existing Speakers CPT already setup <a href=\"https://github.com/LF-Engineering/lfevents/blob/main/web/wp-content/mu-plugins/custom/lfevents/admin/class-lfevents-admin.php#L164\">here</a>.",
"description": "Gutenberg block which allows for insertion of a Speakers showcase in a page/post. It requires an existing Speakers CPT already setup <a href=\"https://github.com/linuxfoundation/lfevents/blob/main/web/wp-content/mu-plugins/custom/lfevents/admin/class-lfevents-admin.php#L164\">here</a>.",
"author": "cjyabraham, James Hunt",
"license": "GPL-2.0-or-later",
"main": "build/index.js",
Expand Down
4 changes: 2 additions & 2 deletions web/wp-content/plugins/sponsors-dynamic-block/plugin.php
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
<?php
/**
* Plugin Name: Sponsors Dynamic Block
* Plugin URI: https://github.com/LF-Engineering/lfevents/tree/master/web/wp-content/plugins/sponsors-dynamic-block
* Description: Gutenberg block which allows for insertion of a Sponsors in a page/post. It requires an existing Sponsors CPT already setup <a href="https://github.com/LF-Engineering/lfevents/blob/master/web/wp-content/mu-plugins/custom/lfevents/admin/class-lfevents-admin.php">here</a>.
* Plugin URI: https://github.com/linuxfoundation/lfevents/tree/main/web/wp-content/plugins/sponsors-dynamic-block
* Description: Gutenberg block which allows for insertion of a Sponsors in a page/post. It requires an existing Sponsors CPT already setup <a href="https://github.com/linuxfoundation/lfevents/blob/master/web/wp-content/mu-plugins/custom/lfevents/admin/class-lfevents-admin.php">here</a>.
* Author: cjyabraham
* Version: 0.1.0
* License: GPL2+
Expand Down
2 changes: 1 addition & 1 deletion web/wp-content/plugins/tab-container-block/plugin.php
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<?php
/**
* Plugin Name: Tab Container Block
* Plugin URI: https://github.com/LF-Engineering/lfevents/tree/master/web/wp-content/plugins/tab-container-block
* Plugin URI: https://github.com/linuxfoundation/lfevents/tree/main/web/wp-content/plugins/tab-container-block
* Description: This is a custom container block that is intended to be used to generate a tabbed interface.
* Author: cjyabraham
* Version: 0.1.0
Expand Down
2 changes: 1 addition & 1 deletion web/wp-content/plugins/text-on-image-block/plugin.php
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<?php
/**
* Plugin Name: Text on Image Gutenberg Block
* Plugin URI: https://github.com/LF-Engineering/lfevents/tree/master/web/wp-content/plugins/text-on-image-block
* Plugin URI: https://github.com/linuxfoundation/lfevents/tree/main/web/wp-content/plugins/text-on-image-block
* Description: This is a custom block that creates a fully responsive text box on top of an image
* Author: cjyabraham
* Version: 0.1.0
Expand Down
2 changes: 1 addition & 1 deletion web/wp-content/themes/lfevents/library/lfe-functions.php
Original file line number Diff line number Diff line change
Expand Up @@ -604,7 +604,7 @@ function my_tsf_get_parent_social_meta_image( $args = null, $size = 'full' ) {
/**
* The WP REST API is cached heavily by Pantheon so we need to explicitly exclude certain calls from the cache.
* Modified from https://pantheon.io/docs/mu-plugin#wp-rest-api-wp-json-endpoints-cache and corrected according to
* this issue https://github.com/LF-Engineering/lfevents/issues/662
* this issue https://github.com/linuxfoundation/lfevents/issues/662
*/
$regex_json_path_patterns = array(
'#^/wp-json/post-meta-controls/v1/?#',
Expand Down

0 comments on commit 9882c1f

Please sign in to comment.