Skip to content

Commit

Permalink
Updating documentation to not depend on Scribd for document hosting
Browse files Browse the repository at this point in the history
  • Loading branch information
richaagarwal committed Sep 16, 2015
1 parent 5c75c7c commit 0855b0a
Show file tree
Hide file tree
Showing 15 changed files with 87 additions and 157 deletions.
3 changes: 1 addition & 2 deletions .env.example
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
ENVIRONMENT=LOCAL
APPLICATION_URL=http://127.0.0.1:5000/
HOST_URL='https://www.scribd.com/doc/'
DATABASE_URL=postgresql://localhost/recordtrac
AGENCY_NAME='Your agency name'
SECRET_KEY='change this before deploying to production'
DEFAULT_OWNER_EMAIL=citystaff@city.gov
DEFAULT_OWNER_REASON='Open records coordinator'
DAYS_TO_FULFILL=10
DAYS_AFTER_EXTENSION=14
DAYS_AFTER_EXTENSION=14
2 changes: 1 addition & 1 deletion Procfile
Original file line number Diff line number Diff line change
@@ -1 +1 @@
web: newrelic-admin run-program gunicorn -w 3 -t 360 public_records_portal.prflask:app
web: gunicorn -w 3 -t 360 public_records_portal.prflask:app
42 changes: 20 additions & 22 deletions docs/admin.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# RecordTrac's Admin Features

## Description
## Description

RecordTrac’s administrative controls allows the users to:

Expand All @@ -10,35 +10,33 @@ RecordTrac’s administrative controls allows the users to:
* [Edit or remove a question or answer](#how-to-remove-or-edit-a-question-and-answer-exchange)
* [Update your RecordTrac website text and more](#updating-website-text)

The administrative controls allows the user to permanently delete records, requests, and notes from the database. Because of this, administrative access should be restricted to a small number of users.
The administrative controls allows the user to permanently delete records, requests, and notes from the database. Because of this, administrative access should be restricted to a small number of users.


## Best Practices

Content should only be removed or edited if sensitive or confidential information is revealed. If this happens, you should:

* Edit the message to indicate why it needs to be removed.
* Edit the message to indicate why it needs to be removed.
* Notify the requester why their post or answer was removed.
* Provide guidance to the requester on how they can get the record they need.
* Provide guidance to the requester on how they can get the record they need.

If a staff member enters information incorrectly, simply add a note explaining the mistake.
If a staff member enters information incorrectly, simply add a note explaining the mistake.

If a member of the public enters incorrect information, the requester (or a staff member) can add a note correcting the mistake.
If a member of the public enters incorrect information, the requester (or a staff member) can add a note correcting the mistake.

Sometimes it’s necessary to create a new request. If a new request must be created, we suggest you do the following:

* Create a new request with the proper information.
* In the old request, include a note explaining what is wrong with it and a link to the new request.
* Close out the old request.
* In the new request, reference and/or provide a link to the old request.
* In the new request, reference and/or provide a link to the old request.

Although RecordTrac has a spam filter, every once in a while it may receive spam. When confronted with spam, close the request with a note indicating why it is not a public records request. If there is a large amount of spam requests, it is appropriate to simply remove the spam.

If a record needs to be removed. It not only has to be deleted on RecordTrac, it has to be removed from Scribd as well.
Although RecordTrac has a spam filter, every once in a while it may receive spam. When confronted with spam, close the request with a note indicating why it is not a public records request. If there is a large amount of spam requests, it is appropriate to simply remove the spam.

## How to Remove or Edit a Request

To remove or edit a request, visit `[records.youragency.gov]/admin/requestview`.
To remove or edit a request, visit `[records.youragency.gov]/admin/requestview`.

![admin_edit_request](/docs/images/admin_request.png "admin_edit_request")

Expand All @@ -53,7 +51,7 @@ Clicking on the trashcan icon permanently deletes an entire request.

![admin_delete_request](/docs/images/admin_delete_request.png "admin_delete_request")

Clicking on the pencil icon will allow you to edit a request.
Clicking on the pencil icon will allow you to edit a request.

![admin_edit_request](/docs/images/admin_edit_request.png "admin_edit_request")

Expand All @@ -63,17 +61,17 @@ To remove a record, visit `[records.youragency.gov]/admin/recordreview`.

![admin_remove_record](/docs/images/admin_record.png "admin_remove_record")

You can only remove a record, not "edit" any of the fields. Records include web links, uploaded electronic documents, and instructions on how to view or pick up copies of a record.
You can only remove a record, not "edit" any of the fields. Records include web links, uploaded electronic documents, and instructions on how to view or pick up copies of a record.

A description of the fields in the table displayed can be found below:

* ID: Unique ID assigned to each request.
* Filename: Name of electronic record uploaded to RecordTrac.
* Filename: Name of electronic record uploaded to RecordTrac.
* URL: Web address provided to requester.
* Download URL: Web address where you can automatically download the record.
* Download URL: Web address where you can automatically download the record.
* Access: Instructions on how to view or pick up copies of a record

Click on the trashcan icon to permanently delete the record from RecordTrac. You must also delete the record from the hosted location. For example, if you are using Scribd, it must be deleted from the Scribd account.
Click on the trashcan icon to permanently delete the record from RecordTrac. You must also delete the record from the hosted location.

![admin_delete_record](/docs/images/admin_delete_record.png "admin_delete_record")

Expand All @@ -87,9 +85,9 @@ A description of the fields in the table displayed can be found below:

* ID: Unique ID assigned to each request.
* Text: Entire text of the note.
* Date Created: The date the note was created.
* Date Created: The date the note was created.

Click on the trashcan icon to permanently delete the note from RecordTrac.
Click on the trashcan icon to permanently delete the note from RecordTrac.

![admin_delete_note](/docs/images/admin_delete_note.png "admin_delete_note")

Expand All @@ -107,14 +105,14 @@ A description of the fields in the table displayed can be found below:

* ID: Unique ID assigned to each request.
* Question: Entire text of the question asked by agency staff.
* Answer: Entire response of question provided by member of the public.
* Answer: Entire response of question provided by member of the public.
* Date Created: The date the exchange was created

Clicking on the trashcan icon permanently deletes the entire question and answer exchange.

![admin_delete_qa](/docs/images/admin_delete_qa.png "admin_delete_qa")

Clicking on the pencil icon will allow you to edit the text of the question and answer exchange.
Clicking on the pencil icon will allow you to edit the text of the question and answer exchange.

![admin_edit_qa](/docs/images/admin_edit_qa.png "admin_edit_qa")

Expand All @@ -137,7 +135,7 @@ There is a quick way for adminstrators to check on the status of the application

If the status is 'ok,' it means the app is working properly and users should not encounter any problems.

The number next to SendGrid is the percentage of its email quota the application has used this month. If it is close to 100, then the agency is close to hitting its email quotas for the month and may be charged for each additional email.
The number next to SendGrid is the percentage of its email quota the application has used this month. If it is close to 100, then the agency is close to hitting its email quotas for the month and may be charged for each additional email.

The dependencies section lists additional web applications used by RecordTrac. Askismet is the spam filter. Scribd is where all uploaded documents are hosted. SendGrid sends out the email notifications and Postgres is where all of the data is stored.
The dependencies section lists additional web applications used by RecordTrac. Askismet is the spam filter. SendGrid sends out the email notifications and Postgres is where all of the data is stored.

Loading

0 comments on commit 0855b0a

Please sign in to comment.