Permalink
Browse files

Strip out cookbook stuff.

  • Loading branch information...
1 parent 4076987 commit 55bb73b12634ea42c0b556a3efe1564e66c01a0e @onyxfish onyxfish committed Jul 25, 2012
Showing with 10 additions and 232 deletions.
  1. +1 −0 .gitignore
  2. +9 −25 docs/index.rst
  3. +0 −22 docs/search_subscriptions.rst
  4. +0 −66 docs/searching_data.rst
  5. +0 −26 docs/searching_datasets.rst
  6. +0 −45 docs/uploading.rst
  7. +0 −48 docs/user_introduction.rst
View
@@ -15,3 +15,4 @@ coverage_html
.coverage
celerybeat-schedule.db
_site
+*.bak
View
@@ -15,25 +15,12 @@ The PANDA Project is `2011 Knight News Challenge winner <http://www.knightfounda
Logistical support and fiscal agency for PANDA have been provided by `Investigative Reporters and Editors <http://www.ire.org/>`_. Our sincere thanks to them helping make it a reality.
-Documentation for reporters
-===========================
+.. note::
-.. toctree::
- :maxdepth: 1
-
- user_introduction.rst
- uploading.rst
- searching_data.rst
- searching_datasets.rst
- search_subscriptions.rst
-
-**Questions?** Ask them on our `User group <http://bit.ly/pandagroup>`_!
-
-Documentation for editors
-=========================
+ **Are you a reporter?** Documentation for users can be found at the `PANDA Project Cookbook <http://pandaproject.github.com/>`_.
What is PANDA?
---------------
+==============
PANDA is:
@@ -53,11 +40,8 @@ PANDA is *not*:
See our :doc:`Frequently Asked Questions (FAQ) <faq>` for much more.
-Documentation for adminstrators
-===============================
-
Setup
------
+=====
.. toctree::
:maxdepth: 1
@@ -66,7 +50,7 @@ Setup
production.rst
Configuration
--------------
+=============
.. toctree::
:maxdepth: 1
@@ -76,8 +60,8 @@ Configuration
Performance <performance.rst>
Secure connections (SSL) <ssl.rst>
-Usage
------
+Administration
+==============
.. toctree::
:maxdepth: 1
@@ -87,7 +71,7 @@ Usage
API Keys <api_keys.rst>
Server maintenance
-------------------
+==================
.. toctree::
:maxdepth: 1
@@ -99,7 +83,7 @@ Server maintenance
Upgrades <upgrades.rst>
Extending PANDA
----------------
+===============
.. toctree::
:maxdepth: 1
@@ -1,22 +0,0 @@
-=============================
-Subscribing to search results
-=============================
-
-PANDA makes it possible to subscribe to a search so that you will be notified whenever new data appears which matches your query. For example, if you subscribed to a search for "John Doe" then when a new dataset of homicides was uploaded you would get a notification showing the rows for unidentified victims.
-
-.. figure:: images/panda-subscribe-all.png
-
-You may also subscribe to a search within a specific dataset.
-
-.. figure:: images/panda-subscribe-dataset.png
-
-Subscriptions also work for category searches, those with complex operators and individual column searches. To subscribe to a search click the *Subscribe to search results* button at the top of any search reusults page.
-
-.. note::
-
- Search subscriptions are executed overnight, *not* when the new data is uploaded. You will receive your notifications early in the AM.
-
- If you have email enabled these notifications will be delivered through email, otherwise you can access them via the notifications dropdown in the toolbar across the top of your PANDA.
-
-You can managed your subscribed searches on your User page. Just click your email address in the toolbar at the top of your PANDA.
-
View
@@ -1,66 +0,0 @@
-============
-Finding data
-============
-
-PANDA provides to important ways of searching for data. From the "Search" page you can search across data in all datasets that have been uploaded to PANDA. This is typically used for research. From an individual dataset's page you can search the data for just that one dataset. This is appropriate if you are looking for a very specific row or rows of data.
-
-Searching across all datasets
-=============================
-
-To search across all datasets click the "Search" link from the navigation bar across the top of the screen. (This is also the default homepage for PANDA.) You will see a search form at the top of the page.
-
-.. figure:: images/panda-search.png
-
-Enter your search keywords. The more detailed your search, the fewer results you should expect to get. Keep in mind that the order of the terms doesn't matter, so if you are searching for a particular individual you can input the name as "first last" or "last first" without affecting the results.
-
-PANDA can not know about variations in terms, such as plurals or mispellings. (Though it will attempt to automatically match nicknames!) If you need to search for such variations you will want to consult the advanced search features. Hover your mouse over the word "Advanced" for details.
-
-As an example, searching for ``doe AND (jon OR john OR jane)`` will (barring typos) find all John and Jane Doe's in any dataset.
-
-Once you have your query constructed click the "Search" button. On the resulting page you will see a list of datasets that had matching data, with some example rows from each. If there are more results than could be displayed in the preview there will be a "View more results from this dataset" link that will take you to complete search within that specific dataset.
-
-Searching all data within a category
-====================================
-
-You can also search across just those datasets within specific category. This functions exactly like the search described in the previous section except that you will also want to select a category from the drop down immediately to the left of the search box. (Displaying "All" in the image above.) Only datasets within the selected category will be searched.
-
-There is currently no way to search across more than one category at a time.
-
-Searching within a single dataset
-=================================
-
-To search across a specific dataset visit its details page. At the top of that page you will see a search box.
-
-.. figure:: images/panda-dataset-search.png
-
-This search field functions identically to the universal search function described above, with the exception that it only searches within a single dataset. For details of how to use advanced search syntax or to search specific columns, click the "More search options" link.
-
-To learn how to search *for datasets*, rather than data, read :doc:`searching_datasets`.
-
-Searching specific columns of data within a dataset
-===================================================
-
-PANDA makes it possible to search within specific columns of data within a dataset. When this feature is enabled you will be able to search a column's data in a way that is natural for its "type". For instance, in a column of whole numbers can be search for values "greater than 100". A columns of dates can be searched for only those in a specific year.
-
-Enabling column search
-----------------------
-
-Because per-column search requires additional processing and storage, it is not enabled for any columns by default. (For very large datasets you should consult with your administrator before you enable it.) In order to enable column search visit your dataset's details page and select "Enable column search" from the **Actions** menu.
-
-.. figure:: images/panda-enable-column-search.png
-
-In the window which appears check the "Enabled?" checkbox for each column that you want to be able to search. PANDA will make an effort to guess the "Data type" for each column, but you should verify these are what you expect and correct them if not. Once you've made your selections, click **Make columns searchable**.
-
-.. figure:: images/panda-enable-column-search2.png
-
-This will cause your dataset to be reindexed with the new columns enabled for search.
-
-Searching within a column
--------------------------
-
-Once your dataset has finished reindexing you will be able to search a column by clicking the "More search options" link and then selecting the column name from the "Pick a column..." dropdown. The resulting search options will vary depending on the type of the column. In the following image a decimal number column called "02" (referring to the second period of test results) is searched for scores "greater than or equal to" 90.
-
-.. figure:: images/panda-column-search.png
-
-Multiple columns can be searched at once and these can be combined with a normal full-text search. Any column indexed as "Text" will also support the same advanced search operations as the normal search.
-
@@ -1,26 +0,0 @@
-================
-Finding datasets
-================
-
-In addition to searching for rows of data within datasets, PANDA can also be used to search for datasets themselves. Once found datasets can be exported to CSV or the original files can be redownloaded.
-
-Searching for a dataset
-=======================
-
-To search for a dataset click the "Find a Dataset" link in the navigation bar at the top of the page. A dropdown will appear from which you can choose to search all datasets or only those within a specific category.
-
-.. figure:: images/panda-find-dataset.png
-
-Once you've made a selection you'll find yourself on the dataset search page. This search form works exactly the same as :doc:`the one you use for searching data <searching_data>`, except in this case we are searching the information *about* the datasets, rather than the data within them.
-
-Please note that *all* information shown in the results table is searchable, including the column names. For information on advanced search features hover your mouse over the "Advanced" link.
-
-Getting data out
-================
-
-Once you've found a dataset you may wish to download it from of PANDA for further analysis. There are two possible ways of doing this--downloading the original file that was uploaded or exporting the dataset.
-
-If you want the file that was originally uploaded to PANDA, simply click the name of the file on the dataset's detail page. It will begin downloading immediately.
-
-If the dataset in PANDA has multiple data files uploaded or has been modified via the API, you may wish to download the current version of the complete dataset. To do this click the "Actions" dropdown on its details page and then select "Export to CSV". This process may take some time. A link to the exported file will be emailed to you when the export is complete.
-
View
@@ -1,45 +0,0 @@
-=======================
-Uploading your datasets
-=======================
-
-The most important thing that you can do with PANDA is upload your datasets to it. By doing so you not only ensure they are securely stored away, but also allow everyone in your newsroom to access that data on their own.
-
-Selecting a file
-================
-
-To upload data to PANDA first click "Upload" on the navigation bar that runs along the top of the screen. You will be presented with an upload form that looks like this:
-
-.. figure:: images/panda-upload.png
-
-Click the "Choose File" button and find your dataset on your local computer. You can upload both CSV and Excel (.xls, .xlsx) files into PANDA.
-
-Depending on the type of file you have selected PANDA may prompt you with some additional questions. Do your best to answer these and then click "Begin upload". Your file is now uploading to PANDA. Depending on how large it is and the speed of your connection this could take anywhere for a few seconds to several hours.
-
-Previewing your data
-====================
-
-Once your file has finished uploading you will see a preview of your data, like this:
-
-.. figure:: images/panda-preview.png
-
-Please note that you may need to scroll left and right in the preview table to see all of your data. You should verify that the data appears how you expect it to. If you realize that this isn't the data you wanted to upload or that it requires some cleanup before importing, you can click "Start over" delete the data and restart the upload process.
-
-If the data is acceptable click "Continue".
-
-Adding details about your dataset
-=================================
-
-Your dataset will now begin importing and you will be taken to the dataset's new details page. A notification will alert you that the data is importing. (Unless your dataset is very small, in which case it might already be done when you reach this page!)
-
-.. figure:: images/panda-importing.png
-
-On the dataset details page you can see all the information about your newly uploaded dataset, including some sample data. From here you can also upload any related files (such as FOIA documentation) and perform other tasks. While your data is importing the most important thing you can do is give it a proper title and description. You can do this by clicking on the "Actions" dropdown and selecting "Edit".
-
-.. figure:: images/panda-dataset.png
-
-In the Edit window you can give your dataset a better **Name**, add a detailed **Description** and assign it to any appropriate **Categories** your administrator has created. Please note that all information in these fields is searchable, so it's very valuable to add relevant details to the **Description** field, such as the extent of the dataset or how it was acquired.
-
-That's it! Your dataset will continue to import on its own. If your administrator has configured email you will receive an email when it is finished. If not the "Notifications" counter in the upper-right of your PANDA window will turn blue.
-
-To learn how to search your data read :doc:`searching_data`.
-
View
@@ -1,48 +0,0 @@
-=================
-Welcome to PANDA!
-=================
-
-.. figure:: images/high-five.jpg
-
-If you're reading this documentation is probably because your organization has started using PANDA to manage its newsroom data. As a journalist you're bound to be skeptical of this new system. This brief introduction will introduce you to PANDA and show you how it can save you time, keep your data safe and improve the quality of your reporting. More detailed descriptions of the features of PANDA can be found in sections following the introduction.
-
-What is PANDA?
-==============
-
-First and foremost PANDA is a "data library", which means that it stores all the datasets you work with on a daily basis--voter registration records, police reports, water test results, etc. When you upload your data to PANDA it's stored safely away so that it can be easily found again, either by yourself or by another reporter in your organization.
-
-PANDA is also a search engine. By uploading your datasets to PANDA you make them searchable by everyone in your organization. This search feature is designed to work like Google, so you don't need to learn a new way of exploring the data.
-
-How does PANDA help me?
-=======================
-
-**PANDA will save you time**
-
-When all your data is stored in PANDA, all your data is just a quick search away. No more opening Excel and scrolling, scrolling, scrolling to find one piece of information. PANDA is fast and it is always available. Giving data to your PANDA now and it will save you time on deadline.
-
-**PANDA will keep your data safe**
-
-Never again will you have to worry about a crashing computer, a lost thumb drive or a scratched CD. Give your data to PANDA and PANDA will keep it safe. Even more importantly, since PANDA is fully searchable, you will always be able to find it again.
-
-**PANDA will improve your reporting**
-
-PANDA encourages serendipity in the reporting process. By having access to all the newsworthy data in your newsroom you will uncover information you might have otherwise overlooked. For instance, a search for the name of a state senator might return a dataset of his political affiliations, a record of his graduation, a list of bills he has sponsored and that he has a brother who is an energy lobbyist.
-
-How does PANDA help my organization?
-====================================
-
-By providing a single place to store all the data reporters work with, PANDA will encourage knowledge sharing, prevent the loss of data and slow information attrition when reporters retire or change jobs. In particular we hope to eliminate the situation where more than one reporter is using FOIA or other channels to acquire the same dataset.
-
-Tell me more!
-=============
-
-Read more on the following subjects:
-
-.. toctree::
- :maxdepth: 1
-
- uploading.rst
- searching_data.rst
- searching_datasets.rst
- search_subscriptions.rst
-

0 comments on commit 55bb73b

Please sign in to comment.