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

Bringing it all together #1084

Merged
merged 26 commits into from
Apr 18, 2019
Merged

Conversation

dannylamb
Copy link
Contributor

GitHub Issue: #1040

What does this Pull Request do?

What started out as taking the excellent work from @alexkent0 and bringing it over the finish line turned into an editorial pass that just exploded in scope on me. Here's the best stopping point I could find before tackling moving over the install docs and the migrate tutorials.

What's new?

It's everything from the sprint, plus I managed to make it through the first several pages of the user docs and smooth over some things. Remove duplicated concepts, etc... Just trying to make sure the user documentation reads better, mostly.

Still needs tons of love, but it's a massive overhaul and major improvement from where we started!

How should this be tested?

I've taken the liberty of pushing the documentation to https://islandora-claw.github.io/CLAW/. I find it's much easier to digest in its final form. Please please please give it a review and leave your comments in this PR.

Interested parties

@Islandora-CLAW/committers

alexkent0 and others added 18 commits March 7, 2019 10:16
Text for documentation on creating a collection.
Slight revisions and saved with .md at end of name.
Added screenshot files for loading media doc
Added spaces between paragraphs, alternate text, and links to screenshots.
Added screenshots for creating collection documentation.
Added alternative text and links
Added correct slashes in front of "assets" for links
Added screenshots for loading media documentation with correctly formatted filenames
Update links with properly formatted filenames
Click save when done, and the file will be uploaded (to Fedora by default). Now return to the node
you created and you should see the image along with its descriptive metadata.

![The file is now loaded, return to the main site to view](/assets/final-loaded-image.jpg)
Copy link
Member

Choose a reason for hiding this comment

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

I think you needs an absolute URL here, it's not loading when previewed. "docs/assets/final-loaded-image.jpg"

Copy link
Member

Choose a reason for hiding this comment

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

Or as the other above change to ../assets/final-loaded-image.jpg

docs/user-documentation/collections.md Outdated Show resolved Hide resolved
docs/user-documentation/creating-an-object.md Outdated Show resolved Hide resolved
docs/user-documentation/creating-an-object.md Outdated Show resolved Hide resolved
Click save when done, and the file will be uploaded (to Fedora by default). Now return to the node
you created and you should see the image along with its descriptive metadata.

![The file is now loaded, return to the main site to view](/assets/final-loaded-image.jpg)
Copy link
Member

Choose a reason for hiding this comment

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

Or as the other above change to ../assets/final-loaded-image.jpg

docs/user-documentation/datastreams.md Outdated Show resolved Hide resolved
docs/user-documentation/datastreams.md Outdated Show resolved Hide resolved
docs/user-documentation/objects.md Outdated Show resolved Hide resolved
docs/user-documentation/objects.md Outdated Show resolved Hide resolved
docs/user-documentation/objects.md Outdated Show resolved Hide resolved
docs/user-documentation/user-intro.md Outdated Show resolved Hide resolved
docs/index.md Outdated
@@ -10,13 +6,3 @@ Islandora CLAW integrates [Drupal](https://www.drupal.org/) (currently, Drupal 8
Islandora CLAW allows you to create nodes, media, files, and taxonomy terms in Drupal, which are converted to RDF
Copy link
Contributor

Choose a reason for hiding this comment

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

/CLAW/8/

@dannylamb
Copy link
Contributor Author

dannylamb commented Apr 17, 2019

I think that hits all the feedback I've received. At least I figured out how tip boxes work with Admonition and can give them titles now. I played around with the formatting a lot. Please let me know if there's more to do here.

@Natkeeran
Copy link
Contributor

Natkeeran commented Apr 17, 2019

@dannylamb
Consider including this one into the documentation as well: #1093. Multilingual support is really good in Drupal 8, and it mostly works in Islandora 8 as well. We should highlight that as we work through some tickets to better support that.

@@ -0,0 +1,3 @@
<iframe width="560" height="315" src="https://www.youtube.com/embed/fEDzfSPjKEo" frameborder="0" allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
Copy link
Contributor

Choose a reason for hiding this comment

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

Consider using Youtube's "no cookie" URL: https://www.youtube-nocookie.com/embed/fEDzfSPjKEo

Copy link
Member

Choose a reason for hiding this comment

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

This was my mistake I forgot to test this by actually building the Mkdocs. This works as is.

@whikloj
Copy link
Member

whikloj commented Apr 18, 2019

@dannylamb This looks good now.

You are missing the testing-notes file in the mkdocs.yml file (https://github.com/Islandora-CLAW/CLAW/blob/d565fe0d2d473bf7b5e24e060b649139278b5b5d/docs/technical-documentation/testing-notes.md) and need to fix the conflicts here.

Once that is done I am happy to merge this.

@dannylamb
Copy link
Contributor Author

@whikloj OK, conflicts resolved and testing notes added back in.

Copy link
Member

@whikloj whikloj left a comment

Choose a reason for hiding this comment

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

👍

@whikloj
Copy link
Member

whikloj commented Apr 18, 2019

@seth-shaw-unlv do you need anything else on this or are we good to go?

@seth-shaw-unlv
Copy link
Contributor

@whikloj, nah. I don't think the youtube no cookie is important enough to hold up merging. Go ahead.

@whikloj whikloj merged commit c55184c into Islandora:master Apr 18, 2019
This was referenced May 21, 2019
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.

7 participants