Skip to content
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

Documentation: new content from hack/doc "Getting Started with Islandora CLAW" #650

Merged
Merged
Binary file added docs/assets/gettingstarted_add_collection.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/gettingstarted_add_content.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/gettingstarted_content.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/gettingstarted_permissions.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/gettingstarted_roles.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/people_page.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
74 changes: 74 additions & 0 deletions docs/user-documentation/getting-started-with-islandora-claw.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
# Getting Started with Islandora CLAW

## How to Add a User
1. Log in under admin credentials.
2. Click the **Manage** tab from the top toolbar.
3. Select **People** tab from the resulting menu.
![Alt text](../assets/people_page.png "People page")
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will there be more screenshots? It seems inconsistent to only have one.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good question This is again what the hack/doc document had. I started making some new screenshots, but I wanted to get this feedback first. @kimpham54 this morning already made a PR on my CLAW fork with additional screenshots I will soon include in this PR.

4. Enter all required fields, as indicated by red asterisks, in the *Add User* page.
5. Click on the **Create New Account** button at the bottom of the page.
6. To review/edit the permission for each role, click the **Permissions** tab in the set of tabs above the *Add User* button.

## How to Create a New User Role
1. Click the **Manage** tab from the top toolbar.
2. Select **People** tab from the resulting menu.
3. Click the **Roles** tab in the set of tabs above the *Add User* button.
4. Click the **Add role** button.
![Alt text](../assets/gettingstarted_roles.png "Roles page")
5. Name the role in a way that it can be disambiguated from related activities or similar groups
* I.e. use the course code for a particular class of students working on a particular collection.
6. Click the **Save** button.
7. To edit the permissions for a role, click on the **Edit** dropdown menu to the right of the role and select **Edit Permissions**.
8. Scroll down until you see the *Node* section of options, until you see options that have an *Islandora* preffix. For example, *Islandora Collection: Create new content*.
Copy link
Member

@whikloj whikloj Jun 13, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Two little things.

  1. "Scroll down until you see the Node section of options, until you see the options that have an..."
    The language is jumbly.
  2. Typo preffix, should be prefix

* Resource ‘type’ is what you’ll most often deal with
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm thinking out loud here, but should we add a screen shot here? Or could that lead us into a 🐰 hole of un-imaginable depth over time?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ysuarez Recapping our IRC conversation (starting @ 13:32). The rabbit hole is once more permissions get added, keeping a screenshot of them could be problematic.

However, currently there is only one section of permissions and as this is a Getting Started with Islandora CLAW document, maybe a single screenshot with some permissions is good enough. 🤷‍♂️

Here is some of the current permissions lines now using Nodes.
islandora_permission

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree, we can add a basic screenshot with the first couple of rows of relevant CLAW permissions

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am not sure if we need lines 23-28. Let me know what you all think.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah I don't know if that makes sense anymore. I also think it might be overly complex for a "getting started" document.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@whikloj thanks for the feedback. I took that content out.

* Resource entities are your baseline from which you build
* RDF is a Fedora resource
* RDF Source (i.e. descriptive information) is a Resource
* Collections are now considered a type
* Audio, Images, etc are also going to be types (this might require changes in the vocabulary we use Drupal "entities" (i.e. your core set of elements) and Drupal "bundles" (includes your entities plus other elements)
![Alt text](../assets/gettingstarted_permissions.png "Permissions page")

## Administrative Tasks

### How to Create a Collection
1. Click the **Manage** tab from the top toolbar.
2. Select **Content** tab from the resulting menu.
![Alt text](../assets/gettingstarted_content.png "Content page")
3. Click on **Add content** button. This will load the *Add content* page.
![Alt text](../assets/gettingstarted_add_content.png "Add content page")
4. Click on **Islandora Collection** link. This will load the *Create Islandora Collection* page.
5. Fill out form fields. Enter all required fields, as indicated by red asterisks.
* Title
* Member of: Parent collection
* This field will auto-populate
* Description
* Revision log message
![Alt text](../assets/gettingstarted_add_collection.png "Add content page")
6. Click the **Save and publish** button.

### How to Add an Item to a Collection
1. Click the **Manage** tab from the top toolbar.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If we have an "How to Add an Item to a Collection", there needs to be a "How to Add a Collection" before it.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll work on this, if someone doesn't get to it before I do. I am still learning CLAW, but I may be able to write out the basics steps by trying it out on my CLAW VM.

2. Select **Content** tab from the resulting menu.
![Alt text](../assets/gettingstarted_content.png "Content page")
3. Click on **Add content** button. This will load the *Add content* page.
![Alt text](../assets/gettingstarted_add_content.png "Add content page")
4. Click on **Islandora Image** link. This will load the *Create Islandora Image* page.
5. Fill out form fields. Enter all required fields, as indicated by red asterisks. [NOTE: currently the generation of image derivatives is not supported.]
* Title
* Description
* Member of: Parent collection
* This field will auto-populate
* OBJ
* JP2
* MEDIUM_SIZE [NOTE: for now, just use this option to upload an object]
* Click on "Add new media" button.
* You must create some alternative text for the object.
* Click "Create Media" button.
* TN (Thumbnail)
* Revision log message
![Alt text](../assets/gettingstarted_add_islandora_image.png "Add content page")
7. Click the **Save and publish** button.
* Once you upload a file, you can Edit or Remove it.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove erogenous whitespace.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

agreed, it's too stimulating

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My apologies, I totally missed that. Will be on the lookout for these extra spaces going forward.



1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ pages:
- 'Introduction to Islandora CLAW': 'user-documentation/intro-to-claw.md'
- 'Islandora CLAW for 1.x Users': 'user-documentation/CLAWfor1x.md'
- 'Introduction to Linked Data for CLAW': 'user-documentation/intro-to-ld-for-claw.md'
- 'Getting Started with Islandora CLAW': 'user-documentation/getting-started-with-islandora-claw.md'
- Technical Documentation:
- 'Minimum Viable Product': 'mvp/mvp_doc.md'
- 'How to build documenation': 'technical-documentation/docs-build.md'
Expand Down