Documentation Index

Fetch the complete documentation index at: https://docs.turbo360.com/llms.txt

Use this file to discover all available pages before exploring further.

Managing Document360 projects

  • 3 minute(s) read
Prev Next

Overview

A Document360 project is a publish destination that lets Azure Documenter push generated documentation directly into your Document360 knowledge base instead of only exporting PDFs. You can add, edit, and delete Document360 project connections from the Document360 project section under Settings.

Business value

Publishing directly to Document360 removes the manual step of exporting and re-uploading documents, so your Azure environment documentation stays current in your knowledge base with less operational overhead.

Prerequisites

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

  • You own a Document360 project and have its Project name and API token available.
  • The API token has all Request methods selected (GET, POST, PUT, DELETE) when it's generated in Document360 under Settings > Knowledge base portal > API tokens. A token with only partial method access will fail validation.
  • The email ID of the Azure Documenter user is added as a member of the Document360 project. The connection fails even with a valid token if the user isn't a project member.

Required permissions

Role Access
Account owner, Owner, Contributor Full access to Document360 project — can add, edit, and delete Document360 project connections

How it works

  • A Document360 project is added by providing a Project name and an API token; the connection is validated before it can be saved.
  • Once added, a Document360 project appears as an available publish destination when creating or editing a document configuration.
  • Any added Document360 project can be edited to update its Project name or API token, or deleted, using the icons shown against it.
  • A Document360 project can only be deleted if it isn't currently associated with any document configuration.

Steps

Use the following steps to add, edit, or delete a Document360 project. Start from the Document360 project section under Settings.

Add a Document360 project

Adding a Document360 project makes it available as a publish destination for generated documentation.

  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.

Edit a Document360 project

Editing lets you update the project name or API token of an existing connection without removing and re-adding it.

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

Delete a Document360 project

Deleting a Document360 project permanently removes it from the list of available publish destinations.

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

Example scenario

A documentation administrator 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. After the team consolidates into a different Document360 project, the admin deletes the old connection once it's no longer used as a publish destination on any document configuration.

Limitations

  • A Document360 project can only be deleted if it isn't associated with any configured document.

Troubleshooting

  1. Can't delete a Document360 project
    Cause: The Document360 project is still selected as the publish destination on one or more document configurations.
    Fix: Update those document configurations to use a different publish destination, then delete the Document360 project.

  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 ID 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.

Related articles