Skip to content

Commit ca0633e

Browse files
authored
Update documentation about using the template with existing projects. (#155)
* Reinforced prerequisites and cleaned up the top section of the page. * Fixed underline.
1 parent 97fb3b0 commit ca0633e

File tree

2 files changed

+33
-19
lines changed

2 files changed

+33
-19
lines changed

docs/source/existing_project.rst

Lines changed: 31 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -8,41 +8,54 @@ previously used our template.
88
If you want to update a project that already uses the template, please see
99
:doc:`Keeping your project up to date <update_project>`.
1010

11-
.. attention ::
11+
Disclaimers
12+
-----------
1213

13-
Every pre-existing project is unique - it's a snowflake - even if the developers followed
14-
accepted guidelines and best practices.
15-
16-
Because of that, we can't we enumerate all the possible sticking points that you may
17-
encounter when attempting to incorporate the LINCC Frameworks Python Project Template
18-
into a pre-existing project.
14+
Every pre-existing project is unique
15+
....................................
1916

20-
.. tip ::
17+
We can't enumerate all the possible sticking points that you may encounter
18+
when attempting to incorporate the LINCC Frameworks Python Project Template
19+
into a pre-existing project.
2120

22-
The newer a pre-existing project is, the easier it will be to incorporate the
23-
LINCC Frameworks Python Project Template.
21+
We're here to help though! We have called out some gotchas below and we want to
22+
hear from you if you encounter problems. Feel free to start a discussion here:
23+
https://github.com/lincc-frameworks/python-project-template/discussions
2424

25-
That being said, we have used this template to bring dormant projects up to date with
26-
modern development standards.
25+
We'll respond there as quickly as possible, and hopefully the results will help
26+
others along too!
27+
28+
Newer projects are easier to upgrade
29+
....................................
30+
31+
The newer a pre-existing project is, the easier it will be to incorporate the
32+
LINCC Frameworks Python Project Template.
33+
34+
That being said, we have successfully used this template to bring dormant
35+
projects up to date with modern development standards.
2736

2837
Before you begin
2938
----------------
3039

40+
Check the prerequisites
41+
.......................
42+
43+
Make sure your system satisfies the :ref:`prerequisites <prerequisites>`. Copier,
44+
the tool that powers our template, requires recent versions of Python and Git.
45+
We have seen a handful of instances, particularly when working on computing
46+
clusters, where users have encountered error messages resulting from older
47+
versions of the dependencies.
48+
3149
Start clean
3250
...........
3351

3452
It's best to start with a clean local repository and a new git branch just for this task.
3553
Copier will not allow the user to merge a template with a git tracked local repository
36-
if there are uncommitted changes.
54+
if there are uncommitted changes or untracked files.
3755

3856
It's not explicitly necessary, but removing ``cache`` and ``build`` directories will
3957
make it easier to see what changes are being made.
4058

41-
Check your environment
42-
......................
43-
44-
Make sure your system satisfies the :doc:`prerequisites <overview>`.
45-
4659
Hydrate a copy of the template into your project
4760
................................................
4861

docs/source/overview.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ The template takes care of the minutia of directory structures, tool configurati
99
Copier is an open source tool that hydrates projects from templates and natively supports updating projects as the original template matures.
1010
It's really neat!
1111

12+
.. _prerequisites:
1213

1314
Prerequisites
1415
-------------------------------------------------------------------------------
@@ -17,7 +18,7 @@ but summarized below.
1718

1819
1. Python > 3.7
1920
2. Git > 2.27
20-
3. Pipx (nice to have, Conda and Pip work too, but can be more difficult to reason about later)
21+
3. Pipx (recommended - pip and conda work too, but require a different work flow)
2122

2223
.. tip::
2324
You check your prerequisite versions as shown below

0 commit comments

Comments
 (0)