Skip to content

Commit 3582936

Browse files
committed
Update README
1 parent 4e1141c commit 3582936

1 file changed

Lines changed: 4 additions & 4 deletions

File tree

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,26 +22,26 @@ The User Experience Practices Knowledge Graph
2222
<br />
2323

2424
## Overview
25-
[UX Methods](https://www.uxmethods.org/) is a content-first Jamstack website built with [Sanity](https://www.sanity.io/) and [Gatsby](https://www.gatsbyjs.com/), and coordinated with a lightweight knowledge graph running on [Data.world](https://data.world/). Its goal is to document and interconnect the practices and techniques of user experience design, and to provide a use case from which to explore the possibilities of ["boutique" knowledge graphs](https://www.linkedin.com/pulse/uxmethodsorg-boutique-knowledge-graph-case-study-andy-fitzgerald/?trackingId=FsKbRBiJS9SiKWq3uiBDug%3D%3D).
25+
[UX Methods](https://www.uxmethods.org/) is a content-first Jamstack website built with [Sanity](https://www.sanity.io/) and [11ty](https://www.11ty.dev/), and coordinated with a lightweight knowledge graph running on [Data.world](https://data.world/). Its goal is to document and interconnect the practices and techniques of user experience design, and to provide a use case from which to explore the possibilities of ["boutique" knowledge graphs](https://www.linkedin.com/pulse/uxmethodsorg-boutique-knowledge-graph-case-study-andy-fitzgerald/?trackingId=FsKbRBiJS9SiKWq3uiBDug%3D%3D).
2626

2727
This repository is a monorepo of three interrelated but distinct pieces: content management, web application, and continuous integration, which includes knowledge graph production and integration.
2828
<br />
2929

3030
## Content Management
31-
UX Methods is built and maintained with as a content first resource. This means that content is structured to communicate meaning based on user and organization needs, not around the web requirements of particular "pages." UX Methods uses the fully decoupled headless CMS Sanity to structure, produce, and distribute content. This functionality is located in the [**studio**](https://github.com/andybywire/ux-methods/tree/main/studio) folder of this repository.
31+
UX Methods is built and maintained as a content-first resource. This means that content is structured to communicate meaning based on user and organization needs, not around the web requirements of particular "pages." UX Methods uses the fully decoupled headless CMS Sanity to structure, produce, and distribute content. This functionality is located in the [**studio**](https://github.com/andybywire/ux-methods/tree/main/studio) folder of this repository.
3232

3333
<h3 align="center">
3434
<img width="500" src="https://user-images.githubusercontent.com/3710835/146045406-6413d563-bf66-4b2c-b40a-f40b9e19b759.png" alt="Screenshot of UXMethods.org website on desktop and mobile">
3535
</h3>
3636
<br />
3737

3838
## Progressive Web App
39-
UX Methods uses the React based Gatsby statice site generator to publish content as a progressive web app (PWA). Gatsby is also used to publish content as Linked Data (JSON-LD) in parallel with HTML pages in order to support content findability, interoperability, and reuse. PWA code is located in the [**web**](https://github.com/andybywire/ux-methods/tree/main/web) folder.
39+
UX Methods uses the 11ty static site generator to publish content as a progressive web app (PWA). 11ty is also used to publish content as Linked Data (JSON-LD) in parallel with HTML pages in order to support content findability, interoperability, and reuse. PWA code is located in the [**web**](https://github.com/andybywire/ux-methods/tree/main/web) folder.
4040

4141
<h3 align="center">
4242
<img width="500" src="https://user-images.githubusercontent.com/3710835/145917429-72a8347a-84ab-4c39-9b12-9c101f30b41d.png" alt="Screenshot of UXMethods.org website on desktop and mobile">
4343
</h3>
4444
<br />
4545

4646
## Knowledge Graph Integration and Continuous Integration Workflows
47-
GitHub Actions workflows are used to [build and publish updates](https://github.com/andybywire/ux-methods/tree/main/.github/workflows) to the UX Methods PWA when content is added or updated. A custom [RDF-TRansform GitHub Action](https://github.com/andybywire/ux-methods/tree/main/actions/rdf-transform) and workflow are also used to transform content data from the Sanity headless CMS content API into RDF triples, then upload those triples to the [UX Methods dataset on Data.world](https://data.world/andyfitzgerald/ux-methods). This dataset is queried during the PWA build workflow and used to coordinate the related content recommendations and prioritization.
47+
GitHub Actions workflows are used to [build and publish updates](https://github.com/andybywire/ux-methods/tree/main/.github/workflows) to the UX Methods PWA when content is added or updated. A custom [RDF-Transform GitHub Action](https://github.com/andybywire/ux-methods/tree/main/actions/rdf-transform) and workflow are also used to transform content data from the Sanity headless CMS content API into RDF triples, then upload those triples to the [UX Methods dataset on Data.world](https://data.world/andyfitzgerald/ux-methods). This dataset is queried during the PWA build workflow and used to coordinate the related content recommendations and prioritization.

0 commit comments

Comments
 (0)