From 1ae271ff383c70a1035ada945f97919d2d3e4daf Mon Sep 17 00:00:00 2001 From: Kyle Finley Date: Wed, 14 Aug 2024 14:34:41 -0400 Subject: [PATCH] update documentation URLs to reflect EoL of onica.com (#2484) --- .github/CONTRIBUTING.md | 6 +++--- .github/pull_request_template.md | 2 +- README.md | 4 ++-- docs/source/getting_started.rst | 4 ++-- pyproject.toml | 2 +- runway/_cli/commands/_docs.py | 2 +- runway/_cli/commands/_new.py | 4 ++-- runway/_cli/main.py | 2 +- runway/cfngin/blueprints/base.py | 2 +- runway/utils/__init__.py | 2 +- tests/integration/cli/commands/test_docs.py | 2 +- tests/integration/cli/commands/test_new.py | 2 +- 12 files changed, 17 insertions(+), 17 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index c6ac0148b..1af8ae82e 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -2,6 +2,6 @@ To view our [Getting Started] guide for developers and [Contribution Requirements], please refer to the official [documentation]. -[contribution requirements]: https://docs.onica.com/projects/runway/page/developers/contributing.html -[documentation]: https://docs.onica.com/projects/runway -[getting started]: https://docs.onica.com/projects/runway/page/developers/getting_started.html +[contribution requirements]: https://runway.readthedocs.io/page/developers/contributing.html +[documentation]: https://runway.readthedocs.io +[getting started]: https://runway.readthedocs.io/page/developers/getting_started.html diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 286daf76c..97ca1c446 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -38,7 +38,7 @@ -- [ ] Have you followed the guidelines in our [Contribution Requirements](https://docs.onica.com/projects/runway/page/developers/contributing.html)? +- [ ] Have you followed the guidelines in our [Contribution Requirements](https://runway.readthedocs.io/page/developers/contributing.html)? - [ ] Have you checked to ensure there aren't other open [Pull Requests](../../../pulls) for the same update/change? - [ ] Does your submission pass tests? - [ ] Have you linted your code locally prior to submission? diff --git a/README.md b/README.md index cfbaff764..8b13a586f 100644 --- a/README.md +++ b/README.md @@ -94,6 +94,6 @@ $ poetry run runway new ## Documentation -See the [doc site](https://docs.onica.com/projects/runway) for full documentation. +See the [doc site](https://runway.readthedocs.io) for full documentation. -Quickstart documentation, including CloudFormation templates and walkthrough can be found [here](https://docs.onica.com/projects/runway/page/quickstart/index.html) +Quickstart documentation, including CloudFormation templates and walkthrough can be found [here](https://runway.readthedocs.io/page/quickstart/index.html) diff --git a/docs/source/getting_started.rst b/docs/source/getting_started.rst index 9be7d45f8..e8360a480 100644 --- a/docs/source/getting_started.rst +++ b/docs/source/getting_started.rst @@ -134,7 +134,7 @@ Deploying Your First Module :caption: runway.yml --- - # See full syntax at https://docs.onica.com/projects/runway + # See full syntax at https://runway.readthedocs.io deployments: - modules: - nameofmyfirstmodulefolder @@ -155,7 +155,7 @@ Deploying Your First Module :caption: runway.yml --- - # See full syntax at https://docs.onica.com/projects/runway + # See full syntax at https://runway.readthedocs.io deployments: - modules: - sampleapp.cfn diff --git a/pyproject.toml b/pyproject.toml index d9dba4a65..a1cab38a5 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -16,7 +16,7 @@ classifiers = [ "Topic :: Utilities", ] description = "Simplify infrastructure/app testing/deployment" -documentation = "https://docs.onica.com/projects/runway" +documentation = "https://runway.readthedocs.io" homepage = "https://github.com/onicagroup/runway" keywords = ["cli"] license = "Apache-2.0" diff --git a/runway/_cli/commands/_docs.py b/runway/_cli/commands/_docs.py index b6a40e321..9c4e8f8f6 100644 --- a/runway/_cli/commands/_docs.py +++ b/runway/_cli/commands/_docs.py @@ -15,7 +15,7 @@ LOGGER = cast("RunwayLogger", logging.getLogger(__name__.replace("._", "."))) -DOCS_URL = "https://docs.onica.com/projects/runway/" +DOCS_URL = "https://runway.readthedocs.io/" @click.command("docs", short_help="open doc site") diff --git a/runway/_cli/commands/_new.py b/runway/_cli/commands/_new.py index e09aa4c1c..de397a4f2 100644 --- a/runway/_cli/commands/_new.py +++ b/runway/_cli/commands/_new.py @@ -15,7 +15,7 @@ LOGGER = cast("RunwayLogger", logging.getLogger(__name__.replace("._", "."))) RUNWAY_YML = """--- -# See full syntax at https://docs.onica.com/projects/runway +# See full syntax at https://runway.readthedocs.io deployments: - modules: - path: sampleapp.cfn @@ -44,5 +44,5 @@ def new(ctx: click.Context, **_: Any) -> None: LOGGER.success("runway.yml generated") LOGGER.notice( "See addition getting started information at " - "https://docs.onica.com/projects/runway/page/getting_started.html" + "https://runway.readthedocs.io/page/getting_started.html" ) diff --git a/runway/_cli/main.py b/runway/_cli/main.py index 0250008b3..54470636e 100644 --- a/runway/_cli/main.py +++ b/runway/_cli/main.py @@ -65,7 +65,7 @@ def __parse_global_options(ctx: click.Context) -> dict[str, Any]: def cli(ctx: click.Context, **_: Any) -> None: """Runway CLI. - Full documentation available at https://docs.onica.com/projects/runway/ + Full documentation available at https://runway.readthedocs.io/ """ opts = ctx.meta["global.options"] diff --git a/runway/cfngin/blueprints/base.py b/runway/cfngin/blueprints/base.py index 5f90d9063..d9da75435 100644 --- a/runway/cfngin/blueprints/base.py +++ b/runway/cfngin/blueprints/base.py @@ -343,7 +343,7 @@ def __init__( "deprecated PARAMETERS or " "LOCAL_PARAMETERS, rather than VARIABLES. " "Please update your blueprints. See " - "https://docs.onica.com/projects/runway/page/cfngin/blueprints.html#variables " + "https://runway.readthedocs.io/page/cfngin/blueprints.html#variables " "for additional information." ) diff --git a/runway/utils/__init__.py b/runway/utils/__init__.py index a70560561..dc202d92f 100644 --- a/runway/utils/__init__.py +++ b/runway/utils/__init__.py @@ -37,7 +37,7 @@ from ..compat import Self AWS_ENV_VARS = ("AWS_ACCESS_KEY_ID", "AWS_SECRET_ACCESS_KEY", "AWS_SESSION_TOKEN") -DOC_SITE = "https://docs.onica.com/projects/runway" +DOC_SITE = "https://runway.readthedocs.io" EMBEDDED_LIB_PATH = str(Path(__file__).resolve().parent / "embedded") LOGGER = logging.getLogger(__name__) diff --git a/tests/integration/cli/commands/test_docs.py b/tests/integration/cli/commands/test_docs.py index 9e5f6bc6c..b98c5d56e 100644 --- a/tests/integration/cli/commands/test_docs.py +++ b/tests/integration/cli/commands/test_docs.py @@ -12,7 +12,7 @@ if TYPE_CHECKING: from unittest.mock import MagicMock -DOCS_URL = "https://docs.onica.com/projects/runway/" +DOCS_URL = "https://runway.readthedocs.io/" @patch("click.launch") diff --git a/tests/integration/cli/commands/test_new.py b/tests/integration/cli/commands/test_new.py index da77ab412..a56271a78 100644 --- a/tests/integration/cli/commands/test_new.py +++ b/tests/integration/cli/commands/test_new.py @@ -32,7 +32,7 @@ def test_new(cd_tmp_path: Path, caplog: pytest.LogCaptureFixture) -> None: assert caplog.messages == [ "runway.yml generated", "See addition getting started information at " - "https://docs.onica.com/projects/runway/page/getting_started.html", + "https://runway.readthedocs.io/page/getting_started.html", ]