Skip to content

Commit 1ec5cc4

Browse files
committed
Add closing_remarks shortcode to reduce repetition
All the tutorial pages (except the VNC one) contained the same section under the heading "# Closing remarks" or (less frequent) "# Suggestions/ improvements?". This change adds a shortcode `closing_remarks` which defines this block in one place.
1 parent 45b111d commit 1ec5cc4

File tree

12 files changed

+26
-67
lines changed

12 files changed

+26
-67
lines changed

archetypes/tutorials.md

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,4 @@ toc: true
1212

1313
## Closing remarks
1414

15-
Did you like this or find this cool? We invite you to check out
16-
[more tutorials]({{< relref "/tutorials" >}})
17-
or [get in touch]({{< relref "/#help-and-support" >}}) to tell us what you thought!
18-
19-
If you have any suggestions for how we could improve this documentation
20-
please send us an email at `[email protected]` or submit a Pull Request
21-
on [GitHub](https://github.com/SRCF/docs)!
15+
{{< closing_remarks >}}

content/tutorials/others/connect-to-irc.md

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -338,15 +338,9 @@ useful commands listed in the screen manual, and a few are listed below
338338
- `ctrl+a c` creates a new window.
339339
- `ctrl+a n` switches to the next window.
340340

341-
## Suggestions/improvements?
341+
## Closing remarks
342342

343-
Did you like this or find this cool? We invite you to check out
344-
[more tutorials]({{< relref "/tutorials" >}})
345-
346-
If you have a better way to join the SRCF IRC server (or any other
347-
suggestions for how we could improve this documentation), send us an
348-
email at `[email protected]` or submit a Pull Request on
349-
[GitHub](https://github.com/SRCF/docs)!
343+
{{< closing_remarks >}}
350344

351345
{{< alert type="info" >}}
352346
This tutorial was based largely on content provided to us by Matthew

content/tutorials/others/simple-minecraft-server.md

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -151,10 +151,4 @@ users of the SRCF's systems!
151151

152152
## Closing remarks
153153

154-
Did you like this or find this cool? We invite you to check out
155-
[more tutorials]({{< relref "/tutorials" >}})
156-
or [get in touch]({{< relref "/#help-and-support" >}}) to tell us what you thought!
157-
158-
If you have any suggestions for how we could improve this documentation
159-
please send us an email at `[email protected]` or submit a Pull Request
160-
on [GitHub](https://github.com/SRCF/docs)!
154+
{{< closing_remarks >}}

content/tutorials/others/virtual-desktops-over-vnc.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -137,3 +137,7 @@ Replace `:12` with the **port number** for your VNC server.
137137

138138
Make sure to close any running programs over VNC beforehand, as this
139139
will forcefully kill them too.
140+
141+
## Closing remarks
142+
143+
{{< closing_remarks >}}

content/tutorials/shell-and-files/logging-in.md

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -110,10 +110,4 @@ If you're interested in what else you can do with the shell, check out [our more
110110

111111
## Closing remarks
112112

113-
Did you like this or find this cool? We invite you to check out
114-
[more tutorials]({{< relref "/tutorials" >}})
115-
or [get in touch]({{< relref "/#help-and-support" >}}) to tell us what you thought!
116-
117-
If you have any suggestions for how we could improve this documentation
118-
please send us an email at `[email protected]` or submit a Pull Request
119-
on [GitHub](https://github.com/SRCF/docs)!
113+
{{< closing_remarks >}}

content/tutorials/shell-and-files/passwordless-login.md

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -78,10 +78,4 @@ You can even make this process simpler by [setting up an SSH configuration file]
7878

7979
## Closing remarks
8080

81-
Did you like this or find this cool? We invite you to check out
82-
[more tutorials]({{< relref "/tutorials" >}})
83-
or [get in touch]({{< relref "/#help-and-support" >}}) to tell us what you thought!
84-
85-
If you have any suggestions for how we could improve this documentation
86-
please send us an email at `[email protected]` or submit a Pull Request
87-
on [GitHub](https://github.com/SRCF/docs)!
81+
{{< closing_remarks >}}

content/tutorials/shell-and-files/terminal-guide.md

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -188,10 +188,4 @@ To log out of the system, type 'exit' at the command prompt.
188188

189189
## Closing remarks
190190

191-
Did you like this or find this cool? We invite you to check out
192-
[more tutorials]({{< relref "/tutorials" >}})
193-
or [get in touch]({{< relref "/#help-and-support" >}}) to tell us what you thought!
194-
195-
If you have any suggestions for how we could improve this documentation
196-
please send us an email at `[email protected]` or submit a Pull Request
197-
on [GitHub](https://github.com/SRCF/docs)!
191+
{{< closing_remarks >}}

content/tutorials/shell-and-files/uploading-files.md

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -78,10 +78,4 @@ site and that site being published on the web. Please be patient.
7878

7979
## Closing remarks
8080

81-
Did you like this or find this cool? We invite you to check out
82-
[more tutorials]({{< relref "/tutorials" >}})
83-
or [get in touch]({{< relref "/#help-and-support" >}}) to tell us what you thought!
84-
85-
If you have any suggestions for how we could improve this documentation
86-
please send us an email at `[email protected]` or submit a Pull Request
87-
on [GitHub](https://github.com/SRCF/docs)!
81+
{{< closing_remarks >}}

content/tutorials/websites/deploy-a-web-app.md

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -432,10 +432,4 @@ this in the [reference for web apps]({{< relref "/reference/web-hosting/web-appl
432432
433433
## Closing remarks
434434
435-
Did you like this or find this cool? We invite you to check out
436-
[more tutorials]({{< relref "/tutorials" >}})
437-
or [get in touch]({{< relref "/#help-and-support" >}}) to tell us what you thought!
438-
439-
If you have any suggestions for how we could improve this documentation
440-
please send us an email at `[email protected]` or submit a Pull Request
441-
on [GitHub](https://github.com/SRCF/docs)!
435+
{{< closing_remarks >}}

content/tutorials/websites/static-site-generators.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,4 @@ A few reputable SSGs out there include:
2222

2323
## Closing remarks
2424

25-
Did you like this or find this cool? We invite you to check out [more tutorials]({{< relref "/tutorials" >}}) or [get in touch]({{< relref "/#help-and-support" >}}) to tell us what you thought!
26-
27-
If you have any suggestions for how we could improve this documentation please send us an email at `[email protected]` or submit a Pull Request on [GitHub](https://github.com/SRCF/docs)!
25+
{{< closing_remarks >}}

0 commit comments

Comments
 (0)