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

Migration docs updates #1603

Merged
merged 3 commits into from
Sep 4, 2020
Merged

Conversation

ysuarez
Copy link
Contributor

@ysuarez ysuarez commented Sep 1, 2020

Purpose / why

I wanted the Islandora 8 docs site to have links to more recent migration related videos that the community / foundation has recently created.

Related to issue #1579

What changes were made?

I added links to a newer Youtube video that covers migrations in "migrate-7x.md".

Islandora Webinar: Migrating from Islandora 7 to Islandora 8
https://www.youtube.com/watch?v=n0kLOB8ZdbM
Nov 21, 2019

Also a new page "migration-overview.md" and added content that summarizes another migration related video.

Islandora Online: Islandora Migration Tools
https://www.youtube.com/watch?v=95Bnix-z1zY&feature=em-uploademail
Aug 10, 2020

Verification

Please suggest changes to overall content, spelling, or grammar.

Interested Parties

@manez @dannylamb


Checklist

Pull-request reviewer should ensure the following

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

@manez manez left a comment

Choose a reason for hiding this comment

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

@ysuarez The new page is great! The summary for each section of the video is very, very helpful. I have a couple of minor suggestions, but overall, really nice addition. Thank you!

- Process plugins transform the data
- Destination plugins load the data (create new entities)

We’ve built two tools for you using the Migrate API:
Copy link
Member

Choose a reason for hiding this comment

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

I found this section a bit hard to follow (there's a lot of information, which is awesome!). Can you add some sub-headings to break it out visually? I think if "A Migration Configuration defines an Extract, Transform, Load (ETL) process." was ####, it would read easier.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I added more Markdown headings marks to the docs. Let me know what you think.

- [migrate_7x_claw](https://github.com/Islandora-Devops/migrate_7x_claw)
- A tool to get all your Islandora 7 content migrated over

Recap of migrate_islandora_csv:
Copy link
Member

Choose a reason for hiding this comment

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

I did some testing, and headlines can go as deep as 6 #'s, so these sub-section could be headlined too.

docs/technical-documentation/migration-overview.md Outdated Show resolved Hide resolved
@manez
Copy link
Member

manez commented Sep 3, 2020

Looks good @ysuarez !

My computer's in the shop and I'm using a temp machine that I can't build docs on, so I'm going to hold off on merging — unless some one else in @Islandora/8-x-committers can spin this up and make sure it all builds in mkdocs?


### Migrate API

Uses the Drupal 8 [Migrate API](https://www.drupal.org/docs/8/api/migrate-api/migrate-api-overview), which "provides services for migrating data from a source system to Drupal 8.
Copy link
Member

Choose a reason for hiding this comment

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

This builds fine and displays nicely. Just wondering about the start of this sentence. It feels like it is missing something?

Copy link
Member

Choose a reason for hiding this comment

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

It reads consistent with the rest of the document. Improvements can always happen later.


### Islandora Workbench

https://github.com/mjordan/islandora_workbench
Copy link
Member

Choose a reason for hiding this comment

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

Could you make this URL a hyperlink to its location. Just so people can click through


[![Migrating from Islandora 7.x to Islandora CLAW](https://img.youtube.com/vi/fEDzfSPjKEo/0.jpg)](https://www.youtube.com/watch?v=fEDzfSPjKEo)
[![Islandora Webinar: Migrating from Islandora 7 to Islandora 8](https://img.youtube.com/vi/n0kLOB8ZdbM/0.jpg)](https://www.youtube.com/watch?v=n0kLOB8ZdbM)
Nov 21, 2019

For tools to migrate into Islandora 8 from an existing Islandora 7 instance, please see [migrate_7x_claw](https://github.com/Islandora-devops/migrate_7x_claw)
Copy link
Member

Choose a reason for hiding this comment

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

While you're in here, seems like this should point to your new Migration Overview page instead or at least reference the CSV migration module.

@rosiel
Copy link
Member

rosiel commented Sep 3, 2020

LGTM. Thank you @ysuarez!

@whikloj
Copy link
Member

whikloj commented Sep 3, 2020

You all can go ahead and merge it then, I don't want to hold anything up.

@rosiel rosiel merged commit a4bf86b into Islandora:main Sep 4, 2020
@rosiel
Copy link
Member

rosiel commented Sep 4, 2020

Oops - failed to deploy - invalid option "--token=".

https://travis-ci.com/github/Islandora/documentation/jobs/381154974

I'll see if i can kick at this and get it up on http://islandora.github.io/documentation/ !

@rosiel
Copy link
Member

rosiel commented Sep 4, 2020

Travis needed a github token that was set to the 'main' branch, not 'master'.

Check out this beautiful work! http://islandora.github.io/documentation/technical-documentation/migration-overview/

dannylamb pushed a commit that referenced this pull request Sep 11, 2020
* Added link to newer migration Youtube vid, added migration-overview.md

* Replaced used of "*" with "-" for bulleted lists

* Updated headings in docs and spelling changes
whikloj pushed a commit that referenced this pull request Sep 30, 2020
* Render the example helpful tip properly. (#1586)

* Render the example helpful tip properly.

* Fix note syntax, again.

* Mention the User Call (#1587)

* Update rdf-mapping.md doc (#1585)

* Update committers.md (#1592)

* Fix committer nomination email address (#1593)

* Fix old email address.

* Update closeCommitterVote.txt

* De-CLAW

* De-CLAW

* DeCLAW

* Change email

* De-CLAW

* Update travis for the main branch switch (#1594)

* Master -> Main Rename

* Remove comments about WebAC (#1555)

* Remove comments about WebAC

WebAC is not used but is listed as a feature added when using Fedora. Although it is there, I'd suggest leaving off of this documentation.

* Update user-intro.md

* Add more details about starting up an islandora. (#1597)

* Add more details about starting up an islandora.

* Update index.md

* Mention use of dev branch for prebuilt base box

* Update index.md

* Fix typo in VBE

* Make clearer the different levels of sandbox reqs.

* Update CONTRIBUTING.md (#1601)

* Add Jordan to committers list (#1602)

* Migration docs updates (#1603)

* Added link to newer migration Youtube vid, added migration-overview.md

* Replaced used of "*" with "-" for bulleted lists

* Updated headings in docs and spelling changes

* Main update (#1612)

* Render the example helpful tip properly. (#1586)

* Render the example helpful tip properly.

* Fix note syntax, again.

* Update rdf-mapping.md doc (#1585)

Co-authored-by: Eli Zoller <5439169+elizoller@users.noreply.github.com>

* Merge changes to add @manez to committers. (#1613)

* Merge changes to add @manez to committers.

* Alphabeticalize committer names.

Co-authored-by: dannylamb <dlamb@islandora.ca>

* De-CLAWing

* Derp

* Missing parenthesis

Co-authored-by: Rosie Le Faive <lefaive@gmail.com>
Co-authored-by: Eli Zoller <5439169+elizoller@users.noreply.github.com>
Co-authored-by: Jonathan Green <jonathan.green@lyrasis.org>
Co-authored-by: Don Richards <DonRichards@utk.edu>
Co-authored-by: Melissa Anez <manez@islandora.ca>
Co-authored-by: Yamil <ysuarez@users.noreply.github.com>
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