Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/cagov/wordpress-integration-api

Using the WordPress API, deploys posts to a target GitHub location; specifically the covid19.ca.gov website.
https://github.com/cagov/wordpress-integration-api

Last synced: 11 days ago
JSON representation

Using the WordPress API, deploys posts to a target GitHub location; specifically the covid19.ca.gov website.

Host: GitHub
URL: https://github.com/cagov/wordpress-integration-api
Owner: cagov
Created: 2020-03-16T18:23:07.000Z (almost 5 years ago)
Default Branch: master
Last Pushed: 2023-07-18T21:38:47.000Z (over 1 year ago)
Last Synced: 2024-11-20T17:47:27.116Z (2 months ago)
Language: JavaScript
Homepage:
Size: 11 MB
Stars: 0
Watchers: 11
Forks: 3
Open Issues: 4
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

# Wordpress content integration service for Covid19.ca.gov
Using the WordPress API, deploys posts to a target GitHub location and facilitates translations; specifically for the [covid19.ca.gov](https://covid19.ca.gov) website.

See below for an outline of the [Translation Pipeline](#translation-pipline-for-covid19cagov).

## Features
- Pushes post content updates to a GitHub repository (Add/Update/Delete)
- Submits posts with the `translate` tag to the AvantPage endpoint for human translation
- Temporary execution log
- Slack error reporting

## _NOT_ included
- WordPress image support
- Support for pages or any other non-post content

## Usage

The service can be run directly by pressing a form button on its running function site, or as the target of a POST request.

## Local development

The project expects the Azure Functions SDK to be installed in order to run locally.

TODO: It would be great to have the project configured to run without the SDK and just use the VSCode debugger.

## Target GitHub location
- https://github.com/cagov/covid19/tree/master/pages/wordpress-posts

## Running production service
- https://fa-cdt-covid19-d-001.azurewebsites.net/WordPressService

## Source GitHub repo
- https://github.com/cagov/wordpress-integration-api

# Translation pipeline for covid19.ca.gov

The California COVID-19 website supports multiple translated languages. To allow for this, a translation pipeline will be created that ensures continuous human translation as English language updates are made.

## Actors
- **ODI** - Office of Digital Innovation
- **AT** - Avantpage Translations

## Assumptions
- Notifications between services will not be authenticating.
- Content will be downloaded (GET) by services, rather than pushed to them.
- Content delivered to ODI will not be reviewed by ODI; it will be deployed to ODI production/staging environments immediately.

## Process
1. ODI content writers will author English versions in WordPress.
1. WordPress will send a POST to the `wordpress-integration-api` service when a post content change occures. The content of the POST is ignored.
1. The `wordpress-integration-api` service will scan WordPress for post updates and sync content updates to GitHub.
1. The `wordpress-integration-api` will send a post payload to AT for any post updates that are tagged as `translate`. See [POST payload from ODI to AT](#post-payload-from-odi-to-at) for details.
1. AT will GET full page content directly from GitHub.
1. AT will perform translation work.
1. AT will create a GitHub pull request containing updated translation content.
- The pull request will be labeled `Translated Content`
1. ODI will approve appropriately tagged pull requests via [CovidTranslationPrApproval](https://github.com/cagov/Cron/tree/master/CovidTranslationPrApproval), but only when they:
- Have passed all their check runs
- Only contain content within the _pages/translated-posts_ folder
- Do not contain invalid characters
1. GitHub will build and publish with updated translations.

### POST payload from ODI to AT
When `wordpress-integration-api` notifies AT that changes have occurred, the following JSON payload should be used.

#### Sample JSON payload
```JSON
{
"posts":
[
{
"id": 36,
"slug": "education",
"modified": "2020-04-27T23:14:07",
"download_path": "/master/pages/wordpress-posts/education.html",
"priority": true //Optional to indicate a priority translation
}
]
,"test": 1 ///Optional to indicate a test request
}

```

## HTML content requirements

Content aquired for translations could be in JSON or HTML format.

When the content is in HTML format, it is possible that the file could have 11ty front matter data. AT is expected to maintain the field names for front matter data when performing translations, as well as class and variable names for HTML content.

### Example English content with front matter
```YAML
---
layout: "page.njk"
title: "Data and tools"
meta: "California has collected a wide range of data to inform its response to COVID-19."
author: "State of California"
publishdate: "2022-03-07T18:15:10Z"
tags: ["translate"]
addtositemap: true
---
```
```HTML

California has collected a wide range of data to inform its response to COVID-19, and developed tools to help process and analyze that data. These are made available to everyone for transparency.

On this page:

```
### Example translated to Simplified Chinese
```YAML
---
layout: "page.njk"
title: "数据及工具"
meta: "加州已经收集了大量数据，为应对COVID-19提供了信息。"
author: "State of California"
publishdate: "2022-03-07T18:15:10Z"
tags: ["translate"]
addtositemap: true
---
```
```HTML

加州已经收集了大量数据，以发布应对COVID-19的信息，并开发了工具以协助处理并分析这些数据。为保证公开透明，所有人都可查看这些数据。

此页面包含的内容：

```