[FOLIO-1007] About FOLIO Page at {base-url}/settings Created: 02/Jan/18  Updated: 22/Apr/22

Status: Open
Project: FOLIO
Components: None
Affects versions: None
Fix versions: None

Type: Story Priority: P3
Reporter: Cate Boerema (Inactive) Assignee: Peter Murray
Resolution: Unresolved Votes: 0
Labels: delegate_candidate, ui-only
Remaining Estimate: Not Specified
Time Spent: 1 hour, 15 minutes
Original estimate: Not Specified

Attachments: PNG File english-mockup-v2.png     PNG File english-mockup.png     PNG File screenshot-1.png    
Issue links:
Relates
relates to FOLIO-1176 Add vagrant box name+version to softw... Open
relates to STCOR-603 Custom text on Settings -> About "Sof... Closed
relates to UISE-76 Update the App bundle json file Draft
relates to UIIN-153 Update the App bundle json file Draft
relates to STCOR-123 Move FOLIO Versions Page (AKA "About"... Closed
relates to UXPROD-2985 Add flower release to System Informat... Draft
Sprint:
Development Team: Stripes Force

 Description   

Purpose: Provide the name of the release, a copyright statement, and a link to the FOLIO website.

Proposed text

The FOLIO Library Services Platform.
<Release> Release.

Unless otherwise noted, copyright (c) 2016-2020 The Open Library Foundation

Unless otherwise noted, all software is distributed under the terms of the Apache License, Version 2.0. The FOLIO logo cannot be altered without permission from the Open Library Foundation. FOLIO logos and iconography are provided for use under the FOLIO logo guidelines, [URL tbd]. Other names may be trademarks of their respective owners.

For more information about FOLIO, see <a href="https://www.folio.org">www.folio.org</a>.

h2. Stretch Goal: Include the introductory paragraph from Wikipedia under the release name.
1. Call the wikipedia API to get the wikipedia page ID: https://en.wikipedia.org/w/api.php?format=json&action=query&prop=extracts&exintro&explaintext&redirects=1&titles=<release>
2. Parse JSON for `query.pages[0].pageid`
3. Call the language-specific API with the page ID. Note the language abbreviation in the hostname: https://es.wikipedia.org/w/api.php?format=json&action=query&prop=extracts&exintro&explaintext&redirects=1&pageids=<pageid>
4. Parse JSON for `query.pages[0].extract` and print value.
5. Parse JSON for `query.pages[0].fullurl` to Wikipedia page with anchor text of "From Wikipedia"

Example URLs for Goldenrod and Spanish language:



 Comments   
Comment by Cate Boerema (Inactive) [ 02/Jan/18 ]

Peter Murray, do you have ideas for this page? Anyone else I should tag here?

Comment by Peter Murray [ 02/Jan/18 ]

I think you've hit the highlights. I would add a link to the main www.folio.org page and a link top level of end-user documentation (when we get that).

I don't think we need to tag too many people at this point – start with the basic info and file issues against the about page later as more needs are identified.

Comment by Cate Boerema (Inactive) [ 03/Jan/18 ]

Thanks, Peter Murray. Do you know who would have the legal info that need to display? Would that need to vary depending upon whether you are hosting locally or using a hosting provider?

Mike Taylor, you mentioned that there won't be a single version number for FOLIO until we start doing batched releases in a single package. Do you know if we plan to start doing that and when? Maybe Jakub Skoczen knows? If we have an issue for that, let's link it up to this one.

Anyway, I am not sure there is any sense in creating this About FOLIO Page until we have some of the content that needs to display on it. I am just going to leave this story over here in the FOLIO project until we are ready to pull the trigger on it.

Comment by Mike Taylor [ 03/Jan/18 ]

I think we can usefully provide an About FOLIO page that links to the key websites, states the open-source licence, and says how to report bugs. None of the wording for any of that is difficult.

I don't know when or even if we plan to start doing whole-system releases. That would in many respects be counter-productive: part of the promise of FOLIO is that if you need to upgrade (say) your Users app, you can do so without having to wait years for the next gigantic monolithic release. Perhaps the best thing would be just to stamp certain snapshots with a release date.

Comment by Peter Murray [ 03/Jan/18 ]

Copywrite and bug reporting is going to be challenging. Although the modules we are working on now have their copyright owned by the Open Library Foundation, we can anticipate that won't be the case for all FOLIO apps. Likewise, there will be bug reporting tools for the core apps and separate bug reporting for non-core apps. (A third party selling a commercial app will not want to have its bug reporting run through FOLIO infrastructure.) And in both cases (core apps and third-party apps) a hosting provider may want all issues reported to them and not to any Foundation or third-party tool.

The Eclipse IDE is in somewhat of a similar situation, and it's "About" box says:

Eclipse About Box

Eclipse IDE for Java Developers

Version: Oxygen.2 Release (4.7.2)
Build id: 20171218-0600
(c) Copyright Eclipse contributors and others 2000, 2017. All rights reserved. Eclipse and the Eclipse logo are trademarks of the Eclipse Foundation, Inc., https://www.eclipse.org/. The Eclipse logo cannot be altered without Eclipse's permission. Eclipse logos are provided for use under the Eclipse logo and trademark guidelines, https://www.eclipse.org/logotm/. Oracle and Java are trademarks or registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.

This product includes software developed by other open source projects including the Apache Software Foundation, https://www.apache.org/.

It then goes on to offer icons for the various installed components that lead to more detailed versioning information and copyright details. I think we're going to need to have something in the Stripes and Okapi module descriptors that describe the license and bug reporting information for each component, then provide some sort of meaningful summary of that information to the user.

I've modified the description of this ticket to provide some proposed text. Hkaplanian – is this something we want to take to Product Council?

Comment by Michael Winkler [ 03/Jan/18 ]

Just a note that in fact, FOLIO and the FOLIO logo are not registered trademarks of the Foundation.

Comment by Peter Murray [ 03/Jan/18 ]

Feel free to make the appropriate corrections, Michael Winkler!

Comment by Peter Murray [ 04/Jan/18 ]

From the Product Council discussion on 20180104: The most appropriate group to work on this is the marketing group. Peter Murray will bring it to that group for further refinement before bringing back to Product Council for approval.

Comment by Mike Taylor [ 05/Jan/18 ]

Sheesh, what a lot of palaver.

Comment by Peter Murray [ 15/Sep/20 ]

Placeholder comment to hold the mock-up HTML.

<div style="padding: 15px;"><p style="font-size: 2em; font-weight: bold;">The FOLIO Library Services Platform.<img style="float: right;" src="https://www.folio.org/wp-content/uploads/2020/01/goldenrod-badge.png" width="250"><br>
  Goldenrod Release.</p>
  <p style="font-style: italic;">Solidago, commonly called goldenrods, is a genus of about 100 to 120 species of flowering plants in the aster family, Asteraceae. Most are herbaceous perennial species found in open areas such as meadows, prairies, and savannas. They are mostly native to North America, including Mexico; a few species are native to South America and Eurasia. Some American species have also been introduced into Europe and other parts of the world.<br><a href="https://example.com/">From Wikipedia</a></p>
<br clear="all">
  <p>Unless otherwise noted, copyright (c) 2016-2020 The Open Library Foundation</p>
  <p>Unless otherwise noted, all software is distributed under the terms of the Apache License, Version 2.0.  The FOLIO logo cannot be altered without permission from the Open Library Foundation. FOLIO logos and iconography are provided for use under the <a href="https://www.folio.org/wp-content/uploads/2018/09/FOLIO_BrandIdentity_Guidelines_0318_FINAL.pdf">FOLIO branding guidelines</a>. Other names may be trademarks of their respective owners.</p>
  <p>For more information about FOLIO, see <a href="https://www.folio.org/">www.folio.org</a>.</p>
</div>
Comment by Peter Murray [ 15/Sep/20 ]

Rachel Fadlon: This is the description and mock-up that I came up with. Is this okay to pass along to a development team?

Comment by Mike Taylor [ 16/Sep/20 ]

Doesn't that stretch goal mean that anyone in the world can edit the content of the FOLIO About page?

Comment by Rachel Fadlon [ 16/Sep/20 ]

Peter Murray I'd love to add an image, either of the release badge or of the flower if possible. Other than that looks good - thanks!

Comment by Peter Murray [ 16/Sep/20 ]

Doesn't that stretch goal mean that anyone in the world can edit the content of the FOLIO About page?

Yes, although it would mean defacing a Wikipedia page. I was looking for a relatively simple place to get information about the flower for the named release. Alternatively, we could compose a paragraph ourselves, but we would have to get it translated through Lokalise whereas Wikipedians have done that already.

I'd love to add an image, either of the release badge or of the flower if possible. Other than that looks good - thanks!

How does this look?

Comment by Rachel Fadlon [ 16/Sep/20 ]

Peter Murray I like it! Thanks!

Comment by Mike Taylor [ 16/Sep/20 ]

Yes, although it would mean defacing a Wikipedia page.

That's a low bar. It happens all the time. I would be very wary of leaving open an easy way for an unethical competitor or disgruntled customer to put (for example) pornography on the About page of every FOLIO installation in the world.

If you're keen to do this, let's at least have it locked to the versions of a specific timestamp, so they can be vetted.

Comment by Peter Murray [ 16/Sep/20 ]

I'm not sure about pornography–the output of the API is simple text (compare the output of the API call with the top section of the Wikipedia page. Locking it to a particular version is problematic because there would be different version identifiers for each of the different languages.

Cate Boerema: Could I get your help moving this into the appropriate development team backlog? It doesn't seem to fit any one of the established teams.

Comment by Mike Taylor [ 16/Sep/20 ]

Well, pornography can be written as well as photographed. But it doesn't need to be that: it could be anything. A misleading statement about how FOLIO is funded. Defamatory remarks about litigious celebrities. Political advocacy. All of it wide, wide open for (again I must emphasize) literally anyone in the whole world to edit at will.

I will say no more about this, since the decision is clearly above my pay grade, but I urge you as strongly as I possibly can to rethink this very badly flawed design. And this that, I bow out.

Comment by Cate Boerema (Inactive) [ 17/Sep/20 ]

Thanks Peter Murray So, if we display the release name, does that mean we need to write a story to update this page with every release or can it update dynamically? How important is this? It has been open for years and no one has made any noise about it. I am surprised to see it come back to life after all this time.

Comment by Peter Murray [ 18/Sep/20 ]

I will say no more about this, since the decision is clearly above my pay grade, but I urge you as strongly as I possibly can to rethink this very badly flawed design. And this that, I bow out.

A well-reasoned argument, Mike. I've struck it from the requirements. If we want to do something like this, it is best done with static text.

So, if we display the release name, does that mean we need to write a story to update this page with every release or can it update dynamically? How important is this? It has been open for years and no one has made any noise about it. I am surprised to see it come back to life after all this time.

The idea resurfaced with a request to the Outreach SIG to have something in the installed site that says the release version. I admittedly hijacked this old issue since it was so close to the request and updated the description to match. I don't know how high it would get ranked above other stories because the request was from one site and the Outreach SIG thought it was a good idea since we are using the release names for a snapshot in time of functionality.

As for implementation, I don't know that it has to be done dynamically. Having a story for each release that modifies some statically set values somewhere seems like it would be good enough to me.

Comment by Peter Murray [ 24/Sep/20 ]

Cate Boerema: Ping.

Comment by Cate Boerema (Inactive) [ 25/Sep/20 ]

I changed the status to "Open" so it will appear in the Core Functional backlog. I'll have the team groom it when we are looking for some frontend work.

Comment by Cate Boerema (Inactive) [ 23/Oct/20 ]

Just wanted to summarize some info from a Slack discussion with Zak Burke and Marc Johnson:

  1. We can create this page in FOLIO
  2. We will update the page with each major release (not with hotfixes)
  3. Some team (Core Functional?) will have one story to update the page at the point of the initial definition of the overall release (for example, the initial release of 2020 Q3 was made around October 16, 2020)
  4. On the wiki, we should define what a “Flower version” encompasses. (Maybe it’s a collection of modules specified at the minor-release level, as above, or maybe there’s another definition, dunno.)
  5. Optional: on the wiki, enumerate the apps and their minor versions for each release. Aster contains ui-users v1.2.0 and …, Bellis contains ui-users v2.0.0 and … We can get this with relatively low effort by diving through the history of platform-complete/install.json I think.

Per Zak, "the page already exists (right now it just reads “Choose settings”) so it’s really just a matter of sourcing the right content and dressing up the existing page, a small amount of menial work. If we prepped the translations and logo assets, we could do this for Honeysuckle if folks want it. I looked for logos but the branding resources page I found appears stale."

Peter Murray do you know where we can find the up-to-date logos?

Comment by Peter Murray [ 26/Oct/20 ]

do you know where we can find the up-to-date logos?

They are on the resources section of www.folio.org: check the Branding resource type to find them.

On the wiki, we should define what a “Flower version” encompasses. (Maybe it’s a collection of modules specified at the minor-release level, as above, or maybe there’s another definition, dunno.)

I think "Flower versions" are synonymous with the formal releases. (The once four—now three—releases that the project does each year.) In fact, we could/should probably link to the release notes on this

{base-url}

/settings page. Is the release notes page a proper place to enumerate the apps and versions?

Comment by Marc Johnson [ 26/Oct/20 ]

Is the release notes page a proper place to enumerate the apps and versions?

Which set of versions would be enumerated: the initial set of versions when the release process starts, from the first public release, the latest / last hotfix?

Comment by Peter Murray [ 26/Oct/20 ]

I don't have a good answer for that Marc. We are, of course, running into the issue of what it means to be an app on a platform: in theory, there is no "release" except what we make up in our own minds. One model that makes sense to follow would be the Eclipse release train model. In that case, it would be whatever version the app is when the public release is made. Any app can have new releases applied to it, but at that point of release time it was whatever the version number was.

Comment by Marc Johnson [ 26/Oct/20 ]

Peter Murray

I don't have a good answer for that Marc.

I didn't expect you to. Your comment was my way of asking this question.

We are, of course, running into the issue of what it means to be an app on a platform: in theory, there is no "release" except what we make up in our own minds.

FOLIO doesn't really release apps at the moment, rather it releases the platform with a stock configuration of apps as a single named release.

In that case, it would be whatever version the app is when the public release is made. Any app can have new releases applied to it, but at that point of release time it was whatever the version number was.

Sure, that is one viable option. How viable that option is depends upon how important the hot fix versions are.

Comment by Julian Ladisch [ 22/Mar/22 ]

Workaround that I use to display "Folio-Snapshot 2022-01-03" (the install date) at https://folio-demo.gbv.de/settings/about :

sed -i "0,/stripes-core.about.okapiServices/ s/.*<FormattedMessage id=\"stripes-core.about.okapiServices\" \/>/Folio-Snapshot<\/Headline><p>`date -I`</p><Headline size=\"large\"><FormattedMessage id=\"stripes-core.about.okapiServices\" \/>/" ./node_modules/@folio/stripes-core/src/components/About/About.js

Run it after yarn install and before NODE_ENV=production yarn build output.

Generated at Thu Feb 08 23:10:08 UTC 2024 using Jira 1001.0.0-SNAPSHOT#100246-sha1:7a5c50119eb0633d306e14180817ddef5e80c75d.