Skip to content

Commit 7edcef8

Browse files
authored
Merge pull request #664 from oliver-sanders/tutorial-summary
tutorial: add summary page
2 parents b7ee98e + be722f8 commit 7edcef8

File tree

5 files changed

+44
-1
lines changed

5 files changed

+44
-1
lines changed

src/reference/index.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _reference:
2+
13
Reference
24
=========
35

src/tutorial/runtime/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,3 +17,4 @@ This section covers:
1717
introduction
1818
runtime-configuration
1919
configuration-consolidation/index
20+
summary

src/tutorial/runtime/summary.rst

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
Tutorial Summary
2+
================
3+
4+
You've made it to the end of the Cylc tutorial!
5+
6+
The Cylc tutorial aims to introduce you to the main concepts in Cylc to
7+
prepare you for working with and writing Cylc workflows.
8+
But there is so much more we didn't have time for.
9+
10+
:ref:`Rose Tutorial <Rose Tutorial>`
11+
`Rose`_ is a tool for creating configurable applications. It's often used
12+
with Cylc to configure more complex tasks, or even the workflow itself.
13+
14+
Rose configurations can have metadata, support validation and can be edited
15+
using a GUI.
16+
17+
You might want to try the :ref:`Rose Tutorial` if these things are of interest.
18+
:ref:`Further Topics <tutorials.furthertopics>`
19+
There some extra tutorials which cover some of the things the main tutorial
20+
doesn't in the :ref:`further topics section <tutorials.furthertopics>`.
21+
`Discourse`_
22+
If you get stuck, encounter an issue, have a question, or just fancy a chat
23+
about Cylc, feel free to reach out to the Cylc community on our `Discourse`_
24+
forum.
25+
26+
We also make announcements (e.g. new Cylc releases) on the forum, so it's a
27+
good to keep an eye on it.
28+
:ref:`User Guide <user guide>`
29+
There is a comprehensive :ref:`user guide` which goes into Cylc's
30+
capabilities in detail.
31+
:ref:`Workflow Design Guide <workflow design guide>`
32+
This covers recommended code style and best practice.
33+
:ref:`Reference <reference>`
34+
The reference section contains all sorts of technical details.
35+
36+
It also lists all of the configurations Cylc supports for workflow
37+
definition :cylc:conf:`flow.cylc`, and for site/user setup
38+
:cylc:conf:`global.cylc`.

src/user-guide/index.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _user guide:
2+
13
User Guide
24
==========
35

src/workflow-design-guide/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.. SDG:
1+
.. _workflow design guide:
22

33
Workflow Design Guide
44
=====================

0 commit comments

Comments
 (0)