Skip to content

Commit

Permalink
Site now live at klio.io and docs now live at docs.klio.io (spotify#108)
Browse files Browse the repository at this point in the history
  • Loading branch information
shireen-bean authored Nov 2, 2020
1 parent be0a6d4 commit cd47f60
Show file tree
Hide file tree
Showing 19 changed files with 41 additions and 37 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -257,7 +257,7 @@ Then navigate to ``http://localhost:8888`` in your browser.
Microsite
---------

The Klio `microsite/landing page <https://spotify.github.io/klio>`_ is a simple static site that uses `Bootstrap 4.5 <https://getbootstrap.com/docs/4.5/getting-started/introduction/>`_.
The Klio `microsite/landing page <https://klio.io>`_ is a simple static site that uses `Bootstrap 4.5 <https://getbootstrap.com/docs/4.5/getting-started/introduction/>`_.
For now, it is not managed by any tooling (npm, gulp, etc); HTML, CSS, etc is maintained by hand.


Expand Down
12 changes: 6 additions & 6 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -58,23 +58,23 @@ Klio was built by Spotify to run our large-scale :violetemph:`audio intelligence

.. end-intro
Read more about Klio `here <https://klio.readthedocs.io/en/latest/userguide/index.html>`_.
Read more about Klio `here <https://docs.klio.io/en/latest/userguide/index.html>`_.

Get Started
-----------

Check out our `Quick Start <https://klio.readthedocs.io/en/latest/quickstart/index.html>`_ guide on how to start using Klio.
Check out our `Quick Start <https://docs.klio.io/en/latest/quickstart/index.html>`_ guide on how to start using Klio.


Resources
---------

.. start-resources
* Have a look at our `complete documentation <https://klio.readthedocs.io/en/latest/index.html>`_.
* Check out our `contributors' guide <https://klio.readthedocs.io/en/latest/contributors.html>`_.
* Have a look at our `complete documentation <https://docs.klio.io/en/latest/index.html>`_.
* Check out our `contributors' guide <https://docs.klio.io/en/latest/contributors.html>`_.
* Join the ``#klio`` channel in the `Spotify FOSS Slack organization <https://slackin.spotify.com>`_.
* Read up on some of our `FAQs <https://klio.readthedocs.io/en/latest/faqs/index.html>`_.
* Read up on some of our `FAQs <https://docs.klio.io/en/latest/faqs/index.html>`_.
* Review our `Code of Conduct <https://github.com/spotify/klio/blob/master/CODE_OF_CONDUCT.rst>`_ - this is how we roll.

.. end-resources
7 changes: 5 additions & 2 deletions audio/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://klio.readthedocs.io/en/latest/quickstart/installation.html>`_ for how to setup installation.
There is also the `user guide <https://klio.readthedocs.io/en/latest/userguide/index.html>`_ and the `API documentation <https://klio.readthedocs.io/en/latest/reference/audio/index.html>`_ for more information.
As the ``klio-audio`` library is not meant to be installed directly, check out the `installation
guide <https://docs.klio.io/en/latest/quickstart/installation.html>`_ for how to setup
installation.
There is also the `user guide <https://docs.klio.io/en/latest/userguide/index.html>`_ and the `API
documentation <https://docs.klio.io/en/latest/reference/audio/index.html>`_ for more information.


.. _GCS: https://cloud.google.com/storage/docs
Expand Down
4 changes: 2 additions & 2 deletions cli/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://klio.readthedocs.io/en/latest/quickstart/installation.html>`_ for how to setup installation.
There is also the `user guide <https://klio.readthedocs.io/en/latest/userguide/index.html>`_ and the `API documentation <https://klio.readthedocs.io/en/latest/reference/cli/index.html>`_ for more information.
Check out the `installation guide <https://docs.klio.io/en/latest/quickstart/installation.html>`_ for how to setup installation.
There is also the `user guide <https://docs.klio.io/en/latest/userguide/index.html>`_ and the `API documentation <https://docs.klio.io/en/latest/reference/cli/index.html>`_ for more information.
Original file line number Diff line number Diff line change
Expand Up @@ -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
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion cli/tests/commands/job/utils/fixtures/expected/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions cli/tests/commands/job/utils/fixtures/expected/transforms.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 3 additions & 3 deletions core/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ The ``klio-core`` Package

.. start-klio-core-intro
A library of common utilities, including the Klio `protobuf definitions <https://klio.readthedocs.io/en/latest/userguide/pipeline/message.html>`_ and configuration parsing.
A library of common utilities, including the Klio `protobuf definitions <https://docs.klio.io/en/latest/userguide/pipeline/message.html>`_ and configuration parsing.

As the ``klio-core`` package is not meant to be installed directly, check out the `installation guide <https://klio.readthedocs.io/en/latest/quickstart/installation.html>`_ for how to setup installation.
There is also the `user guide <https://klio.readthedocs.io/en/latest/userguide/index.html>`_ and the `API documentation <https://klio.readthedocs.io/en/latest/reference/core/index.html>`_ for more information.
As the ``klio-core`` package is not meant to be installed directly, check out the `installation guide <https://docs.klio.io/en/latest/quickstart/installation.html>`_ for how to setup installation.
There is also the `user guide <https://docs.klio.io/en/latest/userguide/index.html>`_ and the `API documentation <https://docs.klio.io/en/latest/reference/core/index.html>`_ for more information.
2 changes: 1 addition & 1 deletion devtools/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://klio.readthedocs.io/en/latest/contributors.html>`_.
If you're interested in contributing to Klio, please check out our `contributor's guide <https://docs.klio.io/en/latest/contributors.html>`_.
2 changes: 1 addition & 1 deletion examples/audio_spectrograms/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,5 @@ This example adapts the `librosa <https://librosa.org/>`_ `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 <https://klio.readthedocs.io/en
Please refer to the `accompanying walk-through <https://docs.klio.io/en
/latest/userguide/examples/audio_spec.html>`_.
2 changes: 1 addition & 1 deletion examples/catvdog/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Cat and Dog Image Classifier
Requirements
------------

* Follow the documented `installation instructions <https://klio.readthedocs.io/en/latest/quickstart/installation.html>`_.
* Follow the documented `installation instructions <https://docs.klio.io/en/latest/quickstart/installation.html>`_.
* Python 3.6+

Run
Expand Down
2 changes: 1 addition & 1 deletion examples/snippets/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@ Snippets
========


* Custom data existence checks (`code <https://github.com/spotify/klio/tree/master/examples/snippets/custom_ext_checks.py>`_, `full walk-through <https://klio.readthedocs.io/en/latest/userguide/examples/custom_data_ext_checks.html>`_)
* Custom data existence checks (`code <https://github.com/spotify/klio/tree/master/examples/snippets/custom_ext_checks.py>`_, `full walk-through <https://docs.klio.io/en/latest/userguide/examples/custom_data_ext_checks.html>`_)
2 changes: 1 addition & 1 deletion examples/snippets/custom_ext_checks.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
"""

Expand Down
4 changes: 2 additions & 2 deletions exec/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://klio.readthedocs.io/en/latest/quickstart/installation.html>`_ for how to setup installation.
There is also the `user guide <https://klio.readthedocs.io/en/latest/userguide/index.html>`_ and the `API documentation <https://klio.readthedocs.io/en/latest/reference/executor/api.html>`_ for more information.
As the ``klio-exec`` package is not meant to be installed directly, check out the `installation guide <https://docs.klio.io/en/latest/quickstart/installation.html>`_ for how to setup installation.
There is also the `user guide <https://docs.klio.io/en/latest/userguide/index.html>`_ and the `API documentation <https://docs.klio.io/en/latest/reference/executor/api.html>`_ for more information.


.. _"driver": https://beam.apache.org/documentation/programming-guide/#overview
6 changes: 3 additions & 3 deletions lib/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ The ``klio`` Library

.. start-klio-lib-intro
The library for implementing Klio-ified Apache Beam transforms with `decorators <https://klio.readthedocs.io/en/latest/userguide/pipeline/utilities.html>`_, `helper transforms <https://klio.readthedocs.io/en/latest/userguide/pipeline/transforms.html>`_, and leverage Klio's `message-handling logic <https://klio.readthedocs.io/en/latest/userguide/pipeline/message.html>`_.
The library for implementing Klio-ified Apache Beam transforms with `decorators <https://docs.klio.io/en/latest/userguide/pipeline/utilities.html>`_, `helper transforms <https://docs.klio.io/en/latest/userguide/pipeline/transforms.html>`_, and leverage Klio's `message-handling logic <https://docs.klio.io/en/latest/userguide/pipeline/message.html>`_.

As the ``klio`` library is not meant to be installed directly, check out the `installation guide <https://klio.readthedocs.io/en/latest/quickstart/installation.html>`_ for how to setup installation.
There is also the `user guide <https://klio.readthedocs.io/en/latest/userguide/index.html>`_ and the `API documentation <https://klio.readthedocs.io/en/latest/reference/lib/index.html>`_ for more information.
As the ``klio`` library is not meant to be installed directly, check out the `installation guide <https://docs.klio.io/en/latest/quickstart/installation.html>`_ for how to setup installation.
There is also the `user guide <https://docs.klio.io/en/latest/userguide/index.html>`_ and the `API documentation <https://docs.klio.io/en/latest/reference/lib/index.html>`_ for more information.
7 changes: 4 additions & 3 deletions microsite/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -25,10 +25,11 @@
<div class="collapse navbar-collapse justify-content-end align-items-center" id="navbarCollapse">
<ul class="navbar-nav">
<li class="nav-item">
<a class="nav-link" href="https://github.com/spotify/klio"><button class="gradient">GitHub</button></a>
<a class="nav-link"
href="https://github.com/spotify/klio"><button class="gradient">GitHub</button></a>
</li>
<li class="nav-item">
<a class="nav-link" href="https://klio.readthedocs.io"><button class="gradient">Get Started</button></a>
<a class="nav-link" href="https://docs.klio.io"><button class="gradient">Get Started</button></a>
</li>
<li class="nav-item">
<a class="nav-link" href="https://venturebeat.com/2020/10/13/spotify-open-sources-klio-a-framework-for-ai-audio-research/"><button class="gradient">In the News</button></a>
Expand Down Expand Up @@ -87,7 +88,7 @@ <h1 class="mt-5">Smarter data pipelines for audio</h1>
</div>
<div class="container mt-5 mb-5">
<div class="row justify-content-center">
<a href="https://klio.readthedocs.io" class="btn btn-primary btn-lg get-started" role="button">Learn More</a>
<a href="https://docs.klio.io" class="btn btn-primary btn-lg get-started" role="button">Learn More</a>
</div>
</div>
<div class="shove-down"></div>
Expand Down

0 comments on commit cd47f60

Please sign in to comment.