Website for the RFC Editor

Design

• The new www.rfc-editor.org design on Figma. As development continues this is the graphic design that we will be adhering to where possible.

Contributing

This code repository is under the broader guidance from IETF CONTRIBUTING.md.

Development

Prerequisites

• Docker Desktop
• WSL2 (Windows only)

Getting Started

Website

See /website/.

It's a Nuxt website (official Nuxt documentation).

Website content (markdown)

Website content from markdown files can be found in /website/content/.

Markdown Frontmatter (metadata) fields supported are listed in content.config.js.

Website testing

In /website/ run npm run test

Website APIs

The website depends on APIs in the form of:

• Search (via Typesense, managed outside of this repository)
• Precomputed API responses (managed in this repository, in /precomputer/)

Precomputed API responses

See /precomputer/.

We precompute the result of many APIs used by the website and upload them to an S3-like bucket.

This is done for performance reasons (some these APIs can take minutes to compute) and it improves resilience.

The /precomputer/ code is intentionally separate from the website/Nuxt. It has its own package.json etc.

The entry point for the precomputer is precomputer/src with the 3 items single.ts, all.ts, and cron.ts:

• single.ts calculates a single RFC 'info' page API data and RFC-specific APIs such as /rfc/rfcN.json. The all.ts does the same with batches of specific ranges of RFCs. Currently these scripts are run manually from Tekton;
• cron.ts handles everything else (all subseries, RFC indexes that list all RFCs, RSS/Atom feeds, website homepage latest 3 RFCs, etc.). As the name cron.ts implies this script is run periodically (every 6 hours), however you can also run it manually from Rancher.

Precomputer tests

In /precomputer/ run npm run test.

Troubleshooting

During local dev website doesn't update with changes

Stop the dev server, run npm run cleanup, and restart the dev server.