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

Create creating collection.md #1047

Closed
wants to merge 3 commits into from
Closed

Conversation

alexkent0
Copy link

Text for documentation on creating a collection.

GitHub Issue: (link)

  • Other Relevant Links (Google Groups discussion, related pull requests, Release pull requests, etc.)

What does this Pull Request do?

User documentation on creating a collection for Islandora 8.

Interested parties

@mjordan, @dannylamb, @Islandora-CLAW/committers

Text for documentation on creating a collection.
@seth-shaw-unlv
Copy link
Contributor

@alexkent0, you should save the screenshots to the assets directory and create links to them in the appropriate spots in your markdown. E.g. (assuming the first screenshot was named creating-collections-add-content-link.png) you would enter it like this:

Click on Add content. This is under Tools.

![Alt-text for the image](../assets/creating-collections-add-content-link.png)

Then click on Repository Item. A collection is considered a "Repository Item."

Also, you should replace the name in the filename with a hyphen: 'creating-collection.md'

@alexkent0
Copy link
Author

Seth, thanks again. I loaded them to the directory but now I can't find where the images went. Where can I find the directory and the actual images to make the links in the documentation? I'm a complete newbie to this process. Thanks!

@seth-shaw-unlv
Copy link
Contributor

Glad to help, @alexkent0. You have two separate branches going on here: patch-2 and patch-3 and each have separate upload forms. The link on the other PR adds files to that corresponding branch. This branch uses https://github.com/alexkent0/CLAW/upload/patch-3/docs/assets. Also, rename the files to be lower-case and use hyphens instead of spaces before uploading.

@alexkent0
Copy link
Author

Thanks @seth-shaw-unlv. I think I have this one updated correctly, with links to screenshots: cc9d9db

@seth-shaw-unlv
Copy link
Contributor

@alexkent0 three things:

  1. The image paths should be relational. The paths you have there ('docs/assets/repository item.jpg') would point to a docs/assets directory inside the user-documentation directory, but we want to point to the assets directory sitting at the same level as the user-documentation directory, so change your 'docs/assets/' to '../assets/' and that will be fine.
  2. The commit you pointed to in your comment wasn't on your branch. Make sure the changes (for this PR) are in the https://github.com/alexkent0/CLAW/tree/patch-2/docs repository and branch.
  3. The files should not use spaces in their file names. Use hyphens or underscores instead of spaces and make sure the names are all lower-case.

@manez
Copy link
Member

manez commented Mar 7, 2019

Hang in there, @alexkent0. It's a labyrinth at first, but I promise it gets easier once you get into it 👍

Added alternative text and links
Added correct slashes in front of "assets" for links
@dannylamb
Copy link
Contributor

Superseded by #1084

@dannylamb dannylamb closed this 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.

4 participants