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
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.
57 changes: 57 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,57 @@
# 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.
Copy link
Member

Choose a reason for hiding this comment

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

It seems there are inconsistencies with items that are wrapped in quotes, and items that are bolded. Is there a distinct difference?

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 completely agree. I mostly followed what the hack/doc participants had created in the Google Doc, and it had these inconsistencies. I was not suse which practices were preferred, but initially I wanted to just follow what they did until I got feedback from the community/committers.

Is there a community documentation standard I should follow or a place I could look it up? For example, in some docs they format all menu or button labels in a particular style like bold or italics. In the Google Doc sometimes they used bold or sometimes they used quotes. Once I am given guidelines or if I find them on my own, I can reformat what I have done so far as well as continue the practice with the content that is left in the Google Doc. In the meantime, I will look over some of the docs on the Islandora wiki more carefully to see what has been done in the past.

One thing I did change from the original hack/doc content was to enforce the use of the word "click" instead of "select" when the contents referred to clicking a button, tab or link.

![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 the required fields, as indicated by red asterisks, in the Add User page.
5. Click on “Create New Account” button at the bottom of the page.
Copy link
Member

Choose a reason for hiding this comment

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

Don't use smart quotes.

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, this came from the Google Doc and I missed them. I should have known to look for them, smart quotes have burned me in the past.

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 **Permissions** tab in the set of tabs above the Add User button.
4. Click the blue botton “Add role”
Copy link
Member

Choose a reason for hiding this comment

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

Don't use smart quotes.

5. Name the role in a way that it can be disambiguated from related activities or similar groups
1. 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 permission 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 “Islandora section” of options. (Currently this is the very bottom of a very long page)
1. 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.

Don't use smart quotes.

2. Resource entities are your baseline from which you build
3. RDF is a Fedora resource
4. RDF Source (i.e. descriptive information) is a Resource
5. Collections are now considered a type
6. 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)
Copy link
Member

Choose a reason for hiding this comment

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

Don't use smart quotes.


## Administrative Tasks

### 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.
3. Click on **Fedora Resources*** tab (3rd tab).
Copy link
Member

Choose a reason for hiding this comment

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

One extra asterisk at the end of Fedora Resources.

4. Click on "Add fedora resource" button.
5. Click on "Islandora image" link. This will load the "Create of bundle Islandora image" page.
6. Fill out form fields. [NOTE: currently the generation of image derivatives is not supported.]
1. Name
Copy link
Member

Choose a reason for hiding this comment

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

These sub-items should be bullets, not Roman numerals.

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, but that is how it looked on the Google Doc. I will make the change.

2. Authored by
3. memberOf
1. This field will auto-populate
Copy link
Member

Choose a reason for hiding this comment

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

If sub-items are going to be bullets, then this sub-sub-item should probably also be a bullet. 😃

4. Description
5. OJB
Copy link
Member

Choose a reason for hiding this comment

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

typo OJB, should be OBJ

6. JP2
7. MEDIUM_SIZE [NOTE: for now, just use this option to upload an object]
1. Click on "Add new media" button.
2. You must create some alternative text for the object.
3. Click "Create Media" button.
8. TN (Thumbnail)
9. "Promoted to front page" checkbox.
10. "Sticky at top of lists" checkbox.
11. Revision log message
12. Click "Save" button.
13. 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