Configuring your portal with GitHub - Cloud

Talend Cloud API Designer User Guide
Version
Cloud
Language
English
Product
Talend Cloud
Module
Talend API Designer
Content
Design and Development > Designing APIs
Last publication date
2024-03-13
Talend Cloud API Designer allows you to automatically configure a GitHub repository and populate it with your API Portal configuration and your API documentation. If you want to use a different source control provider, see Configuring your portal with another Git provider.

Procedure

  1. Open Talend Cloud API Designer and go to the API Portal tab.
  2. Click Configure the API Portal.
  3. Connect your GitHub repository:
    • If you have not yet linked a GitHub account to Talend Cloud API Designer, click Link your GitHub account and authorize Talend to access your repositories.
    • If your account is already linked, click Select a GitHub repository.
    API Portal configuration page.
  4. Select the repository to use:
    • To create a new repository, select Create a new GitHub repository, select the owner and enter a name.
    • To use an existing repository, select Use an existing GitHub repository and select the owner, the repository and the branch to use.
    Select a GitHub repository dialog box.
  5. Optional: Click the Enable GitHub Pages button and grant the GitHub workflow permission if you want to automatically publish your portal to GitHub Pages.
    This permission is needed to automatically configure GitHub Actions on your repository. You can also enable GitHub Pages later from the API Portal settings or manually from your repository. For more information, see Deploying your portal with GitHub Pages.
    Note: This will overwrite any existing GitHub Pages configuration on your repository.
  6. Click Select API Documentation to publish.
    The API Portal template is committed to the selected repository, on the selected branch if you used an existing repository, or on the main branch if you created a new one. A list of publishable APIs appears.
  7. Click the Publish button next to the API that you want to publish.
    Screenshot of a list of unpublished APIs.

Results

Your API Portal repository is configured and your first API is published. You can now customize and deploy your portal.