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

Starts #1873 - Adding Islandora Cookbook to main docs #1891

Merged
merged 9 commits into from
Aug 27, 2021

Conversation

manez
Copy link
Member

@manez manez commented Aug 23, 2021

Purpose / why

Updates the "extending Islandora" page to be mostly cookbook, adds first recipe. Starts work on #1873

What changes were made?

Edited a page, added a new screenshot, and added a new recipes page and folder. There are four other receipts that will need to come over, but I figured it was better to get a proof of concept out there sooner rather than wait until I (or anyone else who wants to help!) get them all converted.

Did some minor de-8ing as well.

Verification

Review for content. Ideally do a test build because new pages are being added.

Interested Parties

@Islandora/documentation


Checklist

Pull-request reviewer should ensure the following

  • Does this PR link to related issues?
  • Does the proposed documentation align with the Islandora Documentation Style Guide?
  • Are the changes accurate, useful, free of typos, etc?
  • Does this PR update the last updated on date on the documentation page?

Person merging should ensure the following

  • Does mkdocs still build successfully? (This is indicated by TravisCI passing. To test locally, and see warnings, see How To Build Documentation.)
  • If pages are renamed or removed, have all internal links to those pages been fixed?
  • If pages are added, have they been linked to or placed in the menu?
  • Did the PR receive at least one approval from a committer, and all issues raised have been addressed?

Copy link
Member

@rosiel rosiel left a comment

Choose a reason for hiding this comment

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

In general, awesome!

A couple formatting/linking things.

@@ -0,0 +1,35 @@
# Accessing Islandora with Amazon Alexa
The following recipe details how to connect Islandora with Alexa, using custom Alexa skills and the Drupal Alexa module. The potential applications are broad:
- Send Citations, metadata, whatever we want to the user if they have set up their email
Copy link
Member

Choose a reason for hiding this comment

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

This list needs a new line before it, it's rendering as part of the paragraph

Copy link
Member Author

Choose a reason for hiding this comment

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

On it!

1. Enable modules (Alexa, Alexa_Demo)
1. Go to Config > Alexa Configuration and put in the Application ID.
1. Test with one question and answer (“Clawbster, say Hello world?” “Hello World!”) Now you can add as many questions and answers as you can configure:
![Screenshot of google form with questions and answers for chatbot](../docs/assets/recipe_alexa.png)
Copy link
Member

Choose a reason for hiding this comment

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

link to image not working, directing to 'user-documentation/docs/assets/recipe_alexa.png'

Copy link
Member Author

Choose a reason for hiding this comment

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

Bother! I wrestled with that thing through a few iterations and I thought I had it working in preview. I don't know why links are such strange magic for me.

Copy link
Member

@rosiel rosiel Aug 24, 2021

Choose a reason for hiding this comment

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

I hear ya!

![Screenshot of google form with questions and answers for chatbot](../../assets/recipe_alexa.png)
worked for me.


We offer this list for discovery, but do not officially provide support for any of these modules.

# Recipes
Copy link
Contributor

@eldonquijote eldonquijote Aug 24, 2021

Choose a reason for hiding this comment

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

## Recipes

(the table of contents for the page won't render if the headings aren't properly nested)

- [Exhibitions and TimeLine JS] - This recipe outlines how to build exhibits in Islandora 8, including the deployment of TimeLineJS.
- [Digital Preservation] - A detailed overview of how to approach digital preservation in Islandora 8. Includes features that are currently avaiable, both within Islandora and by using compatible tools.

# Ingredients
Copy link
Contributor

Choose a reason for hiding this comment

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

From here down, until ## Other Resources, all headings need an additional #

1. Test with one question and answer (“Clawbster, say Hello world?” “Hello World!”) Now you can add as many questions and answers as you can configure:
![Screenshot of google form with questions and answers for chatbot](/docs/assets/recipe_alexa.png)

## Notes
Copy link
Contributor

@eldonquijote eldonquijote Aug 24, 2021

Choose a reason for hiding this comment

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

Suggestion: put this at the beginning in an admonition:
!!! note
This recipe has not been extensively tested.

@manez
Copy link
Member Author

manez commented Aug 25, 2021

I think I've addressed everything @rosiel @eldonquijote

@rosiel rosiel merged commit 93331e6 into Islandora:main Aug 27, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants