Project 18

Training exercise.

What made you smile?

It was quite easy to follow the guide
I liked the ability to reference OpenAPI operations using markdoc tags

What did you find confusing?

Templates folder starts with an upper-case while other folders don't
Would be good to note that styled-components, react are available out of the box with realm
openapi-code-sample does not prefill operationId (it is required)
import errors in tsx files
Would be good to have autocomplete for md templates
childs instead of children in guide
in 0.98.2 relative path for logo image does not work (worked in 0.93.0)

theme:
  logo:
    image: ../../../images/logo-light.png
    altText: Showdown
    link: /

Had to change to:

theme:
  logo:
    image: /images/logo-light.png
    altText: Showdown
    link: /

Previewing with @redocly/realm@0.98.2
🌐 Preview URL: server starting...
Starting portal develop mode.
JavaScript compiled
File system scan completed
Deprecated plugin format detected: github-rules
Deprecated plugin format detected: github-rules
Plugin format is deprecated, please use the new plugin format: plugins/github-rules.js
The 'theme' property in redocly.yaml is deprecated. Please move all of the properties from 'theme' to the root of the config.
Your rbac: configuration is missing **: property. In case you do not specify it, portal will treat it as "*": read.
Deprecated plugin format detected: github-rules
Deprecated plugin format detected: github-rules
The 'theme' property in redocly.yaml is deprecated. Please move all of the properties from 'theme' to the root of the config.
The 'theme' property in redocly.yaml is deprecated. Please move all of the properties from 'theme' to the root of the config.
Deprecated plugin format detected: github-rules
Deprecated plugin format detected: github-rules
Processing scorecard...
Deprecated plugin format detected: github-rules
Deprecated plugin format detected: github-rules
Scorecard processed
The 'theme' property in redocly.yaml is deprecated. Please move all of the properties from 'theme' to the root of the config.
Unhandled error in plugin. File not found at /home/child_process/data/repos/org01hwq0t4qhvqkxbwj7gsbqb1jq/prj01hwq0y775q840cbmqxdp92a75/main/catalog/api-showdown/api-hub/images/logo-light.png
FileNotFoundError: File not found at /home/child_process/data/repos/org01hwq0t4qhvqkxbwj7gsbqb1jq/prj01hwq0y775q840cbmqxdp92a75/main/catalog/api-showdown/api-hub/images/logo-light.png
    at I (file:///home/child_process/data/repos/org01hwq0t4qhvqkxbwj7gsbqb1jq/prj01hwq0y775q840cbmqxdp92a75/main/node_modules/@redocly/realm/dist/server/utils/fs.js:1:756)
    at x (file:///home/child_process/data/repos/org01hwq0t4qhvqkxbwj7gsbqb1jq/prj01hwq0y775q840cbmqxdp92a75/main/node_modules/@redocly/realm/dist/server/plugins/default-theme/resolve-logo.js:1:426)
    at async H (file:///home/child_process/data/repos/org01hwq0t4qhvqkxbwj7gsbqb1jq/prj01hwq0y775q840cbmqxdp92a75/main/node_modules/@redocly/realm/dist/server/plugins/default-theme/resolve-products-config.js:1:1371)
    at async Object.afterRoutesCreated (file:///home/child_process/data/repos/org01hwq0t4qhvqkxbwj7gsbqb1jq/prj01hwq0y775q840cbmqxdp92a75/main/node_modules/@redocly/realm/dist/server/plugins/default-theme/index.js:1:2135)
    at async Ye (file:///home/child_process/data/repos/org01hwq0t4qhvqkxbwj7gsbqb1jq/prj01hwq0y775q840cbmqxdp92a75/main/node_modules/@redocly/realm/dist/server/plugins/lifecycle.js:1:3393)
    at async M (file:///home/child_process/data/repos/org01hwq0t4qhvqkxbwj7gsbqb1jq/prj01hwq0y775q840cbmqxdp92a75/main/node_modules/@redocly/realm/dist/cli/develop.js:1:968)
    at async file:///home/child_process/data/repos/org01hwq0t4qhvqkxbwj7gsbqb1jq/prj01hwq0y775q840cbmqxdp92a75/main/node_modules/@redocly/realm/dist/bin.js:2:2852
Process failed with code 1 and signal null

But then we got broken links and failed builds:
It was hard to find an error between deprecation warnings

Project 18

What made you smile?

What did you find confusing?

Was this helpful?