Skip to content

Commit 70387cf

Browse files
humitoshumitos
authored
Add project: change copy for "Finish" button (#434)
* Add project: small update to the workflow Idea we talked in the Book Club. I'm opening the PR here to continue improving this idea. * Lint * Copy for the message Explain a little more what's expected in this step. It doesn't change the structure of the page on purpose, just updates the message. * Lint * Update copy on button * Feedback from review * Simplify paragraph * Typo
1 parent 3e97928 commit 70387cf

File tree

2 files changed

+44
-19
lines changed

2 files changed

+44
-19
lines changed

‎readthedocsext/theme/templates/projects/import_base.html

Lines changed: 17 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,15 @@
33
{% load i18n %}
44
{% load crispy_forms_tags %}
55

6-
{% block title %}{% trans "Add project" %}{% endblock %}
6+
{% block title %}
7+
{% trans "Add project" %}
8+
{% endblock title %}
79

810
{% block content %}
911
{% block project_add_grid %}
10-
<div class="ui very padded centered stackable grid" {% block project_add_data_bind %}{% endblock %}>
12+
<div class="ui very padded centered stackable grid"
13+
{% block project_add_data_bind %}
14+
{% endblock project_add_data_bind %}>
1115

1216
{% block project_add_header %}
1317
<div class="ui five wide computer four wide large screen computer only column">
@@ -50,9 +54,12 @@ <h2 class="ui small header">{% trans "Help topics" %}</h2>
5054
{% endblock project_add_sidebar %}
5155

5256
{% block project_add_content %}
57+
5358
<div class="ui sixteen wide tablet eleven wide computer ten wide large screen column">
5459
{% block project_add_content_form %}
55-
<form class="ui form" action="{% url "projects_import_manual" %}" method="post">
60+
<form class="ui form"
61+
action="{% url "projects_import_manual" %}"
62+
method="post">
5663

5764
{% block wizard_form %}
5865
{% if wizard.form.forms %}
@@ -72,15 +79,17 @@ <h2 class="ui small header">{% trans "Help topics" %}</h2>
7279
{% block wizard_actions %}
7380
<div>
7481
{% if wizard.steps.prev %}
75-
<button class="ui button" name="wizard_goto_step" value="{{ wizard.steps.prev }}">
76-
{% trans "Previous" %}
77-
</button>
82+
<button class="ui button"
83+
name="wizard_goto_step"
84+
value="{{ wizard.steps.prev }}">{% trans "Previous" %}</button>
7885
{% endif %}
7986

8087
{% if wizard.steps.next %}
8188
<input class="ui button primary" type="submit" value="{% trans "Next" %}" />
8289
{% else %}
83-
<input class="ui button primary" type="submit" value="{% trans "Finish" %}" />
90+
<input class="ui button primary"
91+
type="submit"
92+
value="{% trans "This file exists" %}" />
8493
{% endif %}
8594
</div>
8695
{% endblock wizard_actions %}
@@ -91,4 +100,4 @@ <h2 class="ui small header">{% trans "Help topics" %}</h2>
91100
{% endblock project_add_content %}
92101
</div>
93102
{% endblock project_add_grid %}
94-
{% endblock %}
103+
{% endblock content %}

‎readthedocsext/theme/templates/projects/import_config.html

Lines changed: 27 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,16 @@
55
{% trans "Add a configuration file to your project" %}
66
{% endblock project_add_subheader %}
77

8-
{% block project_add_content_classes %}ui fourteen wide tablet twelve wide computer column{% endblock %}
8+
{% block project_add_content_classes %}
9+
ui fourteen wide tablet twelve wide computer column
10+
{% endblock project_add_content_classes %}
911

1012
{% block project_add_content_form %}
1113
<div class="ui small info message">
1214
{% blocktrans trimmed %}
13-
Save and commit the following example configuration to your repository root as <code>.readthedocs.yaml</code>.
15+
A <strong><code>.readthedocs.yaml</code> file is required at the root of your repository</strong> to build your project's documentation.
16+
You can pick an example for your documentation tool as a starting point below,
17+
and save and commit it to your repository.
1418
{% endblocktrans %}
1519
</div>
1620

@@ -27,9 +31,9 @@
2731
<div class="item" data-tab="jekyll">Jekyll</div>
2832
<div class="item" data-tab="others">{% trans "Others" %}</div>
2933
{# The `actionable` class here prevents the select from selecting the text #}
30-
<a class="actionable item" href="https://docs.readthedocs.io/page/config-file/index.html#getting-started-with-a-template" target="_blank">
31-
{% trans "See more examples" %}
32-
</a>
34+
<a class="actionable item"
35+
href="https://docs.readthedocs.io/page/config-file/index.html#getting-started-with-a-template"
36+
target="_blank">{% trans "See more examples" %}</a>
3337
</div>
3438
</div>
3539
</div>
@@ -39,7 +43,9 @@
3943
<div class="ui top attached label">
4044
<code>.readthedocs.yaml</code>
4145
</div>
42-
<a class="ui top right attached icon label" href="#" data-clipboard-target="#project-create-sample-sphinx">
46+
<a class="ui top right attached icon label"
47+
href="#"
48+
data-clipboard-target="#project-create-sample-sphinx">
4349
<i class="fas fa-copy icon"></i>
4450
</a>
4551
<code class="highlight">
@@ -76,7 +82,9 @@
7682
<div class="ui top attached label">
7783
<code>.readthedocs.yaml</code>
7884
</div>
79-
<a class="ui top right attached icon label" href="#" data-clipboard-target="#project-create-sample-mkdocs">
85+
<a class="ui top right attached icon label"
86+
href="#"
87+
data-clipboard-target="#project-create-sample-mkdocs">
8088
<i class="fas fa-copy icon"></i>
8189
</a>
8290
<code class="highlight">
@@ -113,7 +121,9 @@
113121
<div class="ui top attached label">
114122
<code>.readthedocs.yaml</code>
115123
</div>
116-
<a class="ui top right attached icon label" href="#" data-clipboard-target="#project-create-sample-docusaurus">
124+
<a class="ui top right attached icon label"
125+
href="#"
126+
data-clipboard-target="#project-create-sample-docusaurus">
117127
<i class="fas fa-copy icon"></i>
118128
</a>
119129
<code class="highlight">
@@ -148,7 +158,9 @@
148158
<div class="ui top attached label">
149159
<code>.readthedocs.yaml</code>
150160
</div>
151-
<a class="ui top right attached icon label" href="#" data-clipboard-target="#project-create-sample-pelican">
161+
<a class="ui top right attached icon label"
162+
href="#"
163+
data-clipboard-target="#project-create-sample-pelican">
152164
<i class="fas fa-copy icon"></i>
153165
</a>
154166
<code class="highlight">
@@ -180,7 +192,9 @@
180192
<div class="ui top attached label">
181193
<code>.readthedocs.yaml</code>
182194
</div>
183-
<a class="ui top right attached icon label" href="#" data-clipboard-target="#project-create-sample-jekyll">
195+
<a class="ui top right attached icon label"
196+
href="#"
197+
data-clipboard-target="#project-create-sample-jekyll">
184198
<i class="fas fa-copy icon"></i>
185199
</a>
186200
<code class="highlight">
@@ -213,7 +227,9 @@
213227
<div class="ui top attached label">
214228
<code>.readthedocs.yaml</code>
215229
</div>
216-
<a class="ui top right attached icon label" href="#" data-clipboard-target="#project-create-sample-others">
230+
<a class="ui top right attached icon label"
231+
href="#"
232+
data-clipboard-target="#project-create-sample-others">
217233
<i class="fas fa-copy icon"></i>
218234
</a>
219235
<code class="highlight">

0 commit comments

Comments
 (0)