Skip to content

Commit

Permalink
Updated docs, updated README with link to docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ErikBjare committed Jul 5, 2016
1 parent ce71546 commit c2acb07
Show file tree
Hide file tree
Showing 7 changed files with 61 additions and 5 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
ActivityWatch
=============

***For details, check out the website at [activitywatch.github.io](http://activitywatch.github.io)!***
**Website:** [activitywatch.github.io](http://activitywatch.github.io)

This repo is a bundle of the core components and official modules of ActivityWatch.
**Documentation:** [activitywatch.readthedocs.io](http://activitywatch.readthedocs.io)

It's primary use is as a meta-package providing all the components in one repo for easier packaging and installation.
This repo is a bundle of the core components and official modules of ActivityWatch, it is also where releases of the full suite are published.

**NOTE:** While we aim to make every commit here have full compatibility between modules, we can't leave any guarantees. In the future we hope to supply stable releases but at this stage it would be premature.
It's primary use is as a meta-package providing all the components in one repo; enabling easier packaging and installation.


## Other uses
Expand Down
2 changes: 2 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -130,6 +130,8 @@
import sphinx_rtd_theme
html_theme = 'sphinx_rtd_theme'
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
html_theme_options = {'collapse_navigation': True}
using_rtd_theme = True

# The name for this set of Sphinx documents.
# "<project> v<release> documentation" by default.
Expand Down
14 changes: 14 additions & 0 deletions docs/filtering-data.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
Filtering data
==============

Feature: Planned

ActivityWatch was born out of a frustration with the privacy issues of existing life logging solutions.
We feel that it's important that nothing gets logged that shouldn't be logged. This way the cost of data breach is bounded, and the barrier to sharing your own data for scientific purposes uses will hopefully become smaller.

This is expected to be almost impossible to perfect since what someone considers sensitive might not be for someone else (due to e.g. culture and law). But the basics are easy to get right: such as not logging private browser tabs by default.

For the ones who believe they can adequately protect their data, the option should will course be available to disable this filter.

Pausing logging is likely to get implemented before this, so if it's available and this feature isn't: Use it until we get this done.

2 changes: 2 additions & 0 deletions docs/getting-started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ Getting started

Short introductory text should go here.

Content from aw-server/README.md should be moved here.

Installation
------------

Expand Down
21 changes: 20 additions & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,18 +8,37 @@ Welcome to the ActivityWatch documentation!

Contents:

.. _user-docs:
.. toctree::
:maxdepth: 2
:caption: User documentation

intro
getting-started
storing-data


.. _feature-docs:
.. toctree::
:maxdepth: 2
:caption: Feature documentation

user-interface
pausing-watching
filtering-data



.. _dev-docs:
.. toctree::
:maxdepth: 2
:caption: Developer documentation

development
modules
api



Indices and tables
==================

Expand Down
9 changes: 9 additions & 0 deletions docs/pausing-watching.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
Pausing logging
===============

Feature status: Planned

The possibility to pause logging is a low-tech solution to filter sensitive data.
It could most easily be implemented by instructing a watcher to simply stop logging,
such functionality might be made universal to the client libraries which would in turn
filter out all events from the pause command to the resume command.
10 changes: 10 additions & 0 deletions docs/storing-data.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
Storing data
============

The server part of ActivityWatch, aw-server, by default comes with a few methods of storing data. As of 0.1.1 the default is the JSON store which simply stores each bucket in it's own JSON file.

Other methods include:

- MongoDB
- In-memory (non-persistent, useful in testing)

0 comments on commit c2acb07

Please sign in to comment.