[STCOR-591] Allow custom URL for Help link Created: 11/Feb/22  Updated: 10/May/22  Resolved: 10/May/22

Status: Closed
Project: stripes-core
Components: None
Affects versions: None
Fix versions: None

Type: Story Priority: P3
Reporter: Ian Walls Assignee: Unassigned
Resolution: Duplicate Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original estimate: Not Specified

Issue links:
Duplicate
is duplicated by STCOR-621 allow override of help-link URL Closed
Relates
relates to UXPROD-2985 Add flower release to System Informat... Draft
Sprint:
Development Team: Stripes Force
RCA Group: TBD

 Description   

Current situation or problem:

Currently, all FOLIO installs, regardless of version are hardcoded to link to docs.folio.org in the Help icon on the top navigation bar.  As the documentation working group expands documentation to cover multiple versions, it becomes necessary to update the Help link to point to the specific version of FOLIO installed (e.g. iris.docs.folio.org, juniper.docs.folio.org, etc.).  This cannot be done now without changing stripe-core code found at https://github.com/folio-org/stripes-core/blob/874cdfc874698549b7dda61ee22ed465ed9c42b3/src/components/MainNav/MainNav.js#L217.

In scope

**Allow hosts to specify, as part of configuration rather than code, the URL for the Help icon when deploying FOLIO.

Out of scope

**Automatic linking to the correct version of the documentation based on the version deployed.

Use case(s)

  • Library A is currently running FOLIO Juniper, and would like to see documentation relevant to features newly released in that version
  • Library B is self-hosted, and maintaining their own documentation website.  They would like their Help icon to link to their documentation, rather than the community documentation.

Proposed solution/stories

Add a variable to stripes.config.js to allow the URL to be specified; if none specified, fall back to docs.folio.org (to provide backwards compatibility)

 



 Comments   
Comment by Khalilah Gambrell [ 10/May/22 ]

Duplicated by STCOR-621 Closed

Generated at Fri Feb 09 00:32:59 UTC 2024 using Jira 1001.0.0-SNAPSHOT#100246-sha1:7a5c50119eb0633d306e14180817ddef5e80c75d.