-
Notifications
You must be signed in to change notification settings - Fork 19
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
cylc8 first-pass #148
cylc8 first-pass #148
Conversation
Tests will fail until the next version of cylc-sphinx-extensions is released and the sibling Cylc Flow PR is merged. To review, checkout the cylc-flow and cylc-sphinx-extensions branches and |
src/glossary.rst
Outdated
the ``suite.rc`` file. | ||
the :cylc:conf:`suite.rc` file. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Stuff like this is going to conflict every single time with my suite.rc --> flow.cylc
PR #142 😅
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We'll try to get yours in first then!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@oliver-sanders - you're deliberately not ditching the term "suite" in this PR?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For now yes. Ronnies change should be merged soon so I'll get the rebase! We will need a separate PRs to eradicate "suite" references in cylc-flow/cylc-doc as this is a big job in of itself.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A good start to the big rewrite 👍 Approved with a few minor suggestions. (And one grump about indentation inside script strings ... but I'll stop flogging that dead horse now ... also for consistency reasons as we've ended with mixed styles at this point).
src/glossary.rst
Outdated
the ``suite.rc`` file. | ||
the :cylc:conf:`suite.rc` file. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@oliver-sanders - you're deliberately not ditching the term "suite" in this PR?
`GNU General Public License v3.0 | ||
<https://www.gnu.org/licenses/gpl-3.0.en.html>`_. | ||
|
||
|
||
.. [1] Future plans for EcoConnect include additional deterministic regional | ||
weather forecasts and a statistical ensemble. | ||
.. [2] Note that simply overlapping the single cycle point schedules of the |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should delete this whole file. It is way out of date (especially now, post-SoD)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fair enough, it's full of NWP context too, happy to remove the content and leave the title or else leave the whole thing pending re-write.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let's remove it.
|
||
- task-to-suite messaging via TCP (using ZMQ protocol) | ||
- task-to-suite messaging via non-interactive SSH to the suite host, | ||
then local TCP |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Didn't we decide we need to restore this capability?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, however, we haven't restored it yet (I think still waiting on a decision over whether we can rely on TCP forwarding or whether we should re-implement the Cylc7 SSH-forwarding logic).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pretty sure we decided we had to re-implement the old logic - ping @dpmatthews ? Maybe bang a TODO in here at least, so we don't forget to come back and update this section.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, I think we've decided to use the old method. See cylc/cylc-flow#3327.
Obviously, don't merge this branch until the tests pass. |
44d9214
to
be1e0e9
Compare
Added an extra couple of commits onto the end. I'm not quite sure what happened here but it looks like the migration of extensions into cylc-sphinx-extensions was never properly completed. I must have been in a rush. There were some static files left behind in This was covering up a much bigger issue to do with the installation of static files. Sadly the approach being used to install the static files by fiddling the So I've added a commit onto the end of cylc/cylc-sphinx-extensions#29 which manually copies static files across into the build directory. It would appear that this is the only real way to do it, this is what other extensions do. |
Tried to test by checking out all the relevant branches on this, cylc-flow and cylc-sphinx-ext but the conf changes are making it a headache, Can we merge #142 first? |
be1e0e9
to
1dad293
Compare
Co-authored-by: Hilary James Oliver <hilary.j.oliver@gmail.com> Co-authored-by: Ronnie Dutta <61982285+MetRonnie@users.noreply.github.com>
1dad293
to
b4034ec
Compare
Rebased and deconflicted, tests should now pass (at long last!). |
... Or not, linkcheck failure still to fix... |
Ok, I think it's nearly there, just one last linkcheck issue which requires yet another PR cylc/cylc-flow#3783 |
I've tested this with the right branches checked out and it passes. Don't know if you want to wait for the other branches before merging |
I'll wait for the cylc flow branch to be merged and the actions run to pass. |
Tests pass, took a few PRs to cylc-sphinx-extensions, cylc-doc and cylc-flow, but we are now Sphinx3, |
Merging with two approvals. |
Sibling PRs: cylc/cylc-sphinx-extensions#29, cylc/cylc-flow#3777
A quick first-pass of the documentation:
:cylc:conf:
).cylc
command).This started out as a quick pass to use the cylc-domain e.g.
[runtime]
->:cylc:conf:'[runtime]'
, however, it is very hard to edit just one thing in the documentation at the moment :/The Grand Scheme Of Things:
This isn't the "great edit" that the docs need, however, it should make that edit a bit easier when it comes.
These docs aren't polished ready for release, however, they are a bit better than before.
Most of the non-indentation changes are in the user guide, namely writing and running suites.
Pre 8.0.0:
Here's a non-exhaustive list of stuff to do to the docs pre-cylc8:
[platforms]
changes.