Azure Repos Integration

Abstract

You can upload content directly from Paligo to Azure. Set up the Paligo to Azure integration so that Paligo can connect to Azure, and then you can publish.

paligo-to-azure-repos.jpg

Paligo has Continuous Integration (CI) support for Microsoft® Azure Repos®. This means you can create content in Paligo, such as PDFs or an HTML help center, and publish it to Azure Repos. The content is uploaded to your choice of Azure repo as a zipped file.

Note

The Paligo to Azure upload has a limit of approximately 20MB.

Before you can publish from Paligo to Azure Repos, you need:

  • An Azure Repos account

  • Basic Azure Repose knowledge and skills, including how to create a project, repository, and personal access token

  • A project in Azure Repos

  • A repository in Azure Repos. The repository must be inside a project. Paligo will upload the zip file for the published output to this repository.

To set up Paligo to publish to Azure Repos:

This will allow Paligo to publish your output as a zip file to your chosen repository.

To set up Paligo to connect to Azure Repos, you need to have:

  • An Azure Repos account.

  • A project that contains a repository. When you publish, Paligo will send the zipped output to the repository.

  • The following details from your Azure Repos account: Organization, Username, Personal Access Token. You can create a Personal Access Token in the User Settings in Azure Repos.

When you have the necessary details and a project and repository set up, you can connect Paligo to Azure Repos:

  1. Log in to Paligo via a user account that has administrator permissions.

  2. Select your profile name in the upper right corner to display a menu, and then select Settings.

  3. In the Settings view, select the Integrations tab.

  4. Find the Azure Repos settings and select Add.

    Note

    Add is only available the first time you set up an integration. After that, Add is replaced by Change.

    Paligo displays the Azure Repos integration settings:

    azure_repos_settings.jpg
  5. Enter the Organization. Typically, this is your username but without the email address part, for example, if your username is jsmith@gmail.com, the Organization is likely to be jsmith.

  6. Enter the Username for the Azure Repos account. Paligo will use this to log in to Azure Repos. It is important that the account has write permissions for the repository (these are set for the account in Azure Repos).

  7. Enter the Personal Access Token. You can create the Personal Access Token in Azure Repos.

  8. Select the button at the end of the Project field. Paligo connects to Azure Repos and detects the projects that you have available. Select the project that contains the repository that you want Paligo to publish to.

    project-browse-button.jpg
  9. Select the Repository that you want Paligo to publish to.

  10. Choose the Branch that Paligo will upload content to. Paligo detects what branches are available and you can choose the branch from the dropdown list.

    The branch field in the integration settings. The branch button on the right of the field is highlighted.

    Paligo does not automatically update the integration settings page while it is open. This means that if you have the integration settings page open, and some new branches are added in Azure Repos, those new branches will not appear in the Branch field. But if you select the branch button, Paligo will update the settings page with the latest branch information.

  11. In the Destination folder field, enter the directory path for the folder that you want Paligo to upload the zip file to. This folder is inside the Azure Repos repository.

    For example:

    Folder 1/Folder 2/

    To upload the zip file directly to the root of the repository, leave the Destination field empty.

  12. Select Save.

  13. Select the Change button for the Azure Repos integration.

  14. Select Test Settings to run a connection test. If the settings are correct, Paligo will show a green success notification.

    If the connection test fails, Paligo shows a red failure notification. Check each connection setting carefully, to make sure you have not made any mistakes and try again. If the connection test continues to fail, contact Paligo support for assistance.

When the connection is made, you can publish content from Paligo to an Azure Repos repository.

You can publish content from Paligo to Azure Repos, and the process is very similar to "regular" publishing. You create your publication and topics, and set up a layout for the type of output you want, such as PDF, HTML5, etc. Then you choose the publication settings and Paligo creates a zip file that contains your output content. The zip file is downloaded in your browser and it is also uploaded to your chosen Azure Repos repository.

To publish from Paligo to Azure Repos, use the Upload to Azure Repose option in the publishing settings. This option is only available if the Paligo Azure Repos integration settings are in place. You will also need to set up a publication and layout to create the output you want, for example, an HTML5 help center. With these in place, you can publish from Paligo to Azure Repos.

Note

The Paligo to Azure upload has a limit of approximately 20MB.

  1. In Paligo, select the options menu ( ... ) for the publication that you want to publish, and then select Publish.

    Publish document dialog showing settings for different output types, languages, profiling attributes, variables, and upload output.
  2. On the Publish document dialog, select the type of output you want, for example, HTML5.

  3. Choose the layout that you want to use for publishing. The settings in the layout are applied when Paligo generates the output.

  4. Choose the Languages to publish to. If you do not have any translations, you can only select the original/source language.

  5. If you have set filters (Profiling attributes) on topics or elements, and/or have used variables, choose which values to use for the publication. See Filters (Profiling) and Variables to learn how to use these features.

  6. In the Upload output section, check the Upload to Azure Repos box. By default, Paligo will upload the output to the repository and folder that are specified in the Paligo to Azure Repos integration settings.

    Upload output settings. The Upload to Azure Repos checkbox is available for selection.

    You can publish to a different branch and/or folder if required. Select the Edit icon next to Upload to Azure Repos, and then select the branch and/or folder on the Edit dialog.

    Azure Repos dialog for publishing lets you choose a branch and destination folder.

    The settings you choose will only be used for this individual publishing process. Any future publishing will revert back to using the branch and folder that are defined in the integration settings.

  7. Select Publish document.

    Paligo generates the output, applying the settings from the layout and the Publication document dialog in the process. When the output is created, it is downloaded in your browser as a zip file. The zip file is also uploaded to your chosen repository branch and folder in Azure Repos.