Publish online

Prev Next

Overview

Publish online lets you publish generated Azure documentation directly to a Document360 knowledge base instead of distributing files through email or shared folders. You register a Document360 project from Document360 project under Settings, then select it as the publish destination when creating or editing a document configuration.

Business value

Publishing straight to a knowledge base removes the manual work of distributing documents through file shares, email, or shared folders. Teams get a centralized, always-current home for generated documentation that their audience can access directly.

Prerequisites

Before adding a Document360 project as a publish destination, make sure the following are in place:

  • A Document360 account with an active project. See Document360's own account creation guide for details.
  • The Project name and an API token for that project, available from Document360 under Settings > Knowledge base portal > API tokens.
  • The API token must have all Request methods selected (GET, POST, PUT, DELETE). A token with partial method access fails validation.
  • The Azure Documenter user's email must be added as a member of the Document360 project. The connection fails even with a valid token if the user isn't a project member.

For a seamless setup, sign up to Document360 using the same email address used for your Turbo360 account.

  • If the Turbo360 and Document360 accounts use different emails, add the Turbo360 account's user as a team member in Document360.
  • If the Turbo360 account uses Active Directory sign-in, add the contact email provided in Turbo360 as a user in Document360.

See Document360's guide on adding team members for details.

Note the correct project name and API token from Document360 carefully.

Confirm the Document360 project's site access visibility is set to Private. See Document360's guide on making a knowledge base private for details.

Required permissions

Role Access
Account owner, Owner, Contributor Full access to Document360 project settings and publish configuration.

How it works

A Document360 project is registered by providing its Project name and API token. Once registered, it appears as an available publish destination when creating or editing a document configuration. Documents published to Document360 are delivered as PDF only.

A registered Document360 project can be edited to update the Project name or API token, or deleted, using the icons shown against it in Settings. A project can only be deleted if it is not currently associated with any document configuration.

Steps

Manage Document360 projects

Use the following steps to add, edit, or delete a Document360 project connection. Navigate to Azure Documenter > Settings > Document360 project to get started.

Add a Document360 project

  1. Click Add in the Document360 project section.
  2. Enter the Project name and API token.
  3. Once validation is successful, click Save to finish.

For further reference, see Document360's guides on creating a project and generating an API token.

Edit a Document360 project

  1. Click the Edit icon next to the project you want to update.
  2. Provide the new Project name and/or API token and save your changes.

Delete a Document360 project

  1. Click the Delete icon next to the project you want to remove.

A Document360 project can only be deleted if it is not currently selected as a publish destination on any document configuration.

Configure publish destination

Use the following steps to set Document360 as the publish destination when creating or editing a document configuration. Navigate to Publish settings in the Configure your document wizard to get started.

  1. Select Publish document to Document360 in the Publish settings section.
  2. Provide the Document360 Project Name and its API Token to associate the project with the document configuration.

Example scenario

A documentation admin adds a Document360 project so that generated Azure environment reports publish directly into the team's knowledge base. When the project's API token is later rotated, the admin edits the connection with the new token. A team that wants their Resource details documents immediately accessible to internal stakeholders without manual distribution creates a private Document360 project, generates an API token, then selects Publish document to Document360 in Publish settings.

Limitations

  • Publishing to Document360 outputs PDF only. Word and Excel formats are not supported for Document360 publish destinations.
  • A Document360 project can only be deleted if it is not associated with any document configuration.
  • If the Document360 project's site access visibility is not set to Private, published content may be more widely accessible than intended.
  • Publishing to Document360 requires an active Document360 account, project, and API token; it cannot be configured without them.

Troubleshooting

  1. Document isn't published to Document360 after configuring Publish settings
    Cause: the Project Name or API Token entered may be incorrect.
    Fix: confirm both values match exactly what's shown in the Document360 project settings.

  2. Document360 project validation fails when adding or editing
    Cause: the API token doesn't have all Request methods (GET, POST, PUT, DELETE) selected.
    Fix: generate a new token in Document360 under Settings > Knowledge base portal > API tokens with all Request methods selected, then re-enter it.

  3. Document360 project connects but publishing fails
    Cause: the Azure Documenter user's email hasn't been added as a member of the Document360 project.
    Fix: add the Azure Documenter user's email as a member within the Document360 project, then retry.

  4. A user added to Turbo360 can't access the connected Document360 project
    Cause: the Turbo360 and Document360 accounts use different email addresses, and the user hasn't been added as a Document360 team member.
    Fix: add the user as a team member in Document360, or use matching email addresses across both accounts.

FAQs

  1. What do I need before I can publish a document online?
    A Document360 account, a project within it, and an API token with all request methods enabled, to connect that project to the document configuration.

  2. Does my Turbo360 and Document360 account need to use the same email?
    It's recommended for a seamless setup, but not required. If the accounts use different emails, add the Turbo360 account's user as a team member in Document360 instead.

  3. Can I edit or delete a Document360 project connection?
    Yes. Use the Edit or Delete icons next to the project in Settings > Document360 project. A project can only be deleted if it isn't currently selected as a publish destination on any document configuration.

Related articles