Update Settings

---

You can use the wiki settings to manage automated project updates, configure branch enablement and delete your projects.

You can only modify the settings for projects that you have admin role permissions on. Wikis that you don’t have permissions to modify settings for will not show the settings icon.

Manage Automatic Updates

Automatic updates will trigger pipelines at your preferred time and frequency, ensuring your wiki always stays updated.

1. First, find the wiki you want to change the update settings for in the Library. Click on the settings menu button in the top right hand corner of the wiki card.

If your wiki card's setting button is greyed out, you do not have the correct access permissions to modify the settings.

2. Click on the Schedule button.

3. This will open the update settings modal.

4. Toggle on Automatic Updates for continuous wiki updates. You will see a toast confirmation confirming the change in settings and a helpful alert when the next wiki will be built.

When first enabling automatic updates, a default daily update setting at 3AM will be applied. You can change the default update settings for each project as required.

5. To disable automatic updates, simply toggle off Automatic Updates. You will see a toast notification confirming the settings change.

Manage Update Schedule

To manage the update frequency settings, a project must first have automatic updates enabled.

1. Settings are initially configured to the default frequency of daily updates at 3AM.

2. You can decrease the frequency of updates by selecting the Weekly or Biweekly options in Sync Frequency.

3. To configure the time at which updates happen, select an hourly interval in Execution Time from the dropdown menu.

4. For Weekly and Biweekly updates, you can also select the day on which updates will happen. Simply select an appropriate day from the Execution Day dropdown.

5. Once you have configured the update settings as required, you can close the settings modal. Settings are saved automatically and confirmed through successful toast notifications as you edit the settings.

Manage Target Branches

By default, only the main branch of a project is enabled for documentation.

1. To add a branch for documentation, select the desired branch from the dropdown menu of Target Branches.

2. The selected branch(es) will now appear listed under Target Branches and you will see successful notification as you enable branches.

3. To remove a branch, click the X on the branch name you want to remove.

4. The branch will be removed and will not receive updates in the wiki.

You can remove the default branch for documentation, however at least one branch must be enabled at all times. To disable documentation for all branches, simply disable updates to the project.

Delete Wiki

To disconnect a project with Komment, use the Installation guide. If you would like to delete a project and its associated wikis permanently, use the delete function in the wiki settings.

1. Click the Delete Permanently button at the bottom of the settings of the project you want to delete.

Caution! Deleting a project and its associated wiki entries is a destructive action that cannot be undone. Your wikis cannot be recovered if you choose to delete them.

2. You will be asked to confirm whether you want to proceed and permanently delete the project and its wikis. Click OK to continue.

3. After deletion, you will no longer be able to see the project in your wiki cards or access any wiki entries for the project. Collaborators will also lose access to the wiki.