Update docs links

CHANGES.md

@@ -19,9 +19,9 @@ release.
   * `rose suite-run` -> `cylc install; cylc play <id>`
 * The core package containing Cylc scheduler program has been renamed cylc-flow.
 * Cylc review has been removed, the Cylc 7 version remains Cylc 8 compatible.
-* [New documentation](https://cylc.github.io/cylc-doc/latest).
+* [New documentation](https://cylc.github.io/cylc-doc/stable).
 
-See the [migration guide](https://cylc.github.io/cylc-doc/latest/html/7-to-8/index.html) for a full list of changes.
+See the [migration guide](https://cylc.github.io/cylc-doc/stable/html/7-to-8/index.html) for a full list of changes.
 
 <!-- The topmost release date is automatically updated by GitHub Actions. When
 creating a new release entry be sure to copy & paste the span tag with the
@@ -118,7 +118,7 @@ past jobs to be omitted in the UI.
 
 [#4860](https://github.com/cylc/cylc-flow/pull/4860) - Workflow validation
 now fails if
-[owner setting](https://cylc.github.io/cylc-doc/latest/html/reference/config/workflow.html#flow.cylc[runtime][%3Cnamespace%3E][remote]owner)
+[owner setting](https://cylc.github.io/cylc-doc/8.0.0/html/reference/config/workflow.html#flow.cylc[runtime][%3Cnamespace%3E][remote]owner)
 is used, as that setting no longer has any effect.
 
 [#4978](https://github.com/cylc/cylc-flow/pull/4978) - `cylc clean`: fix
@@ -247,7 +247,7 @@ Second Release Candidate for Cylc 8 suitable for acceptance testing.
 remote file installation is now configurable.
 
 [#4655](https://github.com/cylc/cylc-flow/pull/4655) - Enhancements to the
-provided [wrapper script](https://cylc.github.io/cylc-doc/latest/html/installation.html#managing-environments).
+provided [wrapper script](https://cylc.github.io/cylc-doc/8.0.0/html/installation.html#managing-environments).
 
 ### Fixes
 

INSTALL.md

@@ -1,20 +1,14 @@
 # Cylc: Quick Installation Guide
 
-**See [The Cylc User Guide](https://cylc.github.io/documentation.html) for
-more detailed information.**  Cylc documentation is now maintained in the
-cylc/cylc-doc repository on GitHub.
+## Cylc 8
 
-Cylc must be installed on workflow and task job hosts. Third-party dependencies
-(below) are not required on job hosts.
-
-### Python 2 or Python 3 ?
+**See the [Cylc installation guide](https://cylc.github.io/cylc-doc/stable/html/installation.html)
+for more detailed information.**
 
-Currently in the source code repository:
-- **master branch:** Python 3, ZeroMQ network layer, **no GUI** - Cylc-8 Work In Progress
-- **7.8.x branch:** Python 2, Cherrypy network layer, PyGTK GUI - Cylc-7 Maintenance
+Cylc must be installed on workflow and task job hosts. Third-party dependencies
+are not required on job hosts.
 
-The first official Cylc-8 release (with a new web UI) is not expected until late 2019.
-Until then we recommend the latest cylc-7.8 release for production use.
+## Cylc 7
 
 See [INSTALL.md in the 7.8.x repository branch](https://github.com/cylc/cylc-flow/blob/7.8.x/INSTALL.md), or in your unpacked 7.8.x
 release, for how to install Cylc 7. You can download the latest cylc-7 release

README.md

@@ -29,24 +29,23 @@ forecasting - which is notorious for the size and complexity of its workflows.
 ### Cylc 7 (legacy)
 
 ![python](https://img.shields.io/badge/python-2.6%20%7C%202.7-orange)
-[![Documentation](https://img.shields.io/website?label=documentation&up_message=live&url=https%3A%2F%2Fcylc.github.io%2Fcylc-doc%2Fstable%2Fhtml%2Findex.html)](https://cylc.github.io/cylc-doc/stable/html/index.html)
+[![Documentation](https://img.shields.io/website?label=documentation&up_message=live&url=https%3A%2F%2Fcylc.github.io%2Fcylc-doc%2F7.9.3%2Fhtml%2Findex.html)](https://cylc.github.io/cylc-doc/7.9.3/html/index.html)
 
 * HTTPS network layer.
 * PyGTK GUI.
 * On the `7.8.x` branch in the source code.
 * 7.8 - Python 2.6
 * 7.9 - Python 2.7
 
-[Quick Installation](INSTALL.md) |
-[Website](https://cylc.github.io/) |
+[Installation](https://github.com/cylc/cylc-flow/blob/7.8.x/INSTALL.md) |
 [Documentation](https://cylc.github.io/documentation)
 
 ### Cylc 8 (production)
 
 ![PyPI](https://img.shields.io/pypi/pyversions/cylc-flow.svg?color=green)
 [![PyPI](https://img.shields.io/pypi/v/cylc-flow.svg?color=yellow)](https://pypi.org/project/cylc-flow/)
 [![Anaconda-Server Badge](https://anaconda.org/conda-forge/cylc-flow/badges/version.svg)](https://anaconda.org/conda-forge/cylc-flow)
-[![Documentation](https://img.shields.io/website?label=documentation&up_message=live&url=https%3A%2F%2Fcylc.github.io%2Fcylc-doc%2Flatest%2Fhtml%2Findex.html)](https://cylc.github.io/cylc-doc/latest/html/index.html)
+[![Documentation](https://img.shields.io/website?label=documentation&up_message=live&url=https%3A%2F%2Fcylc.github.io%2Fcylc-doc%2Fstable%2Fhtml%2Findex.html)](https://cylc.github.io/cylc-doc/latest/html/index.html)
 
 * ZMQ (TCP) network layer.
 * Text-based terminal user interface (TUI).
@@ -55,8 +54,8 @@ forecasting - which is notorious for the size and complexity of its workflows.
 
 Cylc 8 is now production-ready.
 
-[Installation](https://cylc.github.io/cylc-doc/latest/html/installation.html) |
-[Documentation](https://cylc.github.io/cylc-doc/latest/html/index.html)
+[Installation](https://cylc.github.io/cylc-doc/stable/html/installation.html) |
+[Documentation](https://cylc.github.io/cylc-doc/stable/html/index.html)
 
 ### Copyright and Terms of Use
 

cylc/flow/config.py

@@ -2076,7 +2076,7 @@ def _proc_triggers(self, parser, seq, task_triggers):
             LOG.warning(
                 f"{suicides} suicide trigger(s) detected. These are rarely "
                 "needed in Cylc 8 - see https://cylc.github.io/cylc-doc/"
-                "latest/html/7-to-8/major-changes/suicide-triggers.html"
+                "stable/html/7-to-8/major-changes/suicide-triggers.html"
             )
 
     def set_required_outputs(
@@ -2340,7 +2340,7 @@ def check_for_owner(tasks: Dict) -> None:
             # https://github.com/cylc/cylc-flow/issues/4663
             msg = (
                 '"[runtime][task][remote]owner" is obsolete at Cylc 8.'
-                '\nsee https://cylc.github.io/cylc-doc/nightly/'
+                '\nsee https://cylc.github.io/cylc-doc/stable/'
                 'html/7-to-8/major-changes/remote-owner.html'
                 f'\nFirst {min(len(owners), 5)} tasks:'
             )

cylc/flow/scripts/lint.py

@@ -46,10 +46,10 @@
 from cylc.flow.workflow_files import check_flow_file
 
 STYLE_GUIDE = (
-    'https://cylc.github.io/cylc-doc/latest/html/workflow-design-guide/'
+    'https://cylc.github.io/cylc-doc/stable/html/workflow-design-guide/'
     'style-guide.html#'
 )
-URL_STUB = "https://cylc.github.io/cylc-doc/latest/html/7-to-8/"
+URL_STUB = "https://cylc.github.io/cylc-doc/stable/html/7-to-8/"
 SECTION2 = r'\[\[\s*{}\s*\]\]'
 SECTION3 = r'\[\[\[\s*{}\s*\]\]\]'
 FILEGLOBS = ['*.rc', '*.cylc']

cylc/flow/time_parser.py

@@ -309,7 +309,7 @@ def parse_recurrence(
                 LOG.warning(
                     f"The recurrence '{expression}' is unlikely to behave "
                     "the same way as in Cylc 7 as that implementation was "
-                    "incorrect (see https://cylc.github.io/cylc-doc/latest/"
+                    "incorrect (see https://cylc.github.io/cylc-doc/stable/"
                     "html/user-guide/writing-workflows/scheduling.html"
                     "#format-1-r-limit-datetime-datetime)"
                 )

cylc/flow/workflow_files.py

@@ -1736,7 +1736,7 @@ def detect_both_flow_and_suite(path: Path) -> None:
     msg = (f"Both {WorkflowFiles.FLOW_FILE} and {WorkflowFiles.SUITE_RC} "
            f"files are present in {path}. Please remove one and"
            " try again. For more information visit: https://cylc.github.io/"
-           "cylc-doc/latest/html/7-to-8/summary.html#backward-compatibility")
+           "cylc-doc/stable/html/7-to-8/summary.html#backward-compatibility")
     if path.resolve().name == WorkflowFiles.SUITE_RC:
         flow_cylc = path.parent / WorkflowFiles.FLOW_FILE
     elif (path / WorkflowFiles.SUITE_RC).is_file():

setup.cfg

@@ -23,7 +23,7 @@ description = A workflow engine for cycling systems
 long_description=file: README.md
 long_description_content_type=text/markdown
 project_urls =
-    Documentation = https://cylc.github.io/cylc-doc/latest/html/index.html
+    Documentation = https://cylc.github.io/cylc-doc/stable/html/index.html
     Source = https://github.com/cylc/cylc-flow
     Tracker = https://github.com/cylc/cylc-flow/issues
 keywords =

tests/functional/cylc-install/02-failures.t

@@ -72,7 +72,7 @@ run_fail "${TEST_NAME}" cylc install --workflow-name="${RND_WORKFLOW_NAME}" "${R
 contains_ok "${TEST_NAME}.stderr" <<__ERR__
 WorkflowFilesError: Both flow.cylc and suite.rc files are present in ${RND_WORKFLOW_SOURCE}. \
 Please remove one and try again. For more information visit: \
-https://cylc.github.io/cylc-doc/latest/html/7-to-8/summary.html#backward-compatibility
+https://cylc.github.io/cylc-doc/stable/html/7-to-8/summary.html#backward-compatibility
 __ERR__
 
 # Test fail no workflow source dir

tests/functional/cylc-reinstall/02-failures.t

@@ -68,7 +68,7 @@ run_fail "${TEST_NAME}" cylc reinstall "${RND_WORKFLOW_NAME}"
 cmp_ok "${TEST_NAME}.stderr" <<__ERR__
 WorkflowFilesError: Both flow.cylc and suite.rc files are present in ${RND_WORKFLOW_SOURCE}. \
 Please remove one and try again. For more information visit: \
-https://cylc.github.io/cylc-doc/latest/html/7-to-8/summary.html#backward-compatibility
+https://cylc.github.io/cylc-doc/stable/html/7-to-8/summary.html#backward-compatibility
 __ERR__
 purge_rnd_workflow
 

tests/unit/test_workflow_files.py

@@ -1574,7 +1574,7 @@ def test_check_flow_file(
             "Both flow.cylc and suite.rc files are present in "
             f"{tmp_path}. Please remove one and try again. "
             "For more information visit: "
-            "https://cylc.github.io/cylc-doc/latest/html/7-to-8/summary.html"
+            "https://cylc.github.io/cylc-doc/stable/html/7-to-8/summary.html"
             "#backward-compatibility"
         )
 
@@ -1594,7 +1594,7 @@ def test_detect_both_flow_and_suite(tmp_path):
     assert str(exc.value) == (
         f"Both flow.cylc and suite.rc files are present in {tmp_path}. Please "
         "remove one and try again. For more information visit: "
-        "https://cylc.github.io/cylc-doc/latest/html/7-to-8/"
+        "https://cylc.github.io/cylc-doc/stable/html/7-to-8/"
         "summary.html#backward-compatibility"
     )