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.

Sign up for GitHub

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

Rose user guide rose tutorial #2170

Merged
merged 36 commits into from
Apr 25, 2018
Merged

Rose user guide rose tutorial #2170

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
36 commits
Select commit Hold shift + click to select a range
4471984
Remove cylc logic from tutorial scripts.
oliver-sanders Mar 16, 2018
0f78267
rose introduction.
oliver-sanders Mar 16, 2018
09fcb60
rose applications.
oliver-sanders Mar 16, 2018
b8658df
rose metadata.
oliver-sanders Mar 20, 2018
00606e2
rose/cylc cheat sheet.
oliver-sanders Mar 23, 2018
887f7ed
tutorial suite, pass cycle point offsets.
oliver-sanders Mar 28, 2018
16a8f07
rose suite configurations.
oliver-sanders Mar 28, 2018
a0a89a9
rose bush - temporary tutorial addition
oliver-sanders Apr 4, 2018
16b7310
add directive for practical extensions
oliver-sanders Apr 10, 2018
8016d5b
rosie
oliver-sanders Apr 6, 2018
2080324
rose summary
oliver-sanders Apr 9, 2018
4322518
style code-block captions.
oliver-sanders Apr 10, 2018
761215a
move all tutorials into the rose-tutorial directory.
oliver-sanders Apr 10, 2018
b89d3ec
erratum - first pass
oliver-sanders Apr 12, 2018
27668cf
pep8.
oliver-sanders Apr 13, 2018
78df244
Capitalise all rose instances.
oliver-sanders Apr 13, 2018
61feafe
Capitalise all cylc instances.
oliver-sanders Apr 13, 2018
1ca206d
Add tutorial file tests.
oliver-sanders Apr 13, 2018
83790e8
Correct tutorial directory names.
oliver-sanders Apr 13, 2018
93581cb
Set graphviz defaults.
oliver-sanders Apr 13, 2018
7b7255f
Default to rose highlighting in rose auto directive.
oliver-sanders Apr 13, 2018
6200429
Add final rose forecasting suite, address TODOs.
oliver-sanders Apr 13, 2018
a01e3b6
Address feedback
oliver-sanders Apr 21, 2018
feb3ec8
feedback
oliver-sanders Apr 23, 2018
2b223ca
remove rogue control character
oliver-sanders Apr 23, 2018
18ac5f5
erratum
oliver-sanders Apr 24, 2018
400ee9c
Review feedback minor changes: fix typos, improve clarity etc
sadielbartholomew Apr 20, 2018
307639c
feedback 2
oliver-sanders Apr 24, 2018
ccac7f1
Resolve merge conflicts
sadielbartholomew Apr 24, 2018
f458a4f
Respond to feedback
sadielbartholomew Apr 24, 2018
24bc586
Merge pull request #19 from sadielbartholomew/copy-rug-rose-tut
oliver-sanders Apr 24, 2018
cf3439a
feedback 3
oliver-sanders Apr 24, 2018
a42675a
explain the forecast app test data
oliver-sanders Apr 24, 2018
5fc9e36
feedback 4
oliver-sanders Apr 24, 2018
d4e9baa
feedback 5
oliver-sanders Apr 25, 2018
332c976
feedback 6
oliver-sanders Apr 25, 2018
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: 1 addition & 1 deletion sphinx/hyperlinks.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,11 @@
.. _Cylc Suite Design Guide: http://cylc.github.io/cylc/doc/suite-design-guide.pdf
.. _FCM: https://metomi.github.io/fcm/doc/
.. _FCM User Guide: http://metomi.github.io/fcm/doc/user_guide/
.. _Github: https://github.com/metomi/rose
.. _INI: https://en.wikipedia.org/wiki/INI_file
.. _Jinja2: http://jinja.pocoo.org/
.. _metomi-vms: https://github.com/metomi/metomi-vms
.. _PyGTK: http://www.pygtk.org/
.. _Python: https://www.python.org/
.. _Python Regular Expressions: https://docs.python.org/2/library/re.html#regular-expression-syntax
.. _Rose GitHub: https://github.com/metomi/rose
.. _SRS: https://code.metoffice.gov.uk/
4 changes: 2 additions & 2 deletions sphinx/installation.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ Installation

.. _archives: https://github.com/metomi/rose/tags

The source code for Rose is available via `GitHub`_, code releases
are available in ``zip`` and ``tar.gz`` `archives`_.
The source code for Rose is available via `GitHub <Rose GitHub>`_, code
Copy link
Contributor

@sadielbartholomew sadielbartholomew Apr 25, 2018 •
edited
Loading

Choose a reason for hiding this comment

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

This link is broken. I seem to recall you cannot provide custom text for a hyperlink created from another file, so will need to rename directly in sphinx/hyperlinks.rst.

Copy link
Contributor

Choose a reason for hiding this comment

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

The link to SVN in sphinx/tutorial/rose/rosie.rst is also broken for the same reason.

Copy link
Member Author

Choose a reason for hiding this comment

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

Doh, I keep walking into that one.

releases are available in ``zip`` and ``tar.gz`` `archives`_.

1. Un-pack the archive file into an appropriate location on your system.
2. Add the ``rose/bin/`` directory into your ``PATH`` environment variable.
Expand Down
2 changes: 1 addition & 1 deletion sphinx/tutorial/rose/furthertopics/polling.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ file that looks like this:
graph = """compose_letter => send_letter
bob => read_letter"""

This is simple suite which consists of the following:
This is a simple suite which consists of the following:

* A ``compose_letter`` task.
* A ``send_letter`` task which is run once the letter is composed.
Expand Down
2 changes: 1 addition & 1 deletion sphinx/tutorial/rose/rosie.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -298,7 +298,7 @@ commands called :ref:`command-rosie-go`.
Switch back to the trunk then merge your change branch into the trunk::

fcm sw trunk
fcm merge change trunk
fcm merge change

Check the status (you should see the ``M`` symbol next to the
:rose:file:`rose-suite.conf` file) then commit the merge::
Expand Down