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

Architecture ideas for Samvera websites #131

Open
adamjarling opened this issue Jan 10, 2024 · 2 comments
Open

Architecture ideas for Samvera websites #131

adamjarling opened this issue Jan 10, 2024 · 2 comments
Assignees
Labels
enhancement New feature or request in progress Currently being worked on

Comments

@adamjarling
Copy link
Member

One idea is to move towards a common solution for how Hyrax, Hyku, and Avalon websites are built. Currently there are three different solutions for the mentioned sites (Jekyl, WordPress, etc).

  • Could this be a static NextJS site build (similar to Samvera.org)?
  • Can we share components?
  • How to handle theming?
  • How to make the architecture more inclusive, and not tethered to a single developer (risk management, or identifying what tools Samvera really wants to highlight?
@adamjarling adamjarling self-assigned this Jan 10, 2024
@adamjarling adamjarling added the enhancement New feature or request label Jan 10, 2024
@adamjarling
Copy link
Member Author

@heathergreerklein

Samvera_Family_Website_Architecture_Idea_#1

@adamjarling adamjarling added the in progress Currently being worked on label Apr 17, 2024
@adamjarling
Copy link
Member Author

adamjarling commented May 1, 2024

Diagram summary

This approach to combining Samvera organization sites puts a headless CMS (Contentful) at the core of providing data for different websites (samvera.org, Hyku, Hyrax, Avalon). There would be credentials for maintainers of the sites set up in Contentful, and each application's data would be updatable via Contentful, and pass through to the respective website.

A shared generic template would be set up for each site. If we run with the current model for Samvera.org, this could be a NextJS site, which creates a static site which is hosted directly within it's Github repository via Github Pages.

The following, separate Samvera repositories would exist:

  • Generic template repository
  • Shared React components repository
  • Samvera.org repository (exists)
  • Avalon promo site repository (new)
  • Hyku promo site repository (new)
  • Hyrax promo site repository (new)

Some data would be shared across templates (maybe News Items, Navigation, etc). And some data would be unique to each website. The idea is it model this information structure within Contentful, and then represent it in the UI for each website.

Work to do

  • Clean up existing samvera.org NextJS template
    • Move to app based routing (future proof the template)
  • Research best practices on multiple authors within Contentful
  • Get agreement on developer(s) in the Community can support such a setup
  • Create new repositories, and an MVP site to prove this out (Hyrax?)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request in progress Currently being worked on
Projects
None yet
Development

No branches or pull requests

1 participant