diff --git a/docs/contributing/contributing.md b/docs/contributing/contributing.md index 6a71ba56e..f939e75f2 120000 --- a/docs/contributing/contributing.md +++ b/docs/contributing/contributing.md @@ -1 +1 @@ -../../contributing.md \ No newline at end of file +../../CONTRIBUTING.md \ No newline at end of file diff --git a/docs/index.md b/docs/index.md index 59d074c60..48871deef 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,4 +1,4 @@ -# About Islandora 7.x-2.x +# About Islandora CLAW [Islandora](http://islandora.ca) is an open-source software framework designed to help institutions and organizations and their audiences collaboratively manage, and discover digital assets using a best-practices framework. Islandora was originally developed by the University of Prince Edward Island's Robertson Library, but is now implemented and contributed to by an ever-growing international community. @@ -6,13 +6,13 @@ Islandora consists of: * [Sync](camel/sync/README.md) - Event driven middleware based on Apache Camel that synchronizes a Fedora 4 JCR with a Drupal CMS. * [Islandora](drupal/islandora/README.md) - Fedora 4 Repository module - * [Install](install/README.md) - The is a development environment virtual machine for the Islandora and Fedora 4 project. It should work on any operating system that supports VirtualBox and Vagrant. + * [Install](install/README.md) - The is a development environment virtual machine for Islandora CLAW. It should work on any operating system that supports VirtualBox and Vagrant. ## About this guide The Technical documentation will help you understand: - * 7.x-2.x archtecture + * Islandora CLAW architecture * Middleware services * IslandoraCommand @@ -26,7 +26,7 @@ The [installation section](install/README.md) provides and overview on how to cr ## Contributing -If you would like to contribute, please get involved by attending our weekly [Tech Call](https://github.com/Islandora-CLAW/CLAW/wiki), and check out the [contributing section](contributing/contributing.md). We love to hear from you! +If you would like to contribute, please get involved by attending our weekly [Tech Call](https://github.com/Islandora-CLAW/CLAW/wiki#islandora-7x-2x-tech-calls), and check out the [contributing section](contributing/contributing.md). We love to hear from you! If you would like to contribute code to the project, you will need to be covered by an Islandora Foundation [Contributor License Agreement](http://islandora.ca/sites/default/files/islandora_cla.pdf) or [Corporate Contributor Licencse Agreement](http://islandora.ca/sites/default/files/islandora_ccla.pdf). Please see the [Contributors](http://islandora.ca/resources/contributors) page on Islandora.ca for more information. diff --git a/docs/technical-documentation/docs-build.md b/docs/technical-documentation/docs-build.md index ccf52c521..a9174616c 100644 --- a/docs/technical-documentation/docs-build.md +++ b/docs/technical-documentation/docs-build.md @@ -4,6 +4,12 @@ This documentation is built using [mkdocs](http://www.mkdocs.org/), a static sit ## Build and Deploy documentation +Make sure you have a recent version of Mkdocs: +`pip install --upgrade mkdocs` + +Make sure you have the cinder theme installed: +`pip install mkdocs-cinder` + Documentation is build by running to the following command in the root of the repository: `mkdocs build --clean` diff --git a/mkdocs.yml b/mkdocs.yml index 813387af0..79470da96 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,32 +1,31 @@ -site_name: Islandora 7.x-2.x +site_name: Islandora CLAW site_dir: site docs_dir: docs -site_description: Documentation for Islandora 7.x-2.x +site_description: Documentation for Islandora CLAW dev_addr: 'localhost:8111' repo_url: https://github.com/Islandora-CLAW/CLAW -theme: readthedocs +theme: cinder pages: - About: - - 'Islandora 7.x-2.x': 'index.md' + - 'Islandora CLAW': 'index.md' - 'Islandora-Sync': 'camel/sync/README.md' - 'Islandora (Drupal module)': 'drupal/islandora/README.md' -- Installation: - - 'Installation (Vagrant)': 'install/README.md' - Contributing: - 'How to contribute': 'contributing/contributing.md' - 'Committers': 'contributing/committers.md' - 'Hacking on Islandora': 'contributing/hacking-on-islandora.md' - User Documentation: - - 'Islandora 2.x for Islandora 1.x Users': 'user-documentation/2xfor1x.md' - - 'Creating Collections in Islandora 7.x-2.x': 'user-documentation/creating-collections-in-islandora-7.x-2.x.md' - - 'Adding an object to a collection in Islandora 7.x-2.x': 'user-documentation/adding-object-to-collection-in-islandora-7.x-2.x.md' - - 'Editing the Basic Image Form in Islandora 7.x-2.x': 'user-documentation/editing-basic-image-form-in-islandora-7.x-2.x.md' - - 'Adding a Drupal Taxonomy in Islandora 7.x-2.x': 'user-documentation/form-field-select-taxonomy-in-islandora-7.x-2.x.md' + - 'Islandora CLAW for Islandora 1.x Users': 'user-documentation/2xfor1x.md' + - 'Creating Collections in Islandora CLAW': 'user-documentation/creating-collections-in-islandora-7.x-2.x.md' + - 'Adding an object to a collection in Islandora CLAW': 'user-documentation/adding-object-to-collection-in-islandora-7.x-2.x.md' + - 'Editing the Basic Image Form in Islandora CLAW': 'user-documentation/editing-basic-image-form-in-islandora-7.x-2.x.md' + - 'Adding a Drupal Taxonomy in Islandora CLAW': 'user-documentation/form-field-select-taxonomy-in-islandora-7.x-2.x.md' - Technical Documentation: - 'Architecture': 'technical-documentation/architecture.md' + - 'Installation (Vagrant)': 'install/README.md' - 'Middleware Services': 'technical-documentation/services.md' - 'Commands': 'technical-documentation/commands.md' - 'How to build documenation': 'technical-documentation/docs-build.md'