diff --git a/README.md b/README.md index bf6c7c9..c79307b 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,10 @@ # python_moztelemetry [![CircleCI Build Status](https://circleci.com/gh/mozilla/python_moztelemetry/tree/master.svg?style=svg)](https://circleci.com/gh/mozilla/python_moztelemetry/tree/master) [![Updates](https://pyup.io/repos/github/mozilla/python_moztelemetry/shield.svg)](https://pyup.io/repos/github/mozilla/python_moztelemetry/) [![codecov.io](https://codecov.io/github/mozilla/python_moztelemetry/coverage.svg?branch=master)](https://codecov.io/github/mozilla/python_moztelemetry?branch=master) -Spark bindings for Mozilla Telemetry +PySpark bindings for Mozilla Telemetry + +## Documentation + +Online documentation is available at https://mozilla.github.io/python_moztelemetry/ ## Deploying a code change After having your PR reviewed and merged create a new release on [github](https://help.github.com/articles/creating-releases/). diff --git a/docs/conf.py b/docs/conf.py index b8f9bb6..dd96cbf 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -55,7 +55,7 @@ # General information about the project. project = u'python_moztelemetry' -copyright = u'2016, Mozilla Firefox Data Platform' +copyright = u'Mozilla Firefox Data Platform' author = u'Mozilla Firefox Data Platform' # The version info for the project you're documenting, acts as replacement for @@ -63,9 +63,9 @@ # built documents. # # The short X.Y version. -version = u'0.3' +version = u'current' # The full version, including alpha/beta/rc tags. -release = u'0.3.9.13' +release = u'current' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. diff --git a/docs/index.rst b/docs/index.rst index 93165cb..c2d0967 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -10,6 +10,11 @@ A simple library to fetch and analyze data collected by the Mozilla Telemetry se Objects collected by Telemetry are called ``pings``. A ping has a number of properties (aka ``dimensions``) and a payload. +For example usage and additional context on how this library fits into the +broader landscape of Mozilla telemetry analysis tools, see +`moztelemetry on docs.telemetry.mozilla.org `_. +To browse the source code, see https://github.com/mozilla/python_moztelemetry + A session of Telemetry data analysis/manipulation typically starts with a :ref:`Dataset` query that filters the objects by one or more dimensions, and then extracts the items of interest from their payload.