Skip to content

Commit 823d270

Browse files
committed
Documentation Upgrade batch 1
Initial test
1 parent 7768f6f commit 823d270

File tree

5 files changed

+20
-17
lines changed

5 files changed

+20
-17
lines changed

bundle

Whitespace-only changes.

docs/conf.py

+3-3
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@
77
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
88

99
project = "Fieldmark"
10-
copyright = "2023, Electronic Field Notebooks PTY LTD"
11-
author = "Electronic Field Notebooks PTY LTD"
10+
copyright = "2023, Electronic Field Notebooks Pty Ltd"
11+
author = "Electronic Field Notebooks Pty Ltd"
1212
release = "0.7.940"
1313

1414
# -- General configuration ---------------------------------------------------
@@ -31,7 +31,7 @@
3131
]
3232

3333
html_theme_options = {
34-
"announcement": "Draft Documentation! This documentation is for a beta version of FAIMS3! Contact [email protected] with questions.",
34+
"announcement": "This is documentation for Fieldmark™. To access the software visit https://fieldnote.au.",
3535
}
3636

3737
myst_heading_anchors = 1

docs/faq.md

+7-4
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,18 @@
22

33
## What happened to the FAIMS Mobile Platform?
44

5-
The Field Acquired Information Management Systems (FAIMS) Mobile Platform was retired in 2022. The platform was established by archaeologists in 2012 to support the capture and management of digital field data in difficult terrain.
5+
The Field Acquired Information Management Systems (FAIMS) Mobile Platform was retired in 2022. The platform was established by archaeologists in 2012 to support the capture and management of digital field data in difficult terrain. The original software ran on Android only, and was first released in 2014. The last release, v2.6, was in 2017. See 'FAIMS Mobile: Flexible, open-source software for field research' by Ballsun-Stanton et al. (2018) in [SoftwareX](https://doi.org/10.1016/j.softx.2017.12.006) for more details.
66

7-
The original software, built in 2014 to run on Android only was rebuilt from the ground up with the assistance from the the Australian Research Data Commons ([ARDC](https://ardc.edu.au/)), [doi: 10.47486/PL110](https://dx.doi.org/10.47486/PL110). and our [partners](https://faims.edu.au/partners). The ARDC is funded by the National Collaborative Research Infrastructure Strategy (NCRIS).
7+
FAIMS v2.6 was rebuilt from the ground up with the assistance from the Australian Research Data Commons ([ARDC](https://ardc.edu.au/)), [doi: 10.47486/PL110](https://dx.doi.org/10.47486/PL110), and our [partners](https://faims.edu.au/partners). The ARDC is funded by the National Collaborative Research Infrastructure Strategy (NCRIS).
88

9+
The working title of the project was 'FAIMS 3.0' and all major releases were named [FAIMS3](https://github.com/FAIMS/FAIMS3).
10+
11+
The software was rebranded Fieldmark™ in 2023.
912

1013
## Who owns the data?
1114

12-
You own the data. Fieldmark runs the software that allows you to collect data but does not take ownership of, nor claim any right to use, data collected with the App. We do not share data with third parties.
15+
You own the data. Fieldmark runs the software that allows you to collect data but does not take ownership of, nor claim any right to use, data collected with the App. We do not share data with third parties.
1316

1417
## Who can access my data?
1518

16-
Only the Administrator of the Notebook can access data in it. For the purposes of training or assisted support, Fieldmark technical staff may access to the data but this will only be conducted with explicit consent.
19+
Only the Administrator of the Notebook can access data in it. For the purposes of training or assisted support, Fieldmark technical staff may access to the data but this will only be conducted with explicit consent.

docs/glossary.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
```{glossary}
44
Conductor
5-
The Fieldmark Conductor is the server which provides for user authentication and role orchestration.
5+
The Fieldmark Conductor is the server which provides for user authentication and role orchestration.
66
77
Form
88
A form allows for the collection of one record, sometimes split over one or more views.
@@ -11,7 +11,7 @@ Notebook
1111
A notebook is a collection of one or more forms and their records, centred around a project and its data collection activities.
1212
1313
Role
14-
A user's role provides access to a notebook, and determines if they can see all records or only their own records within a notebook. An Admin may see all records in a notebook.
14+
A user's role provides access to a notebook, and determines if they can see all records or only their own records within a notebook. An Admin may see all records in a notebook.
1515
1616
Snack
1717
Notification; little coloured bar in the bottom informing the user of a status.
@@ -25,4 +25,4 @@ User Role
2525
View
2626
A view is an organisational "page" of a form.
2727
28-
```
28+
```

docs/index.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
sd_hide_title: true
33
---
44

5-
# Fieldmark Documentation
5+
# Fieldmark™ User Guide
6+
67

7-
88
::::::{div} landing-title
99
:style: "padding: 0.1rem 0.5rem 0.6rem 0; background-image: linear-gradient(0deg,#009ffd,#223f8e 58%); clip-path: polygon(0px 0px, 100% 0%, 100% 100%, 0% calc(100% - 1.5rem)); -webkit-clip-path: polygon(0px 0px, 100% 0%, 100% 100%, 0% calc(100% - 1.5rem));"
1010

@@ -27,7 +27,7 @@ sd_hide_title: true
2727
:child-align: justify
2828
:class: sd-text-white sd-fs-3
2929

30-
FAIMS3 is an open-source tool for offline field data-collection brought to you by the FAIMS Project.
30+
**Fieldmark™** is an open-source tool for **offline field data** collection brought to you by the FAIMS Project.
3131

3232
```{button-ref} intro/getting-started
3333
:ref-type: doc
@@ -43,10 +43,10 @@ Get Started
4343

4444
::::::
4545

46-
FAIMS3 is an open-source tool for offline field data-collection brought to you by the FAIMS Project. The FAIMS Project was funded by the ARDC doi:[10.47486/PL110](https://dx.doi.org/10.47486/PL110), Macquarie University, and CSIRO along with our other [partners](https://faims.edu.au/partners). This documentation is appropriate for users wanting to learn about the Webapp, Android and iOS versions.
46+
**Fieldmark™** is an open-source tool for creating custom mobile applications to collect research data, while offline. It was launched in 2023 by the [FAIMS Project](https://faims.edu.au/) in partnership with the Australian Research Data Commons ([doi:10.47486/PL110](https://dx.doi.org/10.47486/PL110)), [Macquarie University](https://www.mq.edu.au/), [CSIRO](https://www.csiro.au/) and [other collaborators](https://faims.edu.au/partners/).
4747

48-
:::{tip}
49-
Contact [info@faims.edu.au](mailto:info@faims.edu.au) to enrol to try out the software.
48+
:::{About this User Guide}
49+
This **User Guide** is for users wanting to learn about the Web app, Android and iOS versions. Contact [info@fieldnote.au](mailto:info@fieldnote.au) to arrange a **demonstration** or enrol for to a **[trial account](https://forms.gle/N3uqHWyGzxDeKVwz5)** on our web app.
5050
:::
5151

5252
```{toctree}
@@ -122,4 +122,4 @@ caption: Testing zone
122122
hidden: true
123123
---
124124
sandbox
125-
```
125+
```

0 commit comments

Comments
 (0)