Add a link to bugs for unfinished documents

The context link to an open bug gives the reader some recourse if they
need documentation that does not yet exist. Hopefully this helps with
prioritization.
This commit is contained in:
Ryan Harter 2017-04-20 17:05:59 -04:00
Родитель 6ecf76ad0b
Коммит 5bc9d4f33e
35 изменённых файлов: 152 добавлений и 98 удалений

Просмотреть файл

@ -4,54 +4,42 @@
* [Analysis Quick Start](concepts/analysis_intro.adoc)
* [Data Privacy](concepts/data_privacy.md)
* [Choosing a Dataset](concepts/choosing_a_dataset.md)
* [Intro to STMO / Re:dash](/tools/stmo.md)
* [Common Analysis Gotchas](concepts/analysis_gotchas.md)
* [Data Collection and Datasets](datasets/README.adoc)
* [Getting Review](concepts/review.md)
* [Data Collection and Datasets](/datasets/README.adoc)
* Understanding our Data
* Experimental vs Descriptive Data
* [Choosing a dataset](concepts/choosing_a_dataset.md)
* [Tools for Experimentation](concepts/experiment_intro.adoc)
* [Tools for Experimentation](tools/experiments.md)
* [Common Analysis Gotchas](concepts/analysis_gotchas.md)
* Sessions and Subsessions
* Dates, Timespans, & their caveats
* Profiles vs. Users
* [Dataset Reference](datasets/reference.md)
* Pings
* Opt-in vs Opt-out
* [Main Ping](concepts/main_ping_intro.md)
* Derived Datasets
* [Longitudinal](datasets/longitudinal/Longitudinal.md)
* Cross Sectional
* [Main Summary](datasets/main_summary/MainSummary.md)
* [Crash Summary](datasets/crash_summary/CrashSummary.md)
* [Crash Aggregate](datasets/crash_aggregate/CrashAggregateView.md)
* [Events](datasets/events/Events.md)
* [Sync Summary](datasets/sync_summary/SyncSummary.md)
* [Addons](datasets/addons/Addons.md)
* ETC
* [Experimental Datasets](concepts/experiment_intro.adoc)
* Accessing Shield Study data
* [Pings](datasets/pings.md)
* [Derived Datasets](datasets/derived.md)
* [Longitudinal](datasets/batch_view/Longitudinal.md)
* [Cross Sectional](datasets/batch_view/cross_sectional.md)
* [Main Summary](datasets/batch_view/MainSummary.md)
* [Crash Summary](datasets/batch_view/CrashSummary.md)
* [Crash Aggregate](datasets/batch_view/CrashAggregateView.md)
* [Events](datasets/batch_view/Events.md)
* [Sync Summary](datasets/batch_view/SyncSummary.md)
* [Addons](datasets/batch_view/Addons.md)
* [Experimental Datasets](tools/experiments.md)
* [Accessing Shield Study data](datasets/shield.md)
* [Collecting New Data](datasets/new_data.md)
* [Tools](tools/README.adoc)
* Interfaces
* TMO & STMO
* Distribution Viewer
* [Advanced analysis with ATMO](concepts/advanced_analysis_with_atmo.adoc)
* An Introduction to Spark
* Realtime Analysis with CEP
* [Interfaces](tools/interfaces.md)
* [TMO & STMO](concepts/analysis_intro.adoc)
* [Advanced analysis with ATMO](tools/advanced_analysis_with_atmo.md)
* [Creating a Real-time Analysis Plugin](cookbooks/realtime_analysis_plugin.md)
* [Distribution Viewer](tools/distribution_viewer.md)
* [HBase](tools/hbase.md)
* RTMO
* Infrastructure
* The Path to Re:dash
* Heka Messages
* telemetry-batch-view
* parquet2hive
* Airflow
* Presto
* [RTMO](tools/rtmo.md)
* [Infrastructure](tools/infrastructure.md)
* [Cookbooks](cookbooks/README.adoc)
* [Working with Parquet Data on ATMO Clusters](cookbooks/parquet.md)
* [Creating a custom re:dash dataset](cookbooks/create_a_dataset.adoc)
* [Creating a Real-time Analysis Plugin](cookbooks/realtime_analysis_plugin.md)
* [Longitudinal Examples](cookbooks/longitudinal.md)
* [Longitudinal Examples](cookbooks/longitudinal_examples.md)
* [About this Documentation](meta/README.md)

Просмотреть файл

@ -1,10 +0,0 @@
= Advanced Analysis with ATMO
== Loading Derived Datasets
// Introduces accessing Derived Datasets via S3
== Simple Analysis
// Introduces Spark
== Get Some pings
// Introduces Raw Pings

Просмотреть файл

@ -1 +1,5 @@
https://bugzilla.mozilla.org/show_bug.cgi?id=1341717
# Work in Progress
This article is under development.
The work is being tracked in
[this bug](https://bugzilla.mozilla.org/show_bug.cgi?id=1341717).

Просмотреть файл

@ -1,3 +1,9 @@
= Work in Progress
This article is under development.
The work is being tracked in
link:https://bugzilla.mozilla.org/show_bug.cgi?id=1341706[this bug].
= Getting Started with Firefox Data
This document may replace our current onboarding.

Просмотреть файл

@ -7,7 +7,7 @@ For example, this guide will help if you need to answer questions like:
how many users do we have in Germany, how many crashes we see per day,
or how many users have a given addon installed.
If you're interested in figuring out whether there's a causal link between two events
take a look at our [tools for experimentation](/concepts/experiment_intro.adoc).
take a look at our [tools for experimentation](/tools/experiments.md).
## Table of Contents
<!-- toc -->

Просмотреть файл

@ -1,3 +1,9 @@
# Work in Progress
This article is under development.
The work is being tracked in
[this bug](https://bugzilla.mozilla.org/show_bug.cgi?id=1341707)
# Data Privacy
This document will give you an overview of what types of analyses you

Просмотреть файл

@ -1,2 +0,0 @@
= Getting Started with Firefox Experiments
// Describes all available tools for running experiments over firefox users.

Просмотреть файл

@ -7,8 +7,7 @@ After these readings you should be able to produce simple analyses
but you should definitely get your analyses reviewed.
This is a six part section meant to introduce new analysts to our data.
I consider a "new analyst" to be
an existing employee
I consider a "new analyst" to be an employee
who is interested in working with our data
but doesn't have previous experience with our tools/data.
They could be technical or non-technical: engineer, PM, or data scientist.
@ -17,7 +16,7 @@ _Getting Started_ covers:
* [Analysis Quick Start](analysis_intro.adoc)- an introduction to TMO and histograms
* [Data Privacy @ Mozilla](/concepts/data_privacy.md) - what can['t] you share?
* [Choosing a Dataset](concepts/choosing_a_dataset.md)
* Intro to STMO
* Common Analysis Gotchas
* Getting Review
* [Choosing a Dataset](/concepts/choosing_a_dataset.md)
* [Intro to STMO](/tools/stmo.md)
* [Common Analysis Gotchas](/concepts/analysis_gotchas.md)
* [Getting Review](/concepts/review.md)

Просмотреть файл

@ -1,17 +0,0 @@
# An Introduction to Pings
## Client-id ~= User
## User vs Session weighting
## Types of data
* Histograms
* Scalars
* Etc
## Opt-in vs Opt-out histograms

5
concepts/review.md Normal file
Просмотреть файл

@ -0,0 +1,5 @@
# Work in Progress
This article is a work in progress.
The work is being tracked in
[this bug](https://bugzilla.mozilla.org/show_bug.cgi?id=1341710)

Просмотреть файл

@ -0,0 +1,4 @@
# Work in Progress
Work being tracked
[in this bug](https://bugzilla.mozilla.org/show_bug.cgi?id=1358210).

Просмотреть файл

@ -2,7 +2,7 @@
= Datasets and Data Collection
After completing link:concepts/choosing_a_dataset.md[Choosing A Dataset],
After completing link:/concepts/choosing_a_dataset.md[Choosing A Dataset],
you should have a high level understanding of what questions each dataset is able to answer.
This section contains a series of tutorials which will help you understand our dataset more deeply.

Просмотреть файл

@ -1,2 +0,0 @@
# Dataset Reference

Просмотреть файл

Просмотреть файл

Просмотреть файл

@ -0,0 +1,5 @@
# Work in Progress
This article is still a work in progress.
The work is being tracked in
[this bug](https://bugzilla.mozilla.org/show_bug.cgi?id=1341912)

Просмотреть файл

@ -1,21 +0,0 @@
= Cross Sectional Dataset
Test
:toc:
== What is this dataset
User focused summary stats
== How do I use it?
* Open up a new query
* Type this query in
* Horray! More complicated
* Horray! More complicated
* Conclusion
== Technical Notes
== How to augment

4
datasets/derived.md Normal file
Просмотреть файл

@ -0,0 +1,4 @@
# Derived Datasets
See [Choosing a Dataset](/concepts/choosing_a_dataset.md)
for a discussion on the differences between pings and derived datasets.

Просмотреть файл

@ -1,5 +1,9 @@
# Collecting New Data
This is a work in progress.
The work is being tracked in
[this bug](https://bugzilla.mozilla.org/show_bug.cgi?id=1341818)
This document will give a high level overview of how to add new data to our datasets.
## Pings

15
datasets/pings.md Normal file
Просмотреть файл

@ -0,0 +1,15 @@
# Work in Progress
This article is a work in progress.
The work is being tracked in
[this bug](https://bugzilla.mozilla.org/show_bug.cgi?id=1341805).
# Coverage
## Why look at pings?
## What types of data do we have?
## Opt In vs Opt Out
## How to look at pings

5
datasets/shield.md Normal file
Просмотреть файл

@ -0,0 +1,5 @@
# Work in Progress
This document is a work in progress.
The work is being tracked in
[this bug](https://bugzilla.mozilla.org/show_bug.cgi?id=1358286)

Просмотреть файл

@ -2,7 +2,6 @@
This document will teach you how to use Firefox data
to answer questions about our users.
It's hosted [here](https://mozilla.github.io/firefox-data-docs/)
## Using this document

Просмотреть файл

@ -0,0 +1,20 @@
# Work in Progress
This document is a work in progress.
The work is being tracked in
[this bug](https://bugzilla.mozilla.org/show_bug.cgi?id=1341899).
This document will be derived from
[Custom Analysis with Spark](https://wiki.mozilla.org/Telemetry/Custom_analysis_with_spark)
# Advanced Analysis with ATMO
## Loading Derived Datasets
// Introduces accessing Derived Datasets via S3
## Simple Analysis
// Introduces Spark
## Get Some pings
// Introduces Raw Pings

Просмотреть файл

@ -0,0 +1,5 @@
# Work in Progress
This document is a work in progress.
The work is being tracked in
[this bug](https://bugzilla.mozilla.org/show_bug.cgi?id=1341896).

7
tools/experiments.md Normal file
Просмотреть файл

@ -0,0 +1,7 @@
# Work in Progress
This article is a work in progress.
The work is being tracked in
[this bug](https://bugzilla.mozilla.org/show_bug.cgi?id=1341812).
# Guide to our Experimental Tools

15
tools/infrastructure.md Normal file
Просмотреть файл

@ -0,0 +1,15 @@
# Work in Progress
This document is a work in progress.
The work is being tracked in
[this bug](https://bugzilla.mozilla.org/show_bug.cgi?id=1341903)
# Notes & Ideas
* The path to re:dash
* heka messages
* telemetry-batch-view
* parquet2hive
* Airflow
* Presto

5
tools/interfaces.md Normal file
Просмотреть файл

@ -0,0 +1,5 @@
# Work in Progress
This document is a work in progress.
The work is being tracked in
[this bug](https://bugzilla.mozilla.org/show_bug.cgi?id=1341896).

5
tools/rtmo.md Normal file
Просмотреть файл

@ -0,0 +1,5 @@
# Work in Progress
This document is a work in progress.
The work is being tracked in
[this bug](https://bugzilla.mozilla.org/show_bug.cgi?id=1341896).

5
tools/stmo.md Normal file
Просмотреть файл

@ -0,0 +1,5 @@
# Work in Progress
This article is under development.
The work is being tracked
[here](https://bugzilla.mozilla.org/show_bug.cgi?id=1341709).