Skip to content
Last updated
Danger

Training exercise.

Brief recommendation for boss

Is the CICD viable for this purpose?

It's very useful since we don't need to share our whole repository content. We can share just part of it and have full control over files we share with Redocly. We would only like to see an option to manually approve PR in Reunite when remote content changes. We are worried about situations when someone merged bad changes to main branch on our remote repository. In such case follow-up PR's won't be merged into Reunite project (because PR build fails).

How would credentials be transmitted to the contractor?

We would use some 3rd party tool to share credentials (Bitwarden, or some temporary share links).

Is that secure?

We don't know. API Keys screen is giving very basic information about what API Key can do. We would love to see some more information there. Maybe we should consider having some 'granular' keys, where users can explicitly enable/disable specific permissions (read/write etc.) similar to Github PAT.

Do you see any potential pitfalls?

Having bigger project with breaking changes (let's say we need to append some partial to all markdown files) may be challenging because remote content pushes directly to main branch. Instead I would like to create feat/breaking-change-migration branch and have possibility to remote content files to be submitted there.

Experience review

What made you smile?

  • Fast deployments
  • It was easy to setup Github CI/CD workflow

What did you find confusing?

  • It wasn't clear at the beginning that we are supposed to NOT install Redocly Github App. Documentation should have more explicit mention of remote content methods - granting access for Redocly with my repository or me pushing my changes on CI/CD to redocly.
  • We were wondering if it's possible to review changes from CI/CD push before PR is getting merged.
  • Link to preview url wasn't working not-working-link-for-preview-from-github-actions.png not-working-link-for-preview-from-github-actions-2.png
  • Unknown name appears in CI/CD instructions: unknown.png
  • Uploaded image to editor file tree and embedded it in md file. WYSIWYG was not rendering it (even though path was correct) and editor didn't preview image when clicking on it. We've had to move image file again to Images folder (even though it was there) and commit to see it working.
  • Merging bad-changes didn't fail Github build: bad-change-merged-github-not-errored.png
  • Editor was slow when using it for longer time on open tab.