From cd47f60f7718361b7bbfa921091aa41969a41d2f Mon Sep 17 00:00:00 2001 From: Shireen Kheradpey Date: Mon, 2 Nov 2020 10:21:13 -0500 Subject: [PATCH] Site now live at klio.io and docs now live at docs.klio.io (#108) --- CONTRIBUTING.rst | 2 +- README.rst | 12 ++++++------ audio/README.rst | 7 +++++-- cli/README.rst | 4 ++-- .../commands/job/utils/templates/README.md.tpl | 2 +- .../job/utils/templates/transforms-batch.py.tpl | 4 ++-- .../commands/job/utils/templates/transforms.py.tpl | 4 ++-- .../commands/job/utils/fixtures/expected/README.md | 2 +- .../job/utils/fixtures/expected/transforms-batch.py | 4 ++-- .../job/utils/fixtures/expected/transforms.py | 4 ++-- core/README.rst | 6 +++--- devtools/README.rst | 2 +- examples/audio_spectrograms/README.rst | 2 +- examples/catvdog/README.rst | 2 +- examples/snippets/README.rst | 2 +- examples/snippets/custom_ext_checks.py | 2 +- exec/README.rst | 4 ++-- lib/README.rst | 6 +++--- microsite/index.html | 7 ++++--- 19 files changed, 41 insertions(+), 37 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index da08868a..e4c3de97 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -257,7 +257,7 @@ Then navigate to ``http://localhost:8888`` in your browser. Microsite --------- -The Klio `microsite/landing page `_ is a simple static site that uses `Bootstrap 4.5 `_. +The Klio `microsite/landing page `_ is a simple static site that uses `Bootstrap 4.5 `_. For now, it is not managed by any tooling (npm, gulp, etc); HTML, CSS, etc is maintained by hand. diff --git a/README.rst b/README.rst index ce327c64..3a88b686 100644 --- a/README.rst +++ b/README.rst @@ -10,7 +10,7 @@ :alt: Apache Licensed .. image:: https://readthedocs.org/projects/klio/badge/?version=latest - :target: https://klio.readthedocs.io/en/latest/?badge=latest + :target: https://docs.klio.io/en/latest/?badge=latest :alt: Documentation Status .. image:: https://slackin.spotify.com/badge.svg @@ -58,12 +58,12 @@ Klio was built by Spotify to run our large-scale :violetemph:`audio intelligence .. end-intro -Read more about Klio `here `_. +Read more about Klio `here `_. Get Started ----------- -Check out our `Quick Start `_ guide on how to start using Klio. +Check out our `Quick Start `_ guide on how to start using Klio. Resources @@ -71,10 +71,10 @@ Resources .. start-resources -* Have a look at our `complete documentation `_. -* Check out our `contributors' guide `_. +* Have a look at our `complete documentation `_. +* Check out our `contributors' guide `_. * Join the ``#klio`` channel in the `Spotify FOSS Slack organization `_. -* Read up on some of our `FAQs `_. +* Read up on some of our `FAQs `_. * Review our `Code of Conduct `_ - this is how we roll. .. end-resources diff --git a/audio/README.rst b/audio/README.rst index 76954d49..1f50e952 100644 --- a/audio/README.rst +++ b/audio/README.rst @@ -18,8 +18,11 @@ The ``klio-audio`` Library To make use of ``klio-audio``, add ``klio[audio]`` in your ``job-requirements.txt`` file so that it is installed in your job's Docker image. -As the ``klio-audio`` library is not meant to be installed directly, check out the `installation guide `_ for how to setup installation. -There is also the `user guide `_ and the `API documentation `_ for more information. +As the ``klio-audio`` library is not meant to be installed directly, check out the `installation +guide `_ for how to setup +installation. +There is also the `user guide `_ and the `API +documentation `_ for more information. .. _GCS: https://cloud.google.com/storage/docs diff --git a/cli/README.rst b/cli/README.rst index f81e5bf7..bf9dbe34 100644 --- a/cli/README.rst +++ b/cli/README.rst @@ -15,5 +15,5 @@ The ``klio-cli`` The CLI is the main entrypoint for users in interacting with a Klio job. This CLI is used for creating, deploying, testing, and profiling of Klio jobs, among other helpful commands. -Check out the `installation guide `_ for how to setup installation. -There is also the `user guide `_ and the `API documentation `_ for more information. +Check out the `installation guide `_ for how to setup installation. +There is also the `user guide `_ and the `API documentation `_ for more information. diff --git a/cli/src/klio_cli/commands/job/utils/templates/README.md.tpl b/cli/src/klio_cli/commands/job/utils/templates/README.md.tpl index 9611f01c..35ea8e9f 100644 --- a/cli/src/klio_cli/commands/job/utils/templates/README.md.tpl +++ b/cli/src/klio_cli/commands/job/utils/templates/README.md.tpl @@ -6,4 +6,4 @@ This `README.md` has been automatically generated via `klio job create`. You may Please see the [Klio installation & quick start documentation][klio_docs] for how to get started. -[klio_docs]: https://klio.readthedocs.io/en/latest/quickstart/index.html +[klio_docs]: https://docs.klio.io/en/latest/quickstart/index.html diff --git a/cli/src/klio_cli/commands/job/utils/templates/transforms-batch.py.tpl b/cli/src/klio_cli/commands/job/utils/templates/transforms-batch.py.tpl index d603b69f..337856d5 100644 --- a/cli/src/klio_cli/commands/job/utils/templates/transforms-batch.py.tpl +++ b/cli/src/klio_cli/commands/job/utils/templates/transforms-batch.py.tpl @@ -20,10 +20,10 @@ class HelloKlio(beam.DoFn): log + drop the Klio message. For information on the Klio message, see - https://klio.readthedocs.io/en/latest/userguide/pipeline/message.html + https://docs.klio.io/en/latest/userguide/pipeline/message.html For information on yielding other information other than ``data``, see - https://klio.readthedocs.io/en/latest/userguide/pipeline/state.html + https://docs.klio.io/en/latest/userguide/pipeline/state.html Args: data (KlioMessage.data): The data of the Klio message, which diff --git a/cli/src/klio_cli/commands/job/utils/templates/transforms.py.tpl b/cli/src/klio_cli/commands/job/utils/templates/transforms.py.tpl index 592063dd..0f5acb75 100644 --- a/cli/src/klio_cli/commands/job/utils/templates/transforms.py.tpl +++ b/cli/src/klio_cli/commands/job/utils/templates/transforms.py.tpl @@ -20,10 +20,10 @@ class HelloKlio(beam.DoFn): log + drop the Klio message. For information on the Klio message, see - https://klio.readthedocs.io/en/latest/userguide/pipeline/message.html + https://docs.klio.io/en/latest/userguide/pipeline/message.html For information on yielding other information other than ``data``, see - https://klio.readthedocs.io/en/latest/userguide/pipeline/state.html + https://docs.klio.io/en/latest/userguide/pipeline/state.html Args: data (KlioMessage.data): The data of the Klio message, which diff --git a/cli/tests/commands/job/utils/fixtures/expected/README.md b/cli/tests/commands/job/utils/fixtures/expected/README.md index dbc6edc6..3bd47325 100644 --- a/cli/tests/commands/job/utils/fixtures/expected/README.md +++ b/cli/tests/commands/job/utils/fixtures/expected/README.md @@ -6,4 +6,4 @@ This `README.md` has been automatically generated via `klio job create`. You may Please see the [Klio installation & quick start documentation][klio_docs] for how to get started. -[klio_docs]: https://klio.readthedocs.io/en/latest/quickstart/index.html \ No newline at end of file +[klio_docs]: https://docs.klio.io/en/latest/quickstart/index.html \ No newline at end of file diff --git a/cli/tests/commands/job/utils/fixtures/expected/transforms-batch.py b/cli/tests/commands/job/utils/fixtures/expected/transforms-batch.py index d603b69f..337856d5 100644 --- a/cli/tests/commands/job/utils/fixtures/expected/transforms-batch.py +++ b/cli/tests/commands/job/utils/fixtures/expected/transforms-batch.py @@ -20,10 +20,10 @@ def process(self, data): log + drop the Klio message. For information on the Klio message, see - https://klio.readthedocs.io/en/latest/userguide/pipeline/message.html + https://docs.klio.io/en/latest/userguide/pipeline/message.html For information on yielding other information other than ``data``, see - https://klio.readthedocs.io/en/latest/userguide/pipeline/state.html + https://docs.klio.io/en/latest/userguide/pipeline/state.html Args: data (KlioMessage.data): The data of the Klio message, which diff --git a/cli/tests/commands/job/utils/fixtures/expected/transforms.py b/cli/tests/commands/job/utils/fixtures/expected/transforms.py index 592063dd..0f5acb75 100644 --- a/cli/tests/commands/job/utils/fixtures/expected/transforms.py +++ b/cli/tests/commands/job/utils/fixtures/expected/transforms.py @@ -20,10 +20,10 @@ def process(self, data): log + drop the Klio message. For information on the Klio message, see - https://klio.readthedocs.io/en/latest/userguide/pipeline/message.html + https://docs.klio.io/en/latest/userguide/pipeline/message.html For information on yielding other information other than ``data``, see - https://klio.readthedocs.io/en/latest/userguide/pipeline/state.html + https://docs.klio.io/en/latest/userguide/pipeline/state.html Args: data (KlioMessage.data): The data of the Klio message, which diff --git a/core/README.rst b/core/README.rst index d4858cd1..3f2f8f68 100644 --- a/core/README.rst +++ b/core/README.rst @@ -11,7 +11,7 @@ The ``klio-core`` Package .. start-klio-core-intro -A library of common utilities, including the Klio `protobuf definitions `_ and configuration parsing. +A library of common utilities, including the Klio `protobuf definitions `_ and configuration parsing. -As the ``klio-core`` package is not meant to be installed directly, check out the `installation guide `_ for how to setup installation. -There is also the `user guide `_ and the `API documentation `_ for more information. +As the ``klio-core`` package is not meant to be installed directly, check out the `installation guide `_ for how to setup installation. +There is also the `user guide `_ and the `API documentation `_ for more information. diff --git a/devtools/README.rst b/devtools/README.rst index 43054630..5d4c6f46 100644 --- a/devtools/README.rst +++ b/devtools/README.rst @@ -18,4 +18,4 @@ The ``klio-devtools`` Package A collection of utilities to help aid the development of Klio. This is meant to be used by :violetemph:`developers` and :violetemph:`contributors` of Klio, not by users for Klio jobs. -If you're interested in contributing to Klio, please check out our `contributor's guide `_. +If you're interested in contributing to Klio, please check out our `contributor's guide `_. diff --git a/examples/audio_spectrograms/README.rst b/examples/audio_spectrograms/README.rst index 073d1a4c..2033eff5 100644 --- a/examples/audio_spectrograms/README.rst +++ b/examples/audio_spectrograms/README.rst @@ -9,5 +9,5 @@ This example adapts the `librosa `_ `example for separating vocals from instrumental, and then generates and saves spectrograms based off of the separated files. -Please refer to the `accompanying walk-through `_. diff --git a/examples/catvdog/README.rst b/examples/catvdog/README.rst index c10dc972..c39b19c3 100644 --- a/examples/catvdog/README.rst +++ b/examples/catvdog/README.rst @@ -4,7 +4,7 @@ Cat and Dog Image Classifier Requirements ------------ -* Follow the documented `installation instructions `_. +* Follow the documented `installation instructions `_. * Python 3.6+ Run diff --git a/examples/snippets/README.rst b/examples/snippets/README.rst index 1f9849ba..38b9d8dd 100644 --- a/examples/snippets/README.rst +++ b/examples/snippets/README.rst @@ -2,4 +2,4 @@ Snippets ======== -* Custom data existence checks (`code `_, `full walk-through `_) +* Custom data existence checks (`code `_, `full walk-through `_) diff --git a/examples/snippets/custom_ext_checks.py b/examples/snippets/custom_ext_checks.py index 8037d6e0..37d2b998 100644 --- a/examples/snippets/custom_ext_checks.py +++ b/examples/snippets/custom_ext_checks.py @@ -15,7 +15,7 @@ """Example of custom data existence checks implementation. Please see the full walk-through here: -https://klio.readthedocs.io/en/latest/userguide/ +https://docs.klio.io/en/latest/userguide/ examples/custom_data_ext_checks.html """ diff --git a/exec/README.rst b/exec/README.rst index 54e68cc8..b66069ac 100644 --- a/exec/README.rst +++ b/exec/README.rst @@ -16,8 +16,8 @@ The executor – meant to not be used directly by the user – is a CLI that lau Many commands from the ``klio-cli`` directly wrap to commands in the executor: a ``klio-cli`` command will set up the Docker context needed to correctly run the pipeline via the associated command with ``klio-exec``. The Docker context includes mounting the job directory, sets up environment variables, mounting credentials, etc. -As the ``klio-exec`` package is not meant to be installed directly, check out the `installation guide `_ for how to setup installation. -There is also the `user guide `_ and the `API documentation `_ for more information. +As the ``klio-exec`` package is not meant to be installed directly, check out the `installation guide `_ for how to setup installation. +There is also the `user guide `_ and the `API documentation `_ for more information. .. _"driver": https://beam.apache.org/documentation/programming-guide/#overview diff --git a/lib/README.rst b/lib/README.rst index 9518f0d0..8b181cda 100644 --- a/lib/README.rst +++ b/lib/README.rst @@ -11,7 +11,7 @@ The ``klio`` Library .. start-klio-lib-intro -The library for implementing Klio-ified Apache Beam transforms with `decorators `_, `helper transforms `_, and leverage Klio's `message-handling logic `_. +The library for implementing Klio-ified Apache Beam transforms with `decorators `_, `helper transforms `_, and leverage Klio's `message-handling logic `_. -As the ``klio`` library is not meant to be installed directly, check out the `installation guide `_ for how to setup installation. -There is also the `user guide `_ and the `API documentation `_ for more information. +As the ``klio`` library is not meant to be installed directly, check out the `installation guide `_ for how to setup installation. +There is also the `user guide `_ and the `API documentation `_ for more information. diff --git a/microsite/index.html b/microsite/index.html index b886b71f..685e0d4d 100644 --- a/microsite/index.html +++ b/microsite/index.html @@ -25,10 +25,11 @@
- Learn More + Learn More