Skip to content
This repository was archived by the owner on Oct 6, 2025. It is now read-only.

Commit 270953b

Browse files
committed
instructions for using template repository were outdated, and commit history was not cleaned with current instructions. Fixed
1 parent 63ccbf0 commit 270953b

3 files changed

Lines changed: 21 additions & 24 deletions

File tree

README.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -442,17 +442,16 @@ and instructions for contributing.
442442

443443
0. (Create [GitHub account](https://github.com/) if you do not have one already.
444444
1. Sign into your GitHub homepage
445-
2. In the top right corner of the homepage, click the '+'-button
446-
3. Select 'Import repository'
447-
4. Under 'Your old repository's clone URL' copy the clone url of this repository: `https://github.com/City-of-Helsinki/ml_project_template`
448-
(**NOTE:** if you are already familiar with using the template, you can install a pre-cleaned version: `https://github.com/City-of-Helsinki/ml_project_template_pre_cleaned`. If you do so, follow these instructions where applicable.)
449-
5. Give your project a name. Do not use the dash symbol '-', but rather the underscore '_', because the name of the repo will become the name of your Python module.
450-
6. If you are creating a project for your organization, change owner of the repo from the drop down bar (it's you by default).
445+
2. Go to page https://github.com/City-of-Helsinki/ml_project_template and click the green button that says 'Use this template'.
446+
(**NOTE:** if you are already familiar with using the template, you can use the pre-cleaned version instead: https://github.com/City-of-Helsinki/ml_project_template_pre_cleaned.
447+
If you do so, follow these instructions where applicable.)
448+
3. Give your project a name. Do not use the dash symbol '-', but rather the underscore '_', because the name of the repo will become the name of your Python module.
449+
4. If you are creating a project for your organization, change owner of the repo from the drop down bar (it's you by default).
451450
You need to be included as a team member to the GitHub of the organization.
452-
7. Define your project publicity (you can change this later, in most cases you'll want to begin with a private repo).
453-
8. Click 'Begin import'
451+
5. Define your project publicity (you can change this later, in most cases you'll want to begin with a private repo).
452+
6. Click 'Create repository from template'
454453

455-
This will create a new repository for you copying everything from this template, including the commit history.
454+
This will create a new repository for you copying everything from this template, but with clean commit history.
456455

457456
### 2. On your computing environment:
458457

docs/index.html

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -433,17 +433,16 @@ <h2 id="Installing-the-Template">Installing the Template<a class="anchor-link" h
433433
<h3 id="1.-On-your-GitHub-homepage:">1. On your GitHub homepage:<a class="anchor-link" href="#1.-On-your-GitHub-homepage:"> </a></h3><ol>
434434
<li>(Create <a href="https://github.com/">GitHub account</a> if you do not have one already. </li>
435435
<li>Sign into your GitHub homepage</li>
436-
<li>In the top right corner of the homepage, click the '+'-button</li>
437-
<li>Select 'Import repository'</li>
438-
<li>Under 'Your old repository's clone URL' copy the clone url of this repository: <code>https://github.com/City-of-Helsinki/ml_project_template</code>
439-
(<strong>NOTE:</strong> if you are already familiar with using the template, you can install a pre-cleaned version: <code>https://github.com/City-of-Helsinki/ml_project_template_pre_cleaned</code>. If you do so, follow these instructions where applicable.)</li>
436+
<li>Go to page <a href="https://github.com/City-of-Helsinki/ml_project_template">https://github.com/City-of-Helsinki/ml_project_template</a> and click the green button that says 'Use this template'.
437+
(<strong>NOTE:</strong> if you are already familiar with using the template, you can use the pre-cleaned version instead: <a href="https://github.com/City-of-Helsinki/ml_project_template_pre_cleaned">https://github.com/City-of-Helsinki/ml_project_template_pre_cleaned</a>.
438+
If you do so, follow these instructions where applicable.)</li>
440439
<li>Give your project a name. Do not use the dash symbol '-', but rather the underscore '_', because the name of the repo will become the name of your Python module.</li>
441440
<li>If you are creating a project for your organization, change owner of the repo from the drop down bar (it's you by default).
442441
You need to be included as a team member to the GitHub of the organization.</li>
443442
<li>Define your project publicity (you can change this later, in most cases you'll want to begin with a private repo).</li>
444-
<li>Click 'Begin import'</li>
443+
<li>Click 'Create repository from template'</li>
445444
</ol>
446-
<p>This will create a new repository for you copying everything from this template, including the commit history.</p>
445+
<p>This will create a new repository for you copying everything from this template, but with clean commit history.</p>
447446
<h3 id="2.-On-your-computing-environment:">2. On your computing environment:<a class="anchor-link" href="#2.-On-your-computing-environment:"> </a></h3><p><strong>Put all the highlited </strong> <code>commands</code> <strong> to shell one ate a time and press enter</strong>
448447
<strong>(replace the parts with square brackets with your own information</strong> <code>'[replace this with your info]'</code><strong>(remove the brackets))</strong></p>
449448
<ol>

index.ipynb

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -527,17 +527,16 @@
527527
"\n",
528528
"0. (Create [GitHub account](https://github.com/) if you do not have one already. \n",
529529
"1. Sign into your GitHub homepage\n",
530-
"2. In the top right corner of the homepage, click the '+'-button\n",
531-
"3. Select 'Import repository'\n",
532-
"4. Under 'Your old repository's clone URL' copy the clone url of this repository: `https://github.com/City-of-Helsinki/ml_project_template` \n",
533-
"(**NOTE:** if you are already familiar with using the template, you can install a pre-cleaned version: `https://github.com/City-of-Helsinki/ml_project_template_pre_cleaned`. If you do so, follow these instructions where applicable.)\n",
534-
"5. Give your project a name. Do not use the dash symbol '-', but rather the underscore '_', because the name of the repo will become the name of your Python module.\n",
535-
"6. If you are creating a project for your organization, change owner of the repo from the drop down bar (it's you by default).\n",
530+
"2. Go to page https://github.com/City-of-Helsinki/ml_project_template and click the green button that says 'Use this template'.\n",
531+
"(**NOTE:** if you are already familiar with using the template, you can use the pre-cleaned version instead: https://github.com/City-of-Helsinki/ml_project_template_pre_cleaned.\n",
532+
"If you do so, follow these instructions where applicable.)\n",
533+
"3. Give your project a name. Do not use the dash symbol '-', but rather the underscore '_', because the name of the repo will become the name of your Python module.\n",
534+
"4. If you are creating a project for your organization, change owner of the repo from the drop down bar (it's you by default).\n",
536535
"You need to be included as a team member to the GitHub of the organization.\n",
537-
"7. Define your project publicity (you can change this later, in most cases you'll want to begin with a private repo).\n",
538-
"8. Click 'Begin import'\n",
536+
"5. Define your project publicity (you can change this later, in most cases you'll want to begin with a private repo).\n",
537+
"6. Click 'Create repository from template'\n",
539538
"\n",
540-
"This will create a new repository for you copying everything from this template, including the commit history.\n",
539+
"This will create a new repository for you copying everything from this template, but with clean commit history.\n",
541540
"\n",
542541
"### 2. On your computing environment:\n",
543542
"\n",

0 commit comments

Comments
 (0)