Skip to content

Document how to add a new built-in project template

Achilleas Pipinellis requested to merge axil-project-templates-development into master

What does this MR do?

The documentation to create a new built-in project template is very confusing. We started with an issue #22145, then added a script that failed on Linux, and then we moved the instructions to the marketing site https://about.gitlab.com/community/contribute/project-templates/ which doesn't have all the needed steps.

This MR moves the bundle_repo in the scripts directory, so that everything can be run inside GDK. It also refactors the steps to create a new bundle.

How to test

To try the script, download the pages/pelican export and then run the script:

wget -O pelican.tar.gz https://gitlab.com/axil/playground/-/raw/master/pelican-export.tar.gz
scripts/vendor_template https://gitlab.com/pages/pelican pelican "Page/Pelican template"

This should create the vendored template under vendor/project_templates/pelican.tar.gz which is basically what this MR tries to vendor !16934 (merged).

Related issues

Closes #22145

Author's checklist

If you are only adding documentation, do not add any of the following labels:

  • ~"feature"
  • ~"frontend"
  • ~"backend"
  • ~"bug"
  • ~"database"

These labels cause the MR to be added to code verification QA issues.

Review checklist

Documentation-related MRs should be reviewed by a Technical Writer for a non-blocking review, based on Documentation Guidelines and the Style Guide.

  • If the content requires it, ensure the information is reviewed by a subject matter expert.
  • Technical writer review items:
    • Ensure docs metadata is present and up-to-date.
    • Ensure the appropriate labels are added to this MR.
    • If relevant to this MR, ensure content topic type principles are in use, including:
      • The headings should be something you'd do a Google search for. Instead of Default behavior, say something like Default behavior when you close an issue.
      • The headings (other than the page title) should be active. Instead of Configuring GDK, say something like Configure GDK.
      • Any task steps should be written as a numbered list.
      • If the content still needs to be edited for topic types, you can create a follow-up issue with the docs-technical-debt label.
  • Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review.
  • Ensure a release milestone is set.
Edited by Achilleas Pipinellis

Merge request reports