Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

tutorial: add summary page #664

Merged
merged 1 commit into from
Dec 6, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions src/reference/index.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _reference:

Reference
=========

Expand Down
1 change: 1 addition & 0 deletions src/tutorial/runtime/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,3 +17,4 @@ This section covers:
introduction
runtime-configuration
configuration-consolidation/index
summary
38 changes: 38 additions & 0 deletions src/tutorial/runtime/summary.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
Tutorial Summary
================

You've made it to the end of the Cylc tutorial!

The Cylc tutorial aims to introduce you to the main concepts in Cylc to
prepare you for working with and writing Cylc workflows.
But there is so much more we didn't have time for.

:ref:`Rose Tutorial <Rose Tutorial>`
`Rose`_ is a tool for creating configurable applications. It's often used
with Cylc to configure more complex tasks, or even the workflow itself.

Rose configurations can have metadata, support validation and can be edited
using a GUI.

You might want to try the :ref:`Rose Tutorial` if these things are of interest.
:ref:`Further Topics <tutorials.furthertopics>`
There some extra tutorials which cover some of the things the main tutorial
doesn't in the :ref:`further topics section <tutorials.furthertopics>`.
`Discourse`_
If you get stuck, encounter an issue, have a question, or just fancy a chat
about Cylc, feel free to reach out to the Cylc community on our `Discourse`_
forum.

We also make announcements (e.g. new Cylc releases) on the forum, so it's a
good to keep an eye on it.
:ref:`User Guide <user guide>`
There is a comprehensive :ref:`user guide` which goes into Cylc's
capabilities in detail.
:ref:`Workflow Design Guide <workflow design guide>`
This covers recommended code style and best practice.
:ref:`Reference <reference>`
The reference section contains all sorts of technical details.

It also lists all of the configurations Cylc supports for workflow
definition :cylc:conf:`flow.cylc`, and for site/user setup
:cylc:conf:`global.cylc`.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it worth putting a pointer to the 728 section here too, given that at least a few people on the course have been updaters?

2 changes: 2 additions & 0 deletions src/user-guide/index.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _user guide:

User Guide
==========

Expand Down
2 changes: 1 addition & 1 deletion src/workflow-design-guide/index.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. SDG:
.. _workflow design guide:

Workflow Design Guide
=====================
Expand Down
Loading