Publish, sync, and collaborate

Use Reunite to edit your project, collaborate with your team through pull requests, connect Git providers, sync remote content, and deploy your documentation.

• Use the editor: Add, edit, or delete files and folders in your project.
• Project interface: Reference the user interface of pages in Reunite's project workspace.
• Webview: Preview each branch directly in the editor.
• Test API functions: Use Replay to send requests to your API functions while you work in the editor.
• Keyboard shortcuts: Work faster in Reunite's editor with keyboard shortcuts.

• Manage pull requests: View the list of all open and closed pull requests in your project.
  • Open pull requests: Merge your development branch with the main branch to update your published project.
  • Review pull requests: Review a pull request from the Pull requests page.

• Previews: See how updates to a branch would look when applied to the production deployment.

• Connect a Git provider: Connect your Redocly project to a Git provider to keep the two in sync.
  • GitHub: Store your project files in a repository on GitHub.
  • GitLab: Store your project files in a remote repository on GitLab.
  • Azure DevOps: Store your project files in a remote repository on Azure DevOps Services.
  • Bitbucket Cloud: Store your project files in a remote repository on Bitbucket Cloud.

• Remote content: Copy content from other file sources into your Redocly project.
  • From GitHub: Connect a repository on GitHub to access and publish its files in Reunite.
  • From GitLab: Connect a remote repository on GitLab to access and publish its files in Reunite.
  • From Azure DevOps: Connect a repository on Azure DevOps Services to access and publish its files in Reunite.
  • From Bitbucket Cloud: Connect a remote repository on Bitbucket Cloud to access and publish its files in Reunite.
  • From CI/CD: Push remote content from an external source using your own CI/CD pipeline.
  • From GitHub Actions: Use a GitHub Action for pushing remote content to your Reunite project.
  • From URL: Include content from an external source available at a URL.
  • Manually sync: Sync remote content manually when auto-sync is disabled.
  • Edit content folder: Edit settings for remote content folders and files after creation.
  • Remote content automation: Understand the verification processes Reunite runs on remote content changes.

• Deploy your project: Control which branches deploy, review deployment history, and enforce API quality gates.
  • Branches and deployments: Control which branches Reunite deploys and how it handles preview deployments.
  • Deployments: View the history of deployments in your project.
  • API linting: Understand the Lint deployment step and how scorecard reports surface API validation results.
  • Configure classic scorecard: Add built-in or custom rulesets to evaluate API description files against your quality standards.
  • Ignore link checker: Publish deployments with broken links by overriding the default link checker behavior.

• Respect Monitoring: Use your Arazzo descriptions with Redocly's Respect command to track your APIs' health and quality.
  • Configure monitoring: Configure Reunite to monitor the performance of your APIs using Arazzo descriptions.
  • Notifications and SLAs: Subscribe to notifications by Arazzo workflow.

• Manage projects: Create, switch between, and manage the settings of your Reunite projects.
• Upgrade product version: Update your project when new versions are released and trigger a new build.
• Set custom domain: Configure a custom domain for your project and optionally serve it from a subdirectory path.
• Use environment variables: Define environment variables to use in redocly.yaml and in Markdown and React pages.

• Configure RBAC - Set up role-based access control for granular project and content access permissions
• Roles and permissions - Understand user roles and permission levels available for project access control and team collaboration