Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Hyperkid123 authored and karelhala committed Nov 21, 2024
1 parent c881401 commit 50d5ff7
Showing 1 changed file with 7 additions and 11 deletions.
18 changes: 7 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,12 @@ https://developers.redhat.com/api-catalog/

## Project structure

The main package is found on [src](./src) and contains the React application for the site itself.
The main package is found on [src](./src) and contains the Next.js application.

Other packages includes:
- [Common code](./packages/common) shared across other packages. Contains the information about the included APIs.
- [Discovery](./packages/discovery) contains a file descriptor and its supporting schemas to describe the contents
found in API catalog. It includes the list of the APIs, what group they form part of and their metadata.
- [Prerender](./packages/prerender) is a cli tool to pre-render all the API catalog to increase SEO and make it easier to
be read by bots.
- [Sitemap](./packages/sitemap) is a cli tool to create the sitemap.xml of API catalog. The sitemap package is also responsible for generating the [canonical format json file](./public/canonical.json) used by the Search Platform for indexing.
- [transform](./packages/transform) is a cli tool to process the [discovery file](./packages/discovery/Discovery.yml)
and create typescript code that can be loaded by API Catalog, the resulting code is stored in the
Expand Down Expand Up @@ -78,7 +76,7 @@ Use `npm install` to install all the project dependencies.

### Running the frontend

Use `npm run start` to start the frontend application.
Use `npm run dev` to start the frontend application.

### Running the discovery process

Expand All @@ -92,12 +90,6 @@ npm run discovery:build && npm run discovery:start -- --skip-api-fetch

The sitemap can be re-generated by running: `SITEMAP_BASE_URL=https://my-base-url npm run sitemap`.

### Pre-rendering the site

To be more bot-friendly we pre-render the whole site to allow it to be crawled.
You can run trigger a local run by building the site `npm run build` and then running `npm run prerender`. The results of the pre-rendering are written in
[build/pre-rendered](./build/pre-rendered)

## Adding external content

Details from each API is extracted from its openapi file to show in the API catalog. Sometimes this is not enough.
Expand Down Expand Up @@ -125,7 +117,7 @@ This is a list of the support sections, followed by the required file name.

- Getting started: `getting-started.md`

## Releasing to Production
## Releasing to Production (Deprecated)

We use GitLab tags for deployment to Production. Follow these steps:

Expand All @@ -150,6 +142,10 @@ We use GitLab tags for deployment to Production. Follow these steps:

4. **Watch the pipeline:** Monitor the pipeline in GitLab's CI/CD > Pipelines section. If successful, your code is deployed to production.

## Releasing to production (new)

TBD

## SPAship configuration

We require some components that are shared across developers.redhat.com (header and footer). These components needs to be copied (and synchronized from time to time).
Expand Down

0 comments on commit 50d5ff7

Please sign in to comment.