OpenAMP Project Website

This is the git repository for the OpenAMP project website.

Project Structure

The content of the website is located in the src/content folder of the repo, spread across various folders, referred to as "collections".

├── src/

│   └── content/

│       └── authors/

│       └── data/

│       └── news/

│       └── pages/

│       └── tags/

Pages

Pages can be edited via the relevant .md files in the src/content/pages folder. New pages containing the nav, header, footer and a body of rendered markdown content can be implemented by adding .md files to this folder (as with the cookies, conduct and governance pages). If rendered markdown content is not sufficient, please contact [email protected] to discuss implementing a new page.

News

News items can be added in the src/content/news folder. Please follow the format of the existing items, as the schema is explicitly enforced and the project will fail to build (on purpose) if it is not followed correctly.

Note that the author and tags field must reference items in the respective content collections by filename (without extension).

For example

title: Recording of OpenAMP presentation at ELC North America 2020
author: openamp

openamp here references src/content/authors/openamp.md

Images

Images should be placed in the src/assets folder and referenced by relative paths within content collection .md files. This ensures that the images are optimized at build time, improving website performance.

Data

The src/content/data folder contains various lists of one-off items used in the site, namely the nav links, footer links and members. Any items added to these lists will be reflected in the website.

Developer Info

Running the site locally will require Node.js (>=18) and the yarn package manager.

First, install dependencies with yarn install.

The following commands can then be used to build and run the site locally:

Command	Description
yarn build	Builds the site in the dist folder of the root directory.
yarn dev	Runs the site in a development server, with hot module replacement to reflect updates to the code as soon as they are saved.
yarn preview	Runs the most recent build files in a development server. Unlike yarn dev this won't have live updates, but will be a closer representation of the site as it would be in deployment.

Questions?

If you have any questions about updating or building this website, please contact Linaro IT Support at [email protected].