Skip to content

Commit 364ede5

Browse files
committed
use kebab case for transition step variable name
1 parent 2a6d585 commit 364ede5

File tree

5 files changed

+14
-14
lines changed

5 files changed

+14
-14
lines changed

_includes/lesson_footer.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828
{% endif %}
2929
</div>
3030
<div class="col-md-6 help-links" align="right">
31-
{% if site.life_cycle contains 'transition_step' %}
31+
{% if site.life_cycle contains 'transition-step' %}
3232
<a href="{{repo_url}}">Edit on GitHub</a>
3333
{% elsif page.source == "Rmd" %}
3434
<a href="{{repo_url}}/edit/{{ default_branch }}/{{page.path|replace: "_episodes", "_episodes_rmd" | replace: ".md", ".Rmd"}}" data-checker-ignore>Edit on GitHub</a>

_includes/life_cycle.html

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -34,13 +34,13 @@
3434

3535
{% comment %}
3636
Below we cover the 3 phases of lesson transition towards the Carpentries Workbench:
37-
- transition_step_1 (`transition_url` variable needed): we indicate that there
37+
- transition-step-1 (`transition_url` variable needed): we indicate that there
3838
is a new version of the lesson that is available for testing, and that it will be deprecated in the future.
39-
- transition_step_2 (`transition_url` and `transition_date` variables needed): we indicate that a new version of the lesson is avaiable with a deprecation date.
40-
- transition_step_3 (`transition_url` variable needed): the lesson if fully deprecated, and a redirect is set up to the new URL
39+
- transition-step-2 (`transition_url` and `transition_date` variables needed): we indicate that a new version of the lesson is avaiable with a deprecation date.
40+
- transition-step-3 (`transition_url` variable needed): the lesson if fully deprecated, and a redirect is set up to the new URL
4141
{% endcomment %}
4242

43-
{% elsif site.life_cycle == "transition_step_1" %}
43+
{% elsif site.life_cycle == "transition-step-1" %}
4444
{% include check_transition_variables.html need_transition_date = 'false' %}
4545

4646
<div class="alert alert-warning life-cycle">
@@ -49,15 +49,15 @@
4949
This lesson will become deprecated in the near future.
5050
</div>
5151

52-
{% elsif site.life_cycle == "transition_step_2" %}
52+
{% elsif site.life_cycle == "transition-step-2" %}
5353
{% include check_transition_variables.html need_transition_date = 'true' %}
5454

5555
<div class="alert alert-danger life-cycle">
5656
A newer version of this lesson is available from: <a href="{{ site.transition_url }}">{{ site.transition_url }}</a>.
5757
This lesson will become deprecated on {{ site.transition_date }}.
5858
</div>
5959

60-
{% elsif site.life_cycle == "transition_step_3" %}
60+
{% elsif site.life_cycle == "transition-step-3" %}
6161
{% include check_transition_variables.html need_transition_date = 'false' %}
6262

6363
<div class="alert alert-danger life-cycle">

_includes/navbar.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@
9494

9595
{% comment %} Always show license. {% endcomment %}
9696
<li><a href="{{ relative_root_path }}{% link LICENSE.md %}">License</a></li>
97-
{% if site.life_cycle contains 'transition_step' %}
97+
{% if site.life_cycle contains 'transition-step' %}
9898
<li><a href="{{repo_url}}">Improve this page <span class="glyphicon glyphicon-pencil" aria-hidden="true"></span></a></li>
9999
{% elsif page.source == "Rmd" %}
100100
<li><a href="{{repo_url}}/edit/{{ default_branch }}/{{page.path|replace: "_episodes", "_episodes_rmd" | replace: ".md", ".Rmd"}}" data-checker-ignore>Improve this page <span class="glyphicon glyphicon-pencil" aria-hidden="true"></span></a></li>

_layouts/base.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323

2424
{% include favicons.html %}
2525

26-
{% if site.life_cycle == 'transition_step_3' %}
26+
{% if site.life_cycle == 'transition-step-3' %}
2727
<meta http-equiv="refresh" content="0; url={{ site.transition_url }}" />
2828
{% endif %}
2929

bin/boilerplate/_config.yml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,18 +19,18 @@ title: "Lesson Title"
1919
#
2020
# Lessons that are going through the transition to the
2121
# Carpentries Workbench will go through 3 steps:
22-
# 'transition_step_1': notice indicating a new version
23-
# 'transition_step_2': notice encouraging to use new version
24-
# 'transition_step_3': notice indicating the lesson is deprecated,
22+
# 'transition-step-1': notice indicating a new version
23+
# 'transition-step-2': notice encouraging to use new version
24+
# 'transition-step-3': notice indicating the lesson is deprecated,
2525
# with automated redirect
2626
life_cycle: "pre-alpha"
2727

28-
# For lessons in the life stages in 'transition_step_1' or later:
28+
# For lessons in the life stages in 'transition-step-1' or later:
2929
# - 'transition_url' holds the URL for the version of the lesson that
3030
# uses the Workbench (needed for all 3 steps)
3131
# - 'transition_date' (in yyyy-mm-dd format) is the date when the lesson
3232
# will transition to being deprecated. The date only needs to be decided
33-
# when the lesson is in 'transition_step_2'.
33+
# when the lesson is in 'transition-step-2'.
3434
transition_url:
3535
transition_date:
3636

0 commit comments

Comments
 (0)