Netlify Integration

Abstract

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

paligo-to-netlify-small.png

Paligo supports direct publishing to Netlify, the web hosting platform. This means you can create HTML5 content in Paligo, such as an HTML5 help center, and publish it directly to Netlify. The integration only supports HTML5 outputs.

Before you can connect Paligo to Netlify, you need a Netlify account with a personal access token (PAT). To learn how to create a personal access key, see the official Netlify documentation.

You also need a Site ID. We explain how to get the Site ID in First-Time Publish To Netlify.

First-Time Publish To Netlify

To connect Paligo to Netlify, you need to have a site set up in Netlify so that you can get the Site ID. If you are publishing to Netlify for the first time, you have three options (in Netlify):

  • Import an existing project from Git

  • Start from a Netlify template

  • Deploy manually

We recommend that you deploy manually to create the site for your Paligo publication. To do this, follow these instructions:

  1. In Paligo, create the publication that you want to publish to Netlify.

  2. Publish it as a regular output, using an appropriate layout. For example, publish it as an HTML5 help center using an HTML5 help center layout. To find out how to publish, see Publishing Process.

    When you publish, you will get a zip file that downloads in your browser.

  3. In Netlify, go to your Sites and choose to Add a new site. Select the deploy manually option and then drag-and-drop your Paligo output zip file into Netlify.

    Netlify will upload and process the zip file and create a new site for you. It is given an automatically generated name, but you can change that in Netlify if needed.

  4. Select the site and view its Site Settings.

    Site panel in Netlify. It has a Site settings button.

    In the Site information, there is a Site ID. Copy the Site ID as you will need it when you set up the Paligo integration.

    Site details in Netlify. There is a Site ID entry that you need to copy so that it can be pasted into Paligo's Netlify integration settings.

Now that you have a site and Site ID, you can set up Paligo to connect to Netlify. When that connection is made, you will be able to publish directly from Paligo to Netlify and will not have to drag-and-drop zip files anymore.

Connect Paligo to Netlify

To connect Paligo to Netlify:

  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.

    Profile image and name is selected to reveal a menu. The Settings option is highlighted.
  3. In the Settings view, select the Integrations tab.

  4. Find the Netlify settings and select Add.

    The Add button is only shown if there are no settings currently in place. If there are settings in place, there is a Change button instead.

    Paligo displays the Netlify integration settings.

    Netlify integration settings in Paligo. There is a Personal Access Token field and a Site ID field.
  5. In Netlify, generate a personal access token (PAT) for your user account and then copy and paste it into the Personal Access Token field in Paligo.

    To learn how to create a personal access key, see the official Netlify documentation.

    Note

    When you create a personal access key, you can only see and copy the key when you first create it. After that, it is unavailable, so when you create it, copy it, and paste into Paligo while you still have the settings open in Netlify.

  6. Enter the Site ID.

    The Site ID defines the location that will receive the content from Paligo. You can find it in Sites > Site overview > Site settings in Netlify.

    Site details in Netlify. There is a Site ID entry that you need to copy so that it can be pasted into Paligo's Netlify integration settings.

    Note

    The Site ID you enter here is used as the default when publishing from Paligo to Netlify. You can choose a different Site ID when you publish, if needed (see Publish Content to Netlify).

  7. Select Save.

  8. Select the Change button for the Netlify integration.

  9. 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 to Netlify.

Publish Content to Netlify

To publish from Paligo directly to Netlify, you need:

With these in place, you can publish your content in Paligo and it will be uploaded to a Netlify site automatically.

  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 an HTML5 output.

  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 Netlify box. By default, Paligo will upload the output to the site that is specified in the Paligo to Netlify integration settings.

    Upload output settings in the publishing settings. The Upload to Netlify box is checked.

    You can publish to a different site if required. Select the Edit icon next to Upload to Netlify, and then enter the Site ID in the Netlify dialog. You can find the Site ID in the site settings in Netlify.

    Netlify dialog for choosing which site to publish to.

    The settings you choose will only be used for this individual publishing process. Any future publishing will revert back to using the site that is 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 uploaded to your chosen site in Netlify.