Skip to content

Commit

Permalink
Formatted TOC for "Behold CLAW" and added global nav entry
Browse files Browse the repository at this point in the history
  • Loading branch information
ysuarez committed May 23, 2017
1 parent a0881d0 commit 73566a6
Show file tree
Hide file tree
Showing 2 changed files with 81 additions and 0 deletions.
80 changes: 80 additions & 0 deletions docs/user-documentation/behold-claw.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
#Behold CLAW

## Table of Contents
* Resources
* [CLAW](#claw)
* [FEDORA](#fedora)
* [DRUPAL 8](#drupal-8)
* [LINKED DATA & PCDM](#linked-data-pcdm)
* SYSTEM ANALOGIES
* Drupal 8 (drupal-project)
* Fedora 4
* Crayfish Microservices
* Gemini
* Milliner
* Houdini
* Hypercube
* Alpaca: https://github.com/Islandora-CLAW/Alpaca
* Syn: https://github.com/Islandora-CLAW/Syn
* Triplestore:
* APIx
* SYSTEM NAVIGATION
* Adding a User
* Creating a new user role
* Administrative tasks
* How to add an item to a collection
* How to create a new Islandora collection
* How to edit an object’s metadata
* How to edit multiple objects
* How to delete an object
* How to add an object to multiple collections
* How to purge/delete objects
* How to delete a collection and all of its child objects
* How to batch delete multiple objects
* How to make mass edits and/or find and replace
* How to review mapping of Metadata fields in an object
* Reports
* Interface Functions
* How to control mapping via your own YAML file
* Appendix


##Resources
Here are resources that we should migrate to the docs or link to the docs

###CLAW

* [Current repository for documentation](https://github.com/Islandora-CLAW/CLAW/tree/master/docs)
* [User-documentation](https://github.com/Islandora-CLAW/CLAW/tree/master/docs/user-documentation)
* [Islandora CLAW site for documentation (built from github repo)](http://islandora-claw.github.io/CLAW/)
* [Legacy CLAW docs (lots of things have changed since the creation of these docs)](https://drive.google.com/drive/folders/0B3lcyfjAf3G3bV9zZHRZSENjWGc)
* [MVP Doc for CLAW](https://github.com/Islandora-CLAW/CLAW/blob/master/docs/mvp/mvp_doc.md)
* [Islandora CLAW Glossary (old old old)](https://docs.google.com/spreadsheets/d/1CDdlOF7lR6eZfhyLhdcZFP0gaVD4rnmsR2eUPPCTQxM/edit#gid=0)
* Old videos
* CLAW Lessons - webinars on how to develop CLAW (they’re a bit outdated but still really useful)
* Week One: Intro to Fedora 4.x (link is external)
* Week Two: Hands-on Creating Fedora 4.x Resources (link is external)
* Week Three: Data Flow in the CLAW (link is external)
* Week Four: Intro Drupal side of CLAW and some Camel (link is external)
* Week Five: Microservices 101 (Part 1) (link is external)
* Week Six: Microservices 101 (Part 2) (link is external)
* Week Seven: Drupal is Dead. Long Live Drupal (Drupal 8) (link is external)
* Week Eight: Final Lesson (discussion time) (link is external)
* Week Nine: How to Get Involved and Contribute! (link is external)

###Fedora
Need Fedora relevant docs here

###DRUPAL 8
* [Managing Content in Drupal 8](https://www.drupal.org/docs/8/administering-drupal-8-site/managing-content)

IMAGE

###LINKED DATA & PCDM
* [Bryan Brown’s intro to Linked Data](https://github.com/Islandora-CLAW/CLAW/blob/master/docs/user-documentation/intro-to-ld-for-claw.md)

##SYSTEM ANALOGIES
###Drupal 8 (drupal-project)
* Drupal is the interface for Islandora, and in CLAW, Drupal provides an even-more crucial role. In fact, if an Islandora site was a physical building, Drupal would be everything above ground. Drupal is a modular system, and Islandora is comprised of modules, plugins that allow integration with Islandora’s other components. User Management, Content Creation, Theming, Menus, and all elements of access and dissemination are managed in Drupal. Of particular note is that search is provided in Drupal through the Search API. This means that Islandora leverages Drupal’s pre-existing search product integrations, including modules for connecting to Solr (Apache Solr) and modules for connecting to Elastic Search.
* [https://www.drupal.org/docs/8/understanding-drupal-8/overview (scroll down to see drupal overview)](https://www.drupal.org/docs/8/understanding-drupal-8/overview)

1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ pages:
- User Documentation:
- 'Introduction to Islandora CLAW': 'user-documentation/intro-to-claw.md'
- 'Islandora CLAW for 1.x Users': 'user-documentation/CLAWfor1x.md'
- 'Behold CLAW': 'user-documentation/behold-claw.md'
- Technical Documentation:
- 'Minimum Viable Product': 'mvp/mvp_doc.md'
- 'How to build documenation': 'technical-documentation/docs-build.md'
Expand Down

0 comments on commit 73566a6

Please sign in to comment.