-
Notifications
You must be signed in to change notification settings - Fork 158
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Line edit #319
Line edit #319
Conversation
1bb802a
to
54b3ea8
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Still a lot of markup problems.
aggregate-limitations.rst
Outdated
@@ -22,7 +22,7 @@ Aggregate Limitations | |||
If you have many media attachments or more than 10MB of media attachments, :doc:`Form Uploader <form-uploader>` provides a quick and easy means to upload forms into ODK Aggregate. | |||
|
|||
|
|||
- ODK Aggregate 1.4.7 and earlier use a deprecated `backends` technology. Google may terminate support for that at any time with little warning. You should consider upgrading to 1.4.8. | |||
- ODK Aggregate 1.4.7 and earlier use a deprecated *backends* technology. Google may terminate support for that at any time with little warning. You should consider upgrading to 1.4.8. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think that backend is a simple adjective here, and should have:
- no 's'
- no markup
...use a deprecated backend technology.
aggregate-upgrade.rst
Outdated
@@ -164,7 +164,7 @@ Aggregate v1.4.12 | |||
4. Change MySQL ODK 1.x and ODK 2.0 data table constructions to use MEDIUMBLOB columns for media attachments. Fix several issues around accessing attachments. See Upgrade notes below and MySQL configuration instructions in :ref:`installing Aggregate on Tomcat <install-tomcat>` for configuration that is required for MySQL. | |||
5. Tweak Google AppEngine configuration to reduce frontend usage hours and thereby reduce costs. | |||
6. Performance improvements to Google AppEngine task locks (primarily for ODK 2.0 support). | |||
7. Add "/users/list" URL that returns the list of all configured users and the roles they have been granted. Access to this URL requires authentication and is restricted to ODK Aggregate usernames and Google accounts (anonymousUser access is forbidden). If the authenticated user does not have Tables Super-user, Administer Tables, or Site Administrator permissions, a singleton list is returned that contains only information about their own identity and its capabilities. | |||
7. Add **/users/list** URL that returns the list of all configured users and the roles they have been granted. Access to this URL requires authentication and is restricted to ODK Aggregate usernames and Google accounts (anonymousUser access is forbidden). If the authenticated user does not have Tables Super-user, Administer Tables, or Site Administrator permissions, a singleton list is returned that contains only information about their own identity and its capabilities. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If that is a literal URL string, it should be in double-backticks.
@@ -194,8 +194,8 @@ Aggregate v1.4.11 | |||
1. Add a mutex around ODK 1.x form submission creation and updating. This should eliminate submission data corruption. | |||
2. If only ODK 2.0 privileges are assigned, hide the Submissions tab. | |||
3. Fix: advisory memcache interaction to delete the entry when rolling back the datastore update. | |||
4. Add "Tables Super-user" as a configurable user capability. Users with this capability will be able to modify the table-level and row-level privileges on ODK 2.0 rev 206 data tables. These privileges are advisory and do not provide strong access or revision control. | |||
5. Add "/roles/granted" URL that returns the roles granted to an authenticated username or google account. This will be used by ODK 2.0 rev 206 tools to determine and save the capabilities of the configured user on a device. Those capabilities are then used to apply advisory access controls on the tables and rows. | |||
4. Add **Tables Super-user** as a configurable user capability. Users with this capability will be able to modify the table-level and row-level privileges on ODK 2.0 rev 206 data tables. These privileges are advisory and do not provide strong access or revision control. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If this is literal text from a GUI, it should be :guilabel:
aggregate-upgrade.rst
Outdated
4. Add "Tables Super-user" as a configurable user capability. Users with this capability will be able to modify the table-level and row-level privileges on ODK 2.0 rev 206 data tables. These privileges are advisory and do not provide strong access or revision control. | ||
5. Add "/roles/granted" URL that returns the roles granted to an authenticated username or google account. This will be used by ODK 2.0 rev 206 tools to determine and save the capabilities of the configured user on a device. Those capabilities are then used to apply advisory access controls on the tables and rows. | ||
4. Add **Tables Super-user** as a configurable user capability. Users with this capability will be able to modify the table-level and row-level privileges on ODK 2.0 rev 206 data tables. These privileges are advisory and do not provide strong access or revision control. | ||
5. Add **/roles/granted** URL that returns the roles granted to an authenticated username or google account. This will be used by ODK 2.0 rev 206 tools to determine and save the capabilities of the configured user on a device. Those capabilities are then used to apply advisory access controls on the tables and rows. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If this is a literal URL string, it should be in double backticks.
aggregate-use.rst
Outdated
@@ -33,7 +33,7 @@ Under the :guilabel:`Form list` tab, you will see :guilabel:`Add New Form` butto | |||
.. image:: /img/aggregate-use/add-form.* | |||
:alt: Image showing add form button. | |||
|
|||
When you click on it a box will open asking for details of the form. `Form Definition` is required and `Media File(s)` is optional. Choose the .xml file that will be used. You can also choose the appropriate media files for the form. | |||
When you click on it a box will open asking for details of the form. *Form Definition* is required and *Media File(s)* is optional. Choose the .xml file that will be used. You can also choose the appropriate media files for the form. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If this is literal text from a GUI, it should be :guilabel:
aggregate-use.rst
Outdated
|
||
Interfaces used during push actions are: | ||
|
||
- `formUpload` to upload a form and its media files to ODK Aggregate | ||
- `view/submissionList` to obtain a chunk of submission keys | ||
- *formUpload* to upload a form and its media files to ODK Aggregate |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
literal URI strings should use double backticks
aggregate-use.rst
Outdated
- `formUpload` to upload a form and its media files to ODK Aggregate | ||
- `view/submissionList` to obtain a chunk of submission keys | ||
- *formUpload* to upload a form and its media files to ODK Aggregate | ||
- *view/submissionList* to obtain a chunk of submission keys |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
literal URI strings should use double backticks
briefcase-forms.rst
Outdated
@@ -147,7 +147,7 @@ Export form data | |||
This command exports form data with id market_prices from Briefcase's storage directory on the :file:`~/Desktop` and write CSV file to :file:`~/Desktop/market_prices.csv` | |||
|
|||
|
|||
To get help about the command line operation type `java -jar path_to_jar -help`. | |||
To get help about the command line operation type *java -jar path_to_jar -help*. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Inline references to terminal commands use :command:
http://docs.opendatakit.org/contributing/#role-command
(Note: The entire command, including options, etc. goes in the :command:
role...
the :option:
role is only for talking about options separately.)
verify-downloads.rst
Outdated
@@ -13,7 +13,7 @@ Verifying on Linux and Mac | |||
|
|||
- Open a terminal window. | |||
- Navigate to the folder containing the file you downloaded. ( cd "path/to/file" ) | |||
- Then type `sha256sum "filename"` on the terminal. | |||
- Then type **sha256sum "filename"** on the terminal. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
use :command:
verify-downloads.rst
Outdated
@@ -29,7 +29,7 @@ Verifying on Windows | |||
|
|||
- Open a cmd window. | |||
- Navigate to the folder containing the file you downloaded ( cd "path/to/file" ). | |||
- Then type certUtil -hashfile "filename" SHA256 on your command prompt. | |||
- Then type **certUtil -hashfile "filename" SHA256** on your command prompt. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
use :command:
54b3ea8
to
e8731c6
Compare
@adammichaelwood Sorry for so many mistakes. I checked this and made the requested changes. |
addresses #96
What is included in this PR?
Minor line edits for docs.