Skip to content

Commit c11b751

Browse files
committed
docs: user docs updated, mostly for settings page
1 parent 70d6d67 commit c11b751

File tree

7 files changed

+30
-15
lines changed

7 files changed

+30
-15
lines changed
33.2 KB
Loading
1.13 MB
Loading

pages/docs/guided-tour.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ work in and the **Project** you want to work in.
3939
More details can be found in the [Setting your work context](./how-to/context) How To guide.
4040

4141

42-
## The Project tab
42+
## The Project Data tab
4343

4444
This shows the contents (files and directories) in your project.
4545
The interface is a simple file browser a bit like Windows Explorer and probably doesn't need much explanation.

pages/docs/how-to/context.mdx

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,13 @@ The settings panel opens full screen (close it when finished).
2121

2222
You can select a **context** which includes the **organisation** and **unit** within that **organisation** that you want to
2323
work in. The administrators of that **organisation** and **unit** will need to have added you as member, or given you access to a
24-
**project** in the unit. See the [concepts document](/docs/concepts) for a description of
25-
these concepts.
24+
**project** in the unit. See the [concepts document](/docs/concepts) for a description of these concepts.
2625

2726
<Image src={projectContext} alt="Project context" />
2827

28+
Also note the *filter* option at the top that allows to filter the projects tht are shown based on your role in the project.
29+
To see the project you want you may need to adjust this filter.
30+
2931
If you not a member of a **unit** or **project** in a named **organisation** you can still create a **project** in the **Default**
3032
organisation. In that organisation you will have a **personal** **unit** that has the same name as your username. You can
3133
select the **Default** Organisation and your personal unit. These personal units are designed primarily for your own
@@ -39,6 +41,7 @@ When you close the settings dialog then you will be working in that **project**,
3941

4042
Owners of an **organisation** can create a new **unit** within it if you want a different work space (e.g. research
4143
group, department etc.). The **Default** **organisation** cannot have **units** added to it other than a user's
42-
**personal** unit.
44+
**personal** unit. The actions you see for managing **organisations**, **units** and **projects** will depend on your
45+
role in the selected **organisation**, **unit** and **project**.
4346

4447
export default ({ children }) => <Layout><Container>{children}</Container></Layout>

pages/docs/how-to/create-project.mdx

Lines changed: 17 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,9 @@ This guide deals with the specifics of creating a **new project**.
2323
A **project** is created within your currently selected **unit**. You can only do this in your own **personal** **unit**
2424
within the **Default** **organisation** or within a **unit** of another **organisation** if you are an owner of that
2525
**unit**. The **organisation** owner needs to make you a member of the **unit**. You *do not* need to be a member of
26-
a **unit** in order to use a **project** in that **unit**. The owner of the **project** can add you as an **editor**
27-
or the project to give you write access to the **project** and you will have read access to any public projects in the
28-
unit.
26+
a **unit** in order to use a **project** in that **unit**. The owner of the **project** can add you as an **administrator**,
27+
**editor** or **observer** of the project to give you write access to the **project** and you will have **observer** access
28+
to any public projects in the unit.
2929

3030
The *Create Project* button will be present in the *Context* section of the *Settings panel* if you are able to create a
3131
project in the current **context**. If you click on this you get a dialog that lets you specify the project details.
@@ -41,10 +41,20 @@ Once you have made your choices click on the CREATE button to create your projec
4141
Remember that the owner of the **unit** is responsible for the costs of your project. In the case of a **personal unit**
4242
in the **Default organisation** that means you!
4343

44-
You can add additional users to your project. These can either be as *editor* or *observers*. *Editors* have full access
45-
to the project, effectively the same rights as you, the *owner*. *Observers* can see the content, but cannot change
46-
anything and cannot execute jobs. To add users to your project click the edit button in the action to the right of your
47-
project listing and add the users you want to the *Editors* and *Observers* sections.
44+
You can add additional users to your project. These can either be as *administrator*, *editor* or *observers*.
45+
46+
The roles are as follows:
47+
* **creator** - the person who created the project and can perform administrative operations on it.
48+
Only this person can delete the project.
49+
* **administrator** - can administer the project in the same way as it's creator, except that they cannot delete the
50+
project. A project can have multiple administrators.
51+
* **editor** - can use the project and modify the data in it. they can run apps and jobs in the project.
52+
* **observer** - can view the contents of the project, but cannot make any changes to the data or execute apps or jobs.
53+
54+
To add or remove users to your project click the edit button in the action to the right of your
55+
project listing and add the users you want to the *Administrators*, *Editors* and *Observers* sections.
56+
You can also change the privacy of the project with this dialog.
57+
4858

4959
<Image src={users} alt="Edit project dialog" />
5060

pages/docs/how-to/projects-tab.mdx

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ import { DocsNav } from "../../../components/DocsNav";
1515
Your project has it's own data volume (a directory containing your projects files).
1616
That volume is accessible to any jobs and applications, providing a simple way to work with your data.
1717

18-
The *Project* tab allows you to see that data and perform simple operations on it.
18+
The *Project Data* tab allows you to see that data and perform simple operations on it.
1919
It's a bit like a simple file manager like Windows Explorer. It lists the files and directories that are present and
2020
allows to navigate that data.
2121

@@ -24,11 +24,12 @@ You an also:
2424
- upload new files to your project
2525
- download files from your project
2626
- delete existing files
27+
- create and delete directories
2728
- create a dataset from a file (see documentation on Datasets)
2829
- mark a file as a "favourite" to make is faster to access when running jobs
2930
- view the contents of text files
3031

31-
Not all operations you might want to do are possible from the *Project* tab.
32+
Not all operations you might want to do are possible from the *Project Data* tab.
3233
If you want to do more then your best bet is to launch the Jupyter Lab application in your project. That will allow you
3334
to manage your files either with the Jupyter Lab file manager or by opening up a console (bash shell).
3435
See the [Running applications](./applications) How To guide for more details on launching

pages/docs/how-to/usage-quotas.mdx

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,8 @@ The best starting point to find out about the usage and costs of your projects i
2323

2424
This lets you look at all the projects in a particular using and see a high level summary of the usage stats.
2525
You will see information for:
26-
* The project owner
26+
* Whether the project is public or private
27+
* The project creator and administrators
2728
* The project tier (evaluation, bronze, silver or gold)
2829
* A bar graph showing usage costs (see below for an explanation)
2930
* The number of instances used
@@ -39,7 +40,7 @@ The usage bar shows your consumption in Squonk coins (or coins for short) and is
3940
4. Green - coins predicted not to be consumed till the end of the month, assuming your storage does not change and you
4041
run no more applications or jobs.
4142

42-
If you move the mouse over one of these ba graphs then a more detailed listing of that usage is presented.
43+
If you move the mouse over one of these bar graphs then a more detailed listing of that usage is presented.
4344

4445
### Project charges
4546

0 commit comments

Comments
 (0)