Skip to content

Commit

Permalink
update documentation URLs to reflect EoL of onica.com (#2484)
Browse files Browse the repository at this point in the history
  • Loading branch information
ITProKyle authored Aug 14, 2024
1 parent 6add741 commit 1ae271f
Show file tree
Hide file tree
Showing 12 changed files with 17 additions and 17 deletions.
6 changes: 3 additions & 3 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@

<!-- You can erase any parts of this template not applicable to your Pull Request. -->

- [ ] 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?
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
4 changes: 2 additions & 2 deletions docs/source/getting_started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
2 changes: 1 addition & 1 deletion runway/_cli/commands/_docs.py
Original file line number Diff line number Diff line change
Expand Up @@ -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")
Expand Down
4 changes: 2 additions & 2 deletions runway/_cli/commands/_new.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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"
)
2 changes: 1 addition & 1 deletion runway/_cli/main.py
Original file line number Diff line number Diff line change
Expand Up @@ -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"]
Expand Down
2 changes: 1 addition & 1 deletion runway/cfngin/blueprints/base.py
Original file line number Diff line number Diff line change
Expand Up @@ -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."
)

Expand Down
2 changes: 1 addition & 1 deletion runway/utils/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -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__)
Expand Down
2 changes: 1 addition & 1 deletion tests/integration/cli/commands/test_docs.py
Original file line number Diff line number Diff line change
Expand Up @@ -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")
Expand Down
2 changes: 1 addition & 1 deletion tests/integration/cli/commands/test_new.py
Original file line number Diff line number Diff line change
Expand Up @@ -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",
]


Expand Down

0 comments on commit 1ae271f

Please sign in to comment.