Document Cylc Review (minimally for next version) #2821
Conversation
doc/src/cylc-user-guide/cug.tex
Outdated
| \subsection{Viewing Suite Logs via Web Browser: Cylc Review} | ||
|
|
||
| Cylc provides a utility for viewing the status and logs of suites called | ||
| Cylc Review. Cylc Review displays suite information in web pages, as shown in |
There was a problem hiding this comment.
"It displays..." (repeating the name isn't necessary here).
doc/src/cylc-user-guide/cug.tex
Outdated
| If a Cylc Review server is provided at your site, you can open the Cylc | ||
| Review page for a suite by running the \lstinline=cylc review= command. | ||
| See~\ref{HostsforCylcReview} for requirements and~\ref{ConfiguringCylcReview} | ||
| for configuration steps for setting up a host to run the Cylc Review service |
There was a problem hiding this comment.
"to run the service at your site" (probably unnecessary to repeat "Cylc Review" again there).
doc/src/cylc-user-guide/cug.tex
Outdated
| \item Jinja2. | ||
|
|
||
| \end {myitemize} | ||
|
|
There was a problem hiding this comment.
This probably should be just an comment on cylc review-specific requirements in the CUG installation section.
There was a problem hiding this comment.
Yes, that is a much better location for it. Sorry for missing that.
sadielbartholomew
force-pushed
the
document-cylc-review
branch
from
d027351
to
9875a77
Compare
|
Thanks Hilary, I've updated this in line with your comments (FYI, I didn't write it, I just lifted, shifted & search-&-replaced the text someone else had written about Rose Bush). I also removed the extension to |
First follow-on to #2614 (merge only after that PR is merged).
Start to add-in documentation on the Cylc Review service to the User Guide. Given we want to get this into the next version if possible, add only very basic information for no. Obviously this needs to be extended for the next version.
Additionally, add the associated CherryPy dependency to[Edit: no need, CherryPy bundled with Cylc]check-software.I've lifted & shifted Rose Bush documentation word-for-word, except for replacing with Cylc and Cylc Review etc., as appropriate, & referencing the screenshot as a figure, as is the style in the CUG. Let me know if you spot anything now inappropriate, though it seems fine as far as I can see.
Admittedly I have been struggling to find the necessary TeX dependencies to build the documentation on the Met Office software stacks, so couldn't build as a PDF. I'll try next week, but here is the essence for now.