FAQ | This is a LIVE service | Changelog

Skip to content
Snippets Groups Projects
Commit c469dd12 authored by Dmitrii Unterov's avatar Dmitrii Unterov
Browse files

feat: add Copier how-tos: changes after another review

parent d8ee4ca1
No related branches found
No related tags found
1 merge request!292feat: add Copier how-tos
Pipeline #490267 passed
......@@ -5,7 +5,7 @@ This section lists some best practice for web applications.
## Django boilerplate
For new applications we have a
[coopier template](https://gitlab.developers.cam.ac.uk/uis/devops/webapp-boilerplate)
[copier template](https://gitlab.developers.cam.ac.uk/uis/devops/webapp-boilerplate)
which can be used to implement new projects.
## REST API First
......
---
title: Create a New Project from Template using Copier CLI
title: Create a new project from a template using the Copier tool
---
# How to create a new project from project template using Copier CLI
# How to create a new project from a project template using the Copier tool
!!! Info
This howto assumes that the Copier tool has been installed as described in
[the howto guide for preparing your system](./prepare-your-system.md).
This how-to guide assumes that the Copier tool has been installed as described in
[the how-to guide for preparing your system](./prepare-your-system.md).
There are two copier-based boilerplate projects:
......@@ -18,8 +18,7 @@ There are two copier-based boilerplate projects:
Details may vary, please check `README.md` of those projects. But in general, process of project
creation is the following:
1. Select tag of the boilerplate you want to create your project from. Tags are available in GitLab
on "Tags" page of each repository:
1. Select the boilerplate git tag you want to create your project from. Tags are available in GitLab
- Available tags for [webapp-boilerplatet](
https://gitlab.developers.cam.ac.uk/uis/devops/webapp-boilerplate/-/tags)
......
---
title: Migrate Existing Cookiecutter Project to Copier
title: Migrate an existing cookiecutter project to Copier
---
# How to migrate an existing project created with Cookiecutter to Copier
# How to migrate an existing project created with cookiecutter to Copier
!!! Info
This howto assumes that the Copier tool has been installed as described in
[the howto guide for preparing your system](./prepare-your-system.md).
This how-to guide assumes that the Copier tool has been installed as described in
[the how-to guide for preparing your system](./prepare-your-system.md).
!!! info
For this operation it is necessary to know answers that were used initially.
......
......@@ -5,8 +5,8 @@ title: Update Projects Created from Boilerplate Templates
# How to update a project created with Copier to the newer version
!!! Info
This howto assumes that the Copier tool has been installed as described in
[the howto guide for preparing your system](./prepare-your-system.md).
This how-to guide assumes that the Copier tool has been installed as described in
[the how-to guide for preparing your system](./prepare-your-system.md).
Over time, the boilerplate is updated and it is might becomes necessary to update the project as
well with new changes. With copier it can be done in few simple steps.
......@@ -16,7 +16,7 @@ well with new changes. With copier it can be done in few simple steps.
2. Create a local branch in the root of your project.
3. Select git tag you want to update your project to.
3. Select the git tag you want to update your project to.
- Available tags for [webapp-boilerplatet](
https://gitlab.developers.cam.ac.uk/uis/devops/webapp-boilerplate/-/tags)
......@@ -42,6 +42,6 @@ well with new changes. With copier it can be done in few simple steps.
templates before applying the diff on top of your project. In some cases, additional
information might be required. In this case please check the CHANGELOG for more information.
6. Review changes with `git diff`, resolve conflicts ,if any. Push to GitLab.
6. Review changes with `git diff`, resolve conflicts, if any. Push to GitLab.
7. Open a new Merge Reguest to the default branch.
......@@ -64,7 +64,7 @@ tools:
If you need to work with the boilerplate projects, you will need to install the `copier` CLI tool.
The [official docummentation](https://copier.readthedocs.io/#installation) recommends to use
[pipx](https://github.com/pypa/pipx).
This is an utility for installing and running Python applications in isolated environments.
Pipx is an utility for installing and running Python applications in isolated environments.
Information for how to install `pipx` for various platforms could be found on the
[project's github](https://github.com/pypa/pipx?tab=readme-ov-file#install-pipx).
Once `pipx` is installed, the `copier` can be installed by running this command:
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment