Skip to content

Commit

Permalink
docs: mi/3143/add-release-link (#3191)
Browse files Browse the repository at this point in the history
* docs: mi/3143/add-release-link

- Added link to Rafiki releases page from Docker Compose guide
- Added Releases page under Resources menu

* docs: mi/3143/add-release-link

- Reinstalled pnpm due to errors on last build
- Made updates to linked texts

* docs: mi/3143/add-release-link

- Fixed broken link on releases page

* docs: mi/3143/add-release-link

- Removed references to curly brackets in Docker Compose guide.
  • Loading branch information
hajjimo authored Dec 19, 2024
1 parent 4a4fbd0 commit 52ff03b
Show file tree
Hide file tree
Showing 3 changed files with 33 additions and 4 deletions.
4 changes: 4 additions & 0 deletions packages/documentation/astro.config.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -221,6 +221,10 @@ export default defineConfig({
label: 'Resources',
collapsed: true,
items: [
{
label: 'Releases',
link: '/resources/releases'
},
{
label: 'Glossary',
link: '/resources/glossary'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -96,14 +96,14 @@ The example domain and subdomain values are for demonstration purposes only. You
Update the variables in the following compose file with values relevant to your environment and system. Refer to the [environment variables page](/resources/environment-variables/) for details.

:::note[Update compose file]
You must change the values enclosed within curly brackets {} in the following compose file.
You must change the values enclosed within the brackets of the following compose file. Substitute `newest-version` with the latest Rafiki <LinkOut href='https://github.com/interledger/rafiki/releases'>version</LinkOut>.
:::

```sh
name: 'my-rafiki'
services:
rafiki-auth:
image: ghcr.io/interledger/rafiki-auth:v1.0.0-alpha.<newest-version>
image: ghcr.io/interledger/rafiki-auth:<newest-version>
container_name: rafiki-auth
environment:
AUTH_DATABASE_URL: {postgresql://...}
Expand All @@ -129,7 +129,7 @@ services:
restart: always

rafiki-backend:
image: ghcr.io/interledger/rafiki-backend:v1.0.0-alpha.<newest-version>
image: ghcr.io/interledger/rafiki-backend:<newest-version>
container_name: rafiki-backend
depends_on:
- postgres
Expand Down Expand Up @@ -166,7 +166,7 @@ services:
- ../temp/:/workspace/temp/

rafiki-frontend:
image: ghcr.io/interledger/rafiki-frontend:v1.0.0-alpha.<newest-version>
image: ghcr.io/interledger/rafiki-frontend:<newest-version>
container_name: rafiki-frontend
depends_on:
- rafiki-backend
Expand Down
25 changes: 25 additions & 0 deletions packages/documentation/src/content/docs/resources/releases.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
title: Releases
---

import { LinkOut } from '@interledger/docs-design-system'

## Release notes

Refer to the Rafiki releases <LinkOut href='https://github.com/interledger/rafiki/releases'>page</LinkOut> for the latest release notes.

## Rafiki packages

The latest source for each of the three Rafiki [services](/resources/architecture) can be accessed below.

- <LinkOut href='https://github.com/interledger/rafiki/tree/main/packages/backend'>
Backend
</LinkOut>
- <LinkOut href='https://github.com/interledger/rafiki/tree/main/packages/auth'>
Auth
</LinkOut>
- <LinkOut href='https://github.com/interledger/rafiki/tree/main/packages/frontend'>
Frontend
</LinkOut>

Alternatively, if you want to run the latest Rafiki version using Docker Compose, then refer to this [guide](/integration/deployment/docker-compose).

0 comments on commit 52ff03b

Please sign in to comment.