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

Master -> Main Rename #1596

Merged
merged 19 commits into from
Sep 30, 2020
Merged

Master -> Main Rename #1596

merged 19 commits into from
Sep 30, 2020

Conversation

dannylamb
Copy link
Contributor

Part of #1595

CONTRIBUTING.md Outdated
@@ -58,9 +58,9 @@ Contributions to the Islandora codebase should be sent as GitHub pull requests.

Take a look at [Creating a pull request](https://help.github.com/articles/creating-a-pull-request). In a nutshell you need to:

1. [Fork](https://help.github.com/articles/fork-a-repo) this repository to your personal or institutional GitHub account (depending on the CLA you are working under). Be cautious of which branches you work from though (you'll want to base your work off master, or for Drupal modules use the most recent version branch). See [Fork a repo](https://help.github.com/articles/fork-a-repo) for detailed instructions.
1. [Fork](https://help.github.com/articles/fork-a-repo) this repository to your personal or institutional GitHub account (depending on the CLA you are working under). Be cautious of which branches you work from though (you'll want to base your work off mainor for Drupal modules use the most recent version branch). See [Fork a repo](https://help.github.com/articles/fork-a-repo) for detailed instructions.
Copy link
Member

Choose a reason for hiding this comment

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

script failure master, or -> mainor

CONTRIBUTING.md Outdated
2. Commit any changes to your fork.
3. Send a [pull request](https://help.github.com/articles/creating-a-pull-request) using the [pull request template](https://github.com/Islandora/documentation/blob/master/.github/PULL_REQUEST_TEMPLATE.md) to the Islandora GitHub repository that you forked in step 1. If your pull request is related to an existing issue -- for instance, because you reported a [bug/issue](https://github.com/Islandora/documentation/issues) earlier -- prefix the title of your pull request with the corresponding issue number (e.g. `issue-123: ...`). Please also include a reference to the issue in the description of the pull. This can be done by using '#' plus the issue number like so '#123', also try to pick an appropriate name for the branch in which you're issuing the pull request from.
3. Send a [pull request](https://help.github.com/articles/creating-a-pull-request) using the [pull request template](https://github.com/Islandora/documentation/blob/maingithub/PULL_REQUEST_TEMPLATE.md) to the Islandora GitHub repository that you forked in step 1. If your pull request is related to an existing issue -- for instance, because you reported a [bug/issue](https://github.com/Islandora/documentation/issues) earlier -- prefix the title of your pull request with the corresponding issue number (e.g. `issue-123: ...`). Please also include a reference to the issue in the description of the pull. This can be done by using '#' plus the issue number like so '#123', also try to pick an appropriate name for the branch in which you're issuing the pull request from.
Copy link
Member

Choose a reason for hiding this comment

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

Script failure /blob/master/.github -> /blob/maingithub

@@ -14,13 +14,13 @@ The Drupal Flysystem module uses [flysystem stream wrappers](https://github.com/

### The Plugin and Adapter

Islandora 8 implements a [Flysystem adapter](https://github.com/Islandora-CLAW/islandora/blob/8.x-1.x/src/Flysystem/Adapter/FedoraAdapter.php) and a [Drupal Flysystem plugin](https://github.com/Islandora-CLAW/islandora/blob/8.x-1.x/src/Flysystem/Fedora.php). The Flysystem adapter acts as an intermediary between the Flysystem filesystem API and Fedora, translating requests and responses between them. The adapter interacts with Fedora using an instance of the [Chullo Fedora API](/Islandora-CLAW/chullo/blob/master/src/IFedoraApi.php) it receives from the Drupal Flysystem plugin. The Drupal Flysystem plugin's main responsibility is to instantiate the Chullo Fedora API object with the proper authentication and pass it to the Flysystem adapter. To authenticate with Fedora the plugin adds a [handler](http://docs.guzzlephp.org/en/stable/handlers-and-middleware.html) to the Chullo's [Guzzle](http://docs.guzzlephp.org) client which adds a [JWT](https://jwt.io/) authentication header to each request. <!-- After https://github.com/Islandora-CLAW/islandora/pull/119 is merged: To authenticate with Fedora the plugin adds a handler to the Chullo's Guzzle client with a copy of the site's JWT authentication object so that each Fedora request can generate its own Bearer token. -->
Islandora 8 implements a [Flysystem adapter](https://github.com/Islandora-CLAW/islandora/blob/8.x-1.x/src/Flysystem/Adapter/FedoraAdapter.php) and a [Drupal Flysystem plugin](https://github.com/Islandora-CLAW/islandora/blob/8.x-1.x/src/Flysystem/Fedora.php). The Flysystem adapter acts as an intermediary between the Flysystem filesystem API and Fedora, translating requests and responses between them. The adapter interacts with Fedora using an instance of the [Chullo Fedora API](/Islandora-CLAW/chullo/blob/main/src/IFedoraApi.php) it receives from the Drupal Flysystem plugin. The Drupal Flysystem plugin's main responsibility is to instantiate the Chullo Fedora API object with the proper authentication and pass it to the Flysystem adapter. To authenticate with Fedora the plugin adds a [handler](http://docs.guzzlephp.org/en/stable/handlers-and-middleware.html) to the Chullo's [Guzzle](http://docs.guzzlephp.org) client which adds a [JWT](https://jwt.io/) authentication header to each request. <!-- After https://github.com/Islandora-CLAW/islandora/pull/119 is merged: To authenticate with Fedora the plugin adds a handler to the Chullo's Guzzle client with a copy of the site's JWT authentication object so that each Fedora request can generate its own Bearer token. -->
Copy link
Member

Choose a reason for hiding this comment

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

This looks to have been there before but the URL for the Chullo Fedora API is missing https:/ and so the link is broken.

Also the commented out text at the bottom states

After #119 is merged:

It is merged, so this can (I assume) by revealed.

Also there were some CLAWs in here.

Suggested change
Islandora 8 implements a [Flysystem adapter](https://github.com/Islandora-CLAW/islandora/blob/8.x-1.x/src/Flysystem/Adapter/FedoraAdapter.php) and a [Drupal Flysystem plugin](https://github.com/Islandora-CLAW/islandora/blob/8.x-1.x/src/Flysystem/Fedora.php). The Flysystem adapter acts as an intermediary between the Flysystem filesystem API and Fedora, translating requests and responses between them. The adapter interacts with Fedora using an instance of the [Chullo Fedora API](/Islandora-CLAW/chullo/blob/main/src/IFedoraApi.php) it receives from the Drupal Flysystem plugin. The Drupal Flysystem plugin's main responsibility is to instantiate the Chullo Fedora API object with the proper authentication and pass it to the Flysystem adapter. To authenticate with Fedora the plugin adds a [handler](http://docs.guzzlephp.org/en/stable/handlers-and-middleware.html) to the Chullo's [Guzzle](http://docs.guzzlephp.org) client which adds a [JWT](https://jwt.io/) authentication header to each request. <!-- After https://github.com/Islandora-CLAW/islandora/pull/119 is merged: To authenticate with Fedora the plugin adds a handler to the Chullo's Guzzle client with a copy of the site's JWT authentication object so that each Fedora request can generate its own Bearer token. -->
Islandora 8 implements a [Flysystem adapter](https://github.com/Islandora/islandora/blob/8.x-1.x/src/Flysystem/Adapter/FedoraAdapter.php) and a [Drupal Flysystem plugin](https://github.com/Islandora/islandora/blob/8.x-1.x/src/Flysystem/Fedora.php). The Flysystem adapter acts as an intermediary between the Flysystem filesystem API and Fedora, translating requests and responses between them. The adapter interacts with Fedora using an instance of the [Chullo Fedora API](https://github.com/Islandora/chullo/blob/main/src/IFedoraApi.php) it receives from the Drupal Flysystem plugin. The Drupal Flysystem plugin's main responsibility is to instantiate the Chullo Fedora API object with the proper authentication and pass it to the Flysystem adapter. To authenticate with Fedora the plugin adds a [handler](http://docs.guzzlephp.org/en/stable/handlers-and-middleware.html) to the Chullo's [Guzzle](http://docs.guzzlephp.org) client which adds a [JWT](https://jwt.io/) authentication header to each request. To authenticate with Fedora the plugin adds a handler to the Chullo's Guzzle client with a copy of the site's JWT authentication object so that each Fedora request can generate its own Bearer token.

Copy link
Member

Choose a reason for hiding this comment

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

requiring the full de-clawing of the documentation right now would also require re-writing and also updating a large number of formerly-useful pages... that's an ongoing process, can we do the master-main rename first?

Copy link
Member

Choose a reason for hiding this comment

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

I have no problem not doing a full de-clawing, I just noted the changes on this line as the PR already touched it.

Copy link
Member

Choose a reason for hiding this comment

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

phew. ty. Yeah there are a number of pages in here that need love. I'm currently looking at "hacking on islandora".

@@ -2,7 +2,7 @@

The map between Drupal URIs and their corresponding Fedora URIs is stored in a service called Gemini. An Islandora "pseudo-field" can be enabled that will display the corresponding Fedora URI on the page of a node, taxonomy term, or media object. You can also query Gemini directly. Instructions for doing that are provided below.

For more information about the Gemini service, see the [Gemini README](https://github.com/Islandora-CLAW/Crayfish/tree/master/Gemini).
For more information about the Gemini service, see the [Gemini README](https://github.com/Islandora-CLAW/Crayfish/tree/main/Gemini).
Copy link
Member

Choose a reason for hiding this comment

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

CLAW in need of de-ing.

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.

oops - i caught similar things to @whikloj

CONTRIBUTING.md Outdated
@@ -12,7 +12,7 @@ If you would like to submit a use case to the Islandora 8 project, please submit

### Documentation

You can contribute documentation in two different ways. One way is to create an issue [here](https://github.com/Islandora/documentation/issues/new), prepending "Documentation:" to the title of the issue. Another way is by pull request, which is the same process as [Contribute Code](https://github.com/Islandora/documentation/blob/master/CONTRIBUTING.md#contribute-code). All documentation resides in [`docs`](https://github.com/Islandora/documentation/tree/master/docs).
You can contribute documentation in two different ways. One way is to create an issue [here](https://github.com/Islandora/documentation/issues/new), prepending "Documentation:" to the title of the issue. Another way is by pull request, which is the same process as [Contribute Code](https://github.com/Islandora/documentation/blob/mainONTRIBUTING.md#contribute-code). All documentation resides in [`docs`](https://github.com/Islandora/documentation/tree/mamains).
Copy link
Member

Choose a reason for hiding this comment

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

Oooooh this didn't go so well. But I like "mamains".

@jonathangreen
Copy link
Contributor

Something I noticed yesterday when I made #1602 is that we have some PR going into master right now and some into main, so the two branches are diverging. It looks like #1601 went in against master. And this PR is against master.

@jonathangreen
Copy link
Contributor

It seems like master needs to be merged into main and then deleted, as @whikloj noted in islandora-deprecated/ansible-role-grok#9, so they don't keep getting out of sync. Just wanted to note it here so that it doesn't get lost on this PR.

@dannylamb
Copy link
Contributor Author

rolls up his sleeves and gets to it 👨‍🔧

jonathangreen and others added 12 commits September 11, 2020 14:08
* Fix old email address.

* Update closeCommitterVote.txt

* De-CLAW

* De-CLAW

* DeCLAW

* Change email

* De-CLAW
* 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.

* 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.
* 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
* 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.

* Alphabeticalize committer names.

Co-authored-by: dannylamb <dlamb@islandora.ca>
@dannylamb
Copy link
Contributor Author

eh... that rebase half worked.... let me see...

@dannylamb dannylamb changed the base branch from master to main September 11, 2020 17:12
@dannylamb
Copy link
Contributor Author

Ok, this has master and main pulled in. Should be ready now. Please squash and merge.

@dannylamb
Copy link
Contributor Author

dannylamb commented Sep 11, 2020

You'll notice a little extra de-CLAWing 🎩

@rosiel
Copy link
Member

rosiel commented Sep 16, 2020

ping @whikloj - Github's blocking, pending your change request.

@dannylamb
Copy link
Contributor Author

@whikloj, would you mind releasing your hold on this one?

@dannylamb
Copy link
Contributor Author

@whikloj bump

@whikloj whikloj merged commit 49a9c8a into main Sep 30, 2020
@whikloj whikloj deleted the master-main-rename branch September 30, 2020 17:58
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.

8 participants