Skip to main content

Creating a new project from the template

When you finish this procedure, you have your own GitLab project copied from the 3di Docusaurus template, ready for authors to clone and write in.

Fork a new project from the template​

  1. Go to the 3di Docusaurus template repo.
  2. From the top right of the project overview page, select Fork.
  3. Enter the new project name, for example, Map API Documentation.
    Change the project name

    Always change the project name. If the project name is not changed, it creates collisions and may cause publishing issues.

  4. For the Project URL, under the 3di group, select the appropriate customer sub-group.
    If the group for your customer doesn't exist, contact Virtuoso to create the group.
  5. If required, change the project slug (a short name/label) from the default supplied.
    This must be globally unique to the 3di group.
  6. Under Branches to include, select Only the default branch.
  7. Under Visibility level, select Private.
  8. Select Fork project.

Configure the GitLab project settings​

  1. From the left-hand nav, select Settings > General and expand the Visibility, project features, permissions section.
  2. If the new project doesn't require GitLab build automation,disable the following options:
    • CI/CD
    • Container registry
    • Environments features
      info

      If you disable GitLab build automation and CI/CD, your project will not be validated with the automated checks.

  3. Set up the standard branches in GitLab:
    1. From the left-hand nav, select Code > Branches > New branch.
    2. In Branch name, enter integration.
    3. Select Create branch.
    4. If your project has a custom branch naming convention, add more branches as required.

The project repository is now ready for the authoring team to clone and use. You can customise the setup further and adjust the Vale, HTML test, and pipeline setup.

Next steps​

On this page: