Add meta descriptions and social preview image to site

aehrc · Feb 7, 2024 · 615d27d · 615d27d
1 parent 9cfba9d
commit 615d27d
Show file tree

Hide file tree

Showing 28 changed files with 44 additions and 1 deletion.
diff --git a/site/docs/index.md b/site/docs/index.md
@@ -1,3 +1,7 @@
+---
+description: Pathling is a set of tools that make it easier to use FHIR and clinical terminology within health data analytics.
+---
+
 # Overview
 
 Pathling is a set of tools that make it easier to

diff --git a/site/docs/libraries/encoders/index.md b/site/docs/libraries/encoders/index.md
@@ -1,5 +1,6 @@
 ---
 sidebar_position: 2
+description: The Pathling library can be used to transform FHIR Bundles or NDJSON into Spark data sets.
 ---
 
 # FHIR encoders

diff --git a/site/docs/libraries/encoders/schema.md b/site/docs/libraries/encoders/schema.md
@@ -1,3 +1,7 @@
+---
+description: A scheme for representing FHIR resources within a Parquet schema.
+---
+
 # Parquet specification
 
 This specification describes a scheme for representing FHIR resources within a 

diff --git a/site/docs/libraries/fhirpath-query.md b/site/docs/libraries/fhirpath-query.md
@@ -1,5 +1,6 @@
 ---
 sidebar_position: 3
+description: The Pathling library can be used to query datasets of FHIR resources using FHIRPath. This is useful for aggregating data, and creating custom views.
 ---
 
 # FHIRPath query

diff --git a/site/docs/libraries/index.md b/site/docs/libraries/index.md
@@ -1,6 +1,7 @@
 ---
 sidebar_position: 1
 sidebar_label: Introduction
+description: Pathling provides a set of libraries that provide assistance with using FHIR and terminology services from Apache Spark applications and data science workflows.
 ---
 
 # Libraries

diff --git a/site/docs/libraries/installation/databricks.md b/site/docs/libraries/installation/databricks.md
@@ -1,5 +1,6 @@
 ---
 sidebar_position: 3
+description: Instructions for installing the Pathling library on a Databricks cluster.
 ---
 
 # Databricks installation

diff --git a/site/docs/libraries/installation/index.md b/site/docs/libraries/installation/index.md
@@ -2,6 +2,7 @@
 sidebar_position: 1
 title: Installation
 sidebar_label: Installation
+description: Instructions for installing the Pathling libraries for Python, R, Scala, and Java.
 ---
 
 ### Python

diff --git a/site/docs/libraries/installation/spark.md b/site/docs/libraries/installation/spark.md
@@ -1,5 +1,6 @@
 ---
 sidebar_position: 4
+description: Instructions for configuring Apache Spark to use the Pathling library.
 ---
 
 # Spark configuration

diff --git a/site/docs/libraries/installation/windows.md b/site/docs/libraries/installation/windows.md
@@ -1,5 +1,6 @@
 ---
 sidebar_position: 2
+description: Instructions for installing the Pathling libraries on Windows.
 ---
 
 # Windows installation

diff --git a/site/docs/libraries/javascript/pathling-client.md b/site/docs/libraries/javascript/pathling-client.md
@@ -1,3 +1,7 @@
+---
+description: A client library for the Pathling FHIR API, for use with JavaScript and TypeScript.
+---
+
 # pathling-client
 
 [pathling-client](https://www.npmjs.com/package/pathling-client) is a client

diff --git a/site/docs/libraries/javascript/pathling-import.md b/site/docs/libraries/javascript/pathling-import.md
@@ -1,3 +1,7 @@
+---
+description: A set of functions written in TypeScript that facilitate the export of resources from a FHIR server and import into Pathling, via a staging S3 bucket. They can also be used as AWS Lambda functions.
+---
+
 # pathling-import
 
 [pathling-import](https://www.npmjs.com/package/pathling-import) is a set of

diff --git a/site/docs/libraries/kafka.md b/site/docs/libraries/kafka.md
@@ -1,5 +1,6 @@
 ---
 sidebar_position: 7
+description: Pathling supports Kafka as a streaming data source, and all the operations available within the library are able to execute continuously across a stream of data.
 ---
 
 # Kafka integration

diff --git a/site/docs/libraries/terminology.md b/site/docs/libraries/terminology.md
@@ -1,5 +1,6 @@
 ---
 sidebar_position: 4
+description: The Pathling library provides a set of functions for querying a FHIR terminology server from within your queries and transformations.
 ---
 
 # Terminology functions

diff --git a/site/docs/roadmap.md b/site/docs/roadmap.md
@@ -1,3 +1,7 @@
+---
+description: We are continually adding new features to the various different components of Pathling.
+---
+
 # Roadmap
 
 We are continually adding new features to the various different components of

diff --git a/site/docs/server/async.md b/site/docs/server/async.md
@@ -1,6 +1,7 @@
 ---
 sidebar_position: 7
 sidebar_label: Async
+description: Pathling implements the Asynchronous Request Pattern within the FHIR specification, to provide a way to execute long-running requests and check on their progress using a status endpoint.
 ---
 
 # Asynchronous processing

diff --git a/site/docs/server/authorization.md b/site/docs/server/authorization.md
@@ -1,5 +1,6 @@
 ---
 sidebar_position: 6
+description: Pathling can perform the role of a resource server within the OpenID Connect framework.
 ---
 
 # Authorization

diff --git a/site/docs/server/caching.md b/site/docs/server/caching.md
@@ -1,5 +1,6 @@
 ---
 sidebar_position: 8
+description: Pathling implements ETag-based cache validation, which enables clients to skip processing of queries when the underlying data has not changed.
 ---
 
 # Caching

diff --git a/site/docs/server/configuration.md b/site/docs/server/configuration.md
@@ -1,5 +1,6 @@
 ---
 sidebar_position: 5
+description: Configuration options for the Pathling server.
 ---
 
 # Configuration

diff --git a/site/docs/server/getting-started.md b/site/docs/server/getting-started.md
@@ -1,5 +1,6 @@
 ---
 sidebar_position: 2
+description: Instructions for getting started with Pathling server.
 ---
 
 # Getting started

diff --git a/site/docs/server/index.md b/site/docs/server/index.md
@@ -1,6 +1,7 @@
 ---
 sidebar_position: 1
 sidebar_label: Introduction
+description: Pathling provides a server based on the HL7 FHIR standard, implementing special functionality designed to ease the delivery of apps and augment tasks related to health data analytics.
 ---
 
 # Server

diff --git a/site/docs/server/kubernetes.md b/site/docs/server/kubernetes.md
@@ -1,6 +1,7 @@
 ---
 sidebar_position: 10
 sidebar_label: Kubernetes
+description: Instructions for deploying Pathling server on Kubernetes using Helm.
 ---
 
 # Kubernetes

diff --git a/site/docs/server/operations/aggregate.md b/site/docs/server/operations/aggregate.md
@@ -1,5 +1,6 @@
 ---
 sidebar_position: 3
+description: The aggregate operation allows a user to perform aggregate queries on data held within the Pathling FHIR server.
 ---
 
 # Aggregate

diff --git a/site/docs/server/operations/extract.md b/site/docs/server/operations/extract.md
@@ -1,5 +1,6 @@
 ---
 sidebar_position: 4
+description: The extract operation allows a user to create arbitrary tabular extracts from FHIR data, by specifying columns in terms of set of FHIRPath expressions that are used to populate them.
 ---
 
 # Extract

diff --git a/site/docs/server/operations/import.md b/site/docs/server/operations/import.md
@@ -1,5 +1,6 @@
 ---
 sidebar_position: 1
+description: The import operation allows FHIR data to be imported into the server, making it available for query via other operations such as search, aggregate and extract.
 ---
 
 # Import

diff --git a/site/docs/server/operations/search.md b/site/docs/server/operations/search.md
@@ -1,5 +1,6 @@
 ---
 sidebar_position: 2
+description: Pathling server supports a FHIRPath-based search profile that allows you to retrieve a set of FHIR resources from the server filtered by one or more FHIRPath expressions.
 ---
 
 # Search

diff --git a/site/docs/server/operations/update.md b/site/docs/server/operations/update.md
@@ -1,5 +1,6 @@
 ---
 sidebar_position: 5
+description: Pathling implements the update and batch operations from the FHIR REST API, to allow for the creation and update of individual resources within the server.
 ---
 
 # Update and batch

diff --git a/site/docs/server/sync.md b/site/docs/server/sync.md
@@ -1,6 +1,7 @@
 ---
 sidebar_position: 9
 sidebar_label: Synchronization
+description: Synchronize Pathling server with other FHIR servers using subscriptions or bulk data export.
 ---
 
 # Synchronization with other FHIR servers

diff --git a/site/docusaurus.config.js b/site/docusaurus.config.js
@@ -95,7 +95,8 @@ const config = {
         theme: lightCodeTheme,
         darkTheme: darkCodeTheme,
         additionalLanguages: ["java", "scala", "yaml", "docker", "r"]
-      }
+      },
+      image: "/assets/images/social-preview.png",
     })
 };