Manifest File Reference

Describes the format of the manifest file and the kinds of resources it can contain.

File Format

Manifest files are YAML-formatted files. The file can contain multiple resource definitions, with the type of each resource definition specified by the kind property. Separate each resource definition with three dashes.

Resources to create are identified by a kind and a name. Note that if the resource already exists (by a matching name) when the import runs, it will be skipped. This is convenient as it allows the same manifest file to be reimported if new items are added to it.

However, existing resources that do not match anything in the manifest file WILL NOT be deleted. Manifest imports are always non-destructive.

kind: topicPage

Used to generate topic pages from the manifest file.

Property Name	Description
name	The name of the topic page to be created
parentPageName	The name of the topic page's primary parent within the document tree. If omitted, the topic page will be created underneath the users Home page.

Examples:

kind: topicPage
name: OpenSquiggly
---
kind: topicPage
name: Archived Work
parentPageName: OpenSquiggly
---
kind: topicPage
name: Current Work
parentPageName: OpenSquiggly

kind: mountPoint

Property Name	Description
name	The name of the mount point to create
gitType	The type Git hosting system that stores the target repository. `azure-devops` `bitbucket` `github` `gitlab` `generic`
accessType	Specifies the type of access to use for the repository. `public` - Repository is publicly accessible; no credentials required `private` - Repository is private; use credentials provided by the connection specified by `connectionName` `reuse` - Reuse an existing repository
connection	If `connection=self` is specified when accessing a private repository, then the credentials used will be from the same external connection as that of the manifest file mount point. This setting is convenient for connecting to private repositories residing on the same Git account as the manifest mount point without needing to create a store additional external connections. If this property is omitted, then specify the desired external connection in the `connectionName` property.
connectionName	When `accessType=private` and `connection=self` is not specified, enter the name of the external connection that contains the credentials. Note that for security reasons manifest files cannot create external connections. You need to create the external connections needed by the manifest before importing the manifest.
innerMountPointName	When `accessType=reuse`, specify the name of underlying mount point you are reusing.
description	The description for the mount point (optional).
startPath	The startingPath of where to retrieve files within the mounted repository. The default is `/` (i.e., the root).
treeFormatter	The desired tree formatter for the mount point. `raw` - Display raw file and folder names. `doc` - Use the OpenSquiggly document tree formatter to display a processed, formatted view of the documents. See here for more details.
username	The user name or group name of the account on the Git hosting system.
orgName	The organization name on the Git hosting system. Used by Azure DevOps.
projectName	The project name on the Git hosting system. Used by Azure DevOps.
repoName	The repository name.
mappedPageName	To create a mapped page in the document tree corresponding to the mount point, enter the name of the mapped page here. If omitted, a mapped page will not be created for the mount point.
parentPageName	When a mapped page is specified, this property specifies the desired parent page for the new mapped page. If mappedPageName is omitted, this propert is ignored.

Examples:

kind: mountPoint
name: OpenSquiggly Source Code
gitType: azure-devops
accessType: private
connection: self
description: Optional description here
startPath: /
treeFormatter: raw
projectName: OpenSquiggly
repoName: OpenSquiggly
mappedPageName: Full Source
parentPageName: OpenSquiggly
---
kind: mountPoint
name: OpenSquiggly Documentation
accessType: reuse
innerMountPointName: OpenSquiggly Source Code
description: Optional
startPath: /docs
treeFormatter: doc
mappedPageName: Documentation
parentPageName: OpenSquiggly
---
kind: mountPoint
name: OpenSquiggly Deploy
gitType: azure-devops
accessType: private
connection: self
startPath: /
treeFormatter: raw
projectName: OpenSquiggly
repoName: OpenSquigglyDeploy
mappedPageName: Deployment Repo
parentPageName: OpenSquiggly
---
kind: mountPoint
name: OpenSquiggly Web Site Source
gitType: github
accessType: private
connectionName: GitHub OpenSquiggly
startPath: /
treeFormatter: raw
repoName: opensquiggly.com
mappedPageName: Web Site Source
parentPageName: OpenSquiggly
---
kind: mountPoint
name: OpenSquiggly User Docs
accessType: reuse
innerMountPointName: OpenSquiggly Web Site Source
startPath: /Source/opensquiggly.com/input/docs/user-docs
treeFormatter: doc
mappedPageName: User Documentation
parentPageName: OpenSquiggly