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

Product Template Version 2 #306

Open
wants to merge 312 commits into
base: main
Choose a base branch
from
Open

Conversation

benji-glitsos-ga
Copy link
Collaborator

@benji-glitsos-ga benji-glitsos-ga commented Sep 4, 2024

A new 'v2' product page template. (Old versions of product pages remain on the v1 template, by design.)

Preview of the template (DEA Intertidal)

View the template code

Features:

  • Redesigned product header box
    • New 'Resolution' field.
    • Renamed to 'Data from' field.
    • New 'Data updates' field.
    • 'Next update due' field was removed
    • And other minor changes.
  • Key specifications section
    • Renamed 'Key details' section to 'Key specifications'.
    • Added 'Currency' field.
    • Moved 'Product ID' field down here from header.
    • 'DOI' field now uses the DOI link instead of the Ecat link.
    • Added links to all the 'Collection' fields.
  • New Specifications tab
    • Contains sections: Bands, Attributes, Classification.
    • Collects fields from the header and 'key specifications' sections into one place, and provides help text to explain these fields.
    • Each product page now has a _figures.yaml file.
  • New Tags feature
    • Using simple search links for 'tags'.
    • Deleted redundant 'sphinx tags' monkey-patched extension.
  • 'Old versions' terminology is renamed to 'Version history'
    • URL paths were changed to version-history, redirects created, and links changed.
    • Terminology was changed in the UI.
    • The version history list now lists the current version at the top.
    • In the .env file, the LOCAL_ENABLE_OLD_VERSIONS variable is renamed to LOCAL_ENABLE_VERSION_HISTORY
  • Code improvements
    • Refactored the code. Notably, used block assignment and dictionaries to structure code.
    • The ability to load multiple data files (such as YAML) into the template
  • 'Access' UI text
    • Swapped the UI text: access_labels with access_names.
    • Removed redundant 'name' values in the _data.yaml; using default fallbacks instead.
  • Applied some standard ARD header images
  • Numerous small improvements

TODO

  • Update the product starter kit with all changes
  • Update the internal documentation

benji-glitsos-ga and others added 30 commits July 1, 2024 10:37
@benji-glitsos-ga benji-glitsos-ga changed the title Product Template Version 2 (product-v2) Product Template Version 2 Oct 2, 2024
@benji-glitsos-ga benji-glitsos-ga marked this pull request as ready for review October 7, 2024 23:50
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.

3 participants