Creating the First Space

A space must exist before pages can be added to a Docvora documentation site. Spaces provide the main structure for documentation and contain the pages related to a particular product, topic or purpose.

Creating a space

A new space can be created from the staff panel.

The space editor contains a title field and the standard Docvora content editor. The title is used as the name of the space, while the editor can be used to add content for the space itself.

When the space is ready to be created, the Save Space dialog contains the remaining space settings.

The space title and URL identifier are required before the space can be saved.

Basic space settings

The Save Space dialog contains settings for the URL, page organisation, access and appearance.

URL identifier

The URL identifier controls the space portion of the documentation URL.

Docvora automatically generates this from the space title when the space is created. Characters that cannot be used in the URL are replaced with hyphens.

For example, a space titled:

Getting Started

will generate:

getting-started

The generated identifier can be changed before saving when a different URL is preferred.

Page sorting order

The page sorting order controls how pages within the space are arranged.

The required sorting method can be selected when creating the space and changed later if the page order needs to be adjusted. Sorting orders include:

• Name ascending

• Name descending

• Creation date ascending

• Create date descending

Group access

Group access can be used to restrict a space to selected groups.

When groups have been created, they are displayed as selectable options within the space settings.

A space without group restrictions can be accessed normally according to its other visibility settings.

Visibility

A space can be set as hidden.

Hidden spaces do not appear within the normal documentation site navigation and can only be accessed through a direct link.

Icon

An icon can be uploaded for the space.

Space icons are displayed at 100 x 100 pixels and can help distinguish spaces when they are shown on the documentation site home page.

Adding the first page

After the first space has been created the first page can be created.

See Creating the First Page to learn how to make a page.