Skip to content

Latest commit

 

History

History
79 lines (62 loc) · 6.89 KB

README.md

File metadata and controls

79 lines (62 loc) · 6.89 KB

Embeddable Committee Gallery for LF Project WordPress sites

Many of our LF Projects use the 'Persons' post type to display the list of committee members on the project website. As committee management is done in LFX, keeping the website updated requires manual synchronization to keep it accurate. While committee member changes are usually only a few times a month, we see headshots, titles, and bios change from time to time, and those need to be synced.

This project aims to pull the committee member list and member information and display using the same HTML used on the LF project websites or in other embeds or visuals such as slide decks. Currently, we have three renders supported:

  • oldsite is the HTML layout most LF project websites used from 2021 or earlier.
  • newsite is for LF project websites from 2022 and newer.
  • slidedeck is for including a committee headshot list in a slide deck. (default option)

Additionally, there are five filters available:

  • all - returns all rows.
  • alternates - returns all records with Voting Status = 'Alternative Voting Rep'.
  • staff - returns all records with Role = 'LF Staff'.
  • voting - returns all records with Voting Status = 'Voting Rep'.
  • voting-and-alternates - returns all records with Voting Status = 'Voting Rep' or 'Alternative Voting Rep'.

Issues and pull requests to fix issues or add new renders or filters are always welcome.

Current list of committee and renders

Adding a committee

It's an easy one-step process to add a new committee. Add a pull request to commit to this repo to host the committee HTML code.

Add a new page in the root directory with the extention .md with the contents as below.

---
lfx_committee_url: <url from LFX PCC Committee page - example https://projectadmin.lfx.linuxfoundation.org/project/a0941000002wBykAAE/collaboration/committees/40ab4fff-0c3b-4718-91e4-e76b2805f34c>
render: # optional, defaults to 'slidedeck'
filter: # optional, defaults to 'voting'
---

If you need to add additional contents or CSS for rendering, you can do this after the front matter.

Hosting on the site

For WordPress, you can remove the Persons block in the page editor and replace it with a 'Raw HTML' block with the contents as below:

<div w3-include-html="https://jmertic.github.io/committee-gallery/FILENAME.html"></div>
<script src="https://jmertic.github.io/committee-gallery/embed.js"></script>

FILENAME matches the filename of the file created, substituing .md with .html.