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

"Islandora 8" audit #2084

Merged
merged 23 commits into from
Apr 13, 2022
Merged

"Islandora 8" audit #2084

merged 23 commits into from
Apr 13, 2022

Conversation

rosiel
Copy link
Member

@rosiel rosiel commented Apr 8, 2022

[Edit to add ticket:] #1984

Purpose / why

Islandora 8 appears a lot in the documentation

What changes were made?

going through some pages to remove "Islandora 8" and replace it with "Islandora" vs Legacy.

Verification

Does this still make sense?

Interested Parties

Replace this text - Name some folks who may be interested, if documentation related mention @Islandora/documentation, or, if unsure, @Islandora/committers


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
Contributor

@seth-shaw-unlv seth-shaw-unlv left a comment

Choose a reason for hiding this comment

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

Just one little nit-pick, we should be consistent using "Markdown" (this is the form used by the original creator) instead of "MarkDown".

Otherwise, this all looks good to me.

@rosiel rosiel changed the title Rosiel audit 8 "Islandora 8" audit Apr 8, 2022
@rosiel
Copy link
Member Author

rosiel commented Apr 8, 2022

Just one little nit-pick, we should be consistent using "Markdown" (this is the form used by the original creator) instead of "MarkDown".

Otherwise, this all looks good to me.

Don't get me started on OpenSeadragon...

@seth-shaw-unlv
Copy link
Contributor

So far so good.

@rosiel rosiel marked this pull request as ready for review April 8, 2022 20:23
@rosiel
Copy link
Member Author

rosiel commented Apr 8, 2022

There are a lot of files to go but I'm going to trim this here and do further PRs for the next ones. (advice would be welcomed, too. It's so tempting to proofread while I have the files open but I might have to stop in the name of getting it done)

@ysuarez
Copy link
Contributor

ysuarez commented Apr 8, 2022

Should we add entries in the glossary for "Islandora Legacy" and/or "Islandora 8" too to help others with thsi transition in terms? I can create a new PR for it or try to push to @rosiel PR?

@misilot
Copy link
Contributor

misilot commented Apr 10, 2022

@rosiel I opened a PR against your branch if you want to take a look at that.

@rosiel
Copy link
Member Author

rosiel commented Apr 11, 2022

Thanks Tom. The reason I was doing it manually was for catching things like "Islandora 7 and 8" and leaving "Islandora 8" if it's in the title of a recorded youtube video or presentation. I was also doing a mild sanity check as I went, since this update is going to change the "last edited" date. That's why i stopped at 12 files. Let me bring this back to "Draft" status and pull in your changes.

@rosiel rosiel marked this pull request as draft April 11, 2022 12:14
@misilot
Copy link
Contributor

misilot commented Apr 11, 2022

Oh, sorry!

@rosiel rosiel marked this pull request as ready for review April 11, 2022 13:47
@rosiel
Copy link
Member Author

rosiel commented Apr 11, 2022

Thank you so much @misilot ! Your help was a huge time-saver. @ysuarez I love the suggestion, and just added it.

@misilot
Copy link
Contributor

misilot commented Apr 11, 2022

Glad it was was helpful in the end! Sorry you had to change "OpenSeadragon" back to "Open Seadragon". I had gone with the spelling/formatting from https://openseadragon.github.io/

@rosiel
Copy link
Member Author

rosiel commented Apr 11, 2022

That's correct. But as docs, I think they should be descriptive of what the user sees in the UI. That's why I was careful to leave the module name and file formatter as OpenSeadragon while the Context, Media Display Mode, Node Display Mode, and Taxonomy Term, are all as they appear, wrongly, Open Seadragon.

@seth-shaw-unlv seth-shaw-unlv self-requested a review April 13, 2022 17:28

Islandora 8 is open source and released under MIT and GPLv2 licenses. The software and associated documentation is developed collectively by a community of contributors and committers. All interested community members are encouraged to contribute to the project. Contributors who demonstrate sustained engagement with the project through quality participation in meetings, mailing lists, documentation and code updates can be nominated by existing committers to also become a committers. It should be emphasized that committers need not be limited to software developers. Community members with skills in documentation and testing, for example, can also be committers.
Islandora is open source and released under MIT and GPLv2 licenses. The software and associated documentation is developed collectively by a community of contributors and committers. All interested community members are encouraged to contribute to the project. Contributors who demonstrate sustained engagement with the project through quality participation in meetings, mailing lists, documentation and code updates can be nominated by existing committers to also become a committers. It should be emphasized that committers need not be limited to software developers. Community members with skills in documentation and testing, for example, can also be committers. We maintain a separate list of [Islandora Legacy Committers](https://github.com/Islandora/islandora/wiki/Islandora-Committers)
Copy link
Contributor

Choose a reason for hiding this comment

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

Nit-pick: missing a period at the end of the paragraph.

@@ -26,4 +26,4 @@ ERROR: for isle-dc_mariadb_1 UnixHTTPConnectionPool(host='localhost', port=None

you can try quitting Docker completely (make sure there is no whale icon in your top toolbar - may need to select "Quit" from the whale icon itself) and then restart Docker.
### 504 Bad Gateway
If you get a white screen with a 504 Bad Gateway error, this means your containers haven't finished initializing themselves yet. If you've waiting an appropriate amount of time (2-5 minutes), then there is most likely an error in a container's startup script. Use `docker ps -a` to see which services have `Exited` status, and then tail their logs with `docker-compose logs service_name`.
If you get a white screen with a 504 Bad Gateway error, this means your containers haven't finished initializing themselves yet. If you've waiting an appropriate amount of time (2-5 minutes), then there is most likely an error in a container's startup script. Use ` docker ps -a` to see which services have `Exited` status, and then tail their logs with `docker-compose logs service_name`.
Copy link
Contributor

Choose a reason for hiding this comment

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

There shouldn't be a space between "`" and "docker".

@seth-shaw-unlv
Copy link
Contributor

@rosiel , just two small adjustments then 👍.

@misilot
Copy link
Contributor

misilot commented Apr 13, 2022

@seth-shaw-unlv I made the changes if you want to review at rosiel#2

@seth-shaw-unlv
Copy link
Contributor

That is one way to do it.

@seth-shaw-unlv seth-shaw-unlv merged commit 81c9a71 into Islandora:main Apr 13, 2022
@rosiel rosiel deleted the rosiel-audit-8 branch April 14, 2022 17:08
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