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

Should there be a warning that the docs are for ISLE7 / Islandora 7 and not for ISLE2 / Islandora 2 #451

Open
ysuarez opened this issue Dec 21, 2022 · 1 comment

Comments

@ysuarez
Copy link
Contributor

ysuarez commented Dec 21, 2022

Issue description

Someone I met though slack at the last Islandoracon (2022) just asked me if they could use the ISLE7 doc pages for ISLE2 work. Though he just used the term ISLE.

Therefore, should there be a warning near the top of the main docs page (and maybe the install pages too) that these docs are for ISLE7 / Islandora 7 and not ISLE2 / Islandora 2?

I noticed that in the Islandora 2 official docs on the intro page to ISLE(2) it says...
"...
See here if you are looking for ISLE for Islandora Legacy.
..."

The URL above points to here: https://islandora-collaboration-group.github.io/ISLE/

I was thinking of adding a markdown "admonition" to alert users what we normally say on to folks in places like slack. That ISLE7 is an older project, and that new installations should Islandora 2 and ISLE2 or playbook.

I would suggest that we point folks to this link:
https://islandora.github.io/documentation/installation/docker-introduction/

Here is a quick mock up

!!! warning ""
You are looking at the ISLE legacy project docs that relies on the legacy Islandora 7 code base using Drupal 7. this project is also informally referred to as ISLE7. This project is only receiving security patches. 

All new instances of Islandora should be based on the newer Islandora 2 code, and installed using the newer ISLE installation method documented [here](https://islandora.github.io/documentation/installation/docker-introduction/).

This is only a suggestion, feel free to suggest different warning text.

@DonRichards
Copy link

DonRichards commented May 15, 2024

There is a message but the mkdocs need to be compiled and pushed since the docs don't match the docs pages. This came up in the tech call because of this ticket.

Public Docs
Screenshot 2024-05-15 at 1 19 57 PM

Markdown file
Screenshot 2024-05-15 at 1 20 46 PM

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

No branches or pull requests

2 participants