WORKFLOWS
The first in serverless docs-like code
Build, maintain, and automatically update your API documentation in the cloud
Hosted on global CDN
Docs-like-code Workflows
- The pot of gold at the end of the rainbow
- The Loch Ness Monster
- The sasquatch
- No operations docs-like-code
These were all unproven myths…until now.
No operations docs-like-code is now a reality with Redocly Workflows.
Features built for developers
Connected to your sources
- Connect your Redocly account to GitHub (or GitHub Enterprise), Azure Repos, Gitlab or Bitbucket.
- Or build your docs based on URL or file uploads.
Previews
Previews are like staging areas, except better – you have unlimited preview environments! This flexibility allows for more nimble workflows with as much safety as a single staging environment. Previews are built automatically upon the creation of any pull requests.
Preview pull requests or branches automatically. Watch for the green checkmark in your favorite source control software and click it to see the preview. Working on public docs? You can still password-protect your previews.
Continuous validation
From correctness with the OAS3 schema to grammar and style checking or corporate governance, we’ve got you covered.
Access control
Your production or previews (or both) can be protected by access controls:
- Basic auth: user/passwords that you configure in our Workflows panel.
- Viewers: using Redocly user-accounts for access controls.
- SSO: enterprise-integrations for single sign-on using your 3rd party Identity Provider (IDP) SAML 2.0 to protect your docs only to users and enjoy a single-sign-on experience.
API registry
Enabling your API definitions as a single source of truth.
Dependencies and usages
Glues your API definitions to other elements of your API lifecycle. Cascades previews and builds of other docs.
- Other API definitions: reference existing APIs and keep them in sync.
- API reference docs: preview changes as you commit.
- API developer portal: preview changes as you commit.
FREQUENTLY ASKED QUESTIONS
Docs-like-code means treating your documentation like you treat your source-code:
- Storage in version-control software (such as git)
- Review/acceptance process
- Deployment to multiple environments such as dev/stage/prod (or what we term as infinite previews and prod)
This allows the docs to share certain benefits that the version-control products have spent years improving. Deploying code is hard, and there are often entire job roles dedicated to that task. Redocly Workflows takes that job (as it relates to the docs) and we do it quite well.
Docs-like-code requires a chain of tools (sometimes complex) to be set up and orchestrated to help you from local development to deployment. The days of complex scripted deployment pipelines are numbered. Redocly has created a service called Workflows to automate the delivery pipeline.
Redocly can connect to private repositories. You can still choose to publish your docs to the public or keep them protected by access control.
Please see our pricing to understand more about our various plans. The number of organization owners and members (our terms for people you collaborate with on your team) who have access is limited based on the plan.
We have integrations with the common version-control software providers, such as GitHub. We subscribe to events so that we know when a change is made to an API definition. That triggers a build, where we gather, validate, build, and deploy (depending on the branch, to prod or a preview environment).
It depends. First, is there a real business case to keep workflows on-premise? Second, right now workflows depend on some AWS-specific services, so it is possible to run in your own AWS-account cloud, but not on your own premise. It is possible to build our reference docs and developer portal on-premise without using workflows. Workflows adds the glue between different projects.
Yes, as long as you are on the professional plan or higher. In order to use a custom domain, you must point your CNAME record to ssl.redoc.ly. You can see our help docs to learn more about how to set up a CNAME record and custom domain.
A preview is the modern equivalent of a staging environment. We name it a preview, because you may have unlimited preview environments (requires the pro plan or higher). Most infrastructure is designed for a single staging environment workflow. The environment is typically used for review or acceptance before deployment to production.
A preview is built automatically (depending on how you configure your settings) upon the creation of a pull request, for example. This flexibility allows for more nimble workflows with as much safety as a single staging environment.