Skip to content
Last updated
Danger

Training exercise.

We've decided that our customer will be NVIDIA. We have decided that they can make use of:

  • Revel to show public documentation for NVIDIA cloud functions (for AI operations)
  • Reef to document internal API's
  • Redoc to present OpenAPI definitions
  • Reunite to collaborate and allow less technical people to contribute to the documentation pages

To summarize - they should make use of Realm to unify their documentation (not only for OpenAPI but also for some low level API's like CUDA etc.) and Reunite to allow easy collaboration.

Migration walkthrough: migration.md

What made you smile?

  • Code walkthrough seems to be nice feature

What did you find confusing?

  • On redocly.com page we can see list of 5 products. We've decided that our customer should buy Reunite (to be able to collaborate on API documentation), but in Reunite there are 4 products to buy (on billing page).
  • We've downloaded NVIDIA cloud functions openapi spec in json, pasted it into editor. We've tried to format JSON, right click on editor and selecting Format didn't bring any meaningful results (? chars appeared and there were two default formatters).
  • We've received following error on WYSIWYG/preview build:

[error] Unhandled error in plugin. Error in "load-oas" loader: Invalid OpenAPI version: should be a string but got "object" Error: Invalid OpenAPI version: should be a string but got "object"

It didn't give us enough details to figure out how to troubleshoot it. After some time we've figured out that we've added sample-config.yaml file which was sample redocly.yaml for NVIDIA and it was causing errors.

  • After adding code walkthrough, we have observed some button with label that doesn't match code-walkthrough section. That's because first letter is capitalized automatically.
  • It's not possible to add two consecutive empty lines because autocomplete kicks-in
  • On Mac OS clicking on walkthrough steps results in blinking first step: blinks-walkthrough-items.mov
  • Ordering of links with documentation is improper - we should place Create code walkthrough as the first item in sidebar