Skip to content

Instance specific customization #40

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

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

Conversation

kdp-cloud
Copy link
Contributor

  • Introduced new config variables for other instances of FAIRDOM-SEEK, with defaults
seek_instance:
  name: "FAIRDOM-SEEK"
  url: "https://fairdomhub.org"
  • Added a new layout for customizing the page's title with the instance name
  • Replaced 'FAIRDOM-SEEK' with the instance's name where (I think) it makes sense
  • Idem for 'https://fairdomhub.org', which is replaced with the instance's url
  • Added an extra section on the home page describing the instance itself. This is only rendered if the instance name is different from 'FAIRDOM-SEEK'
    image
    image
  • Closes Use more config variables for FAIRDOM SEEK mentions #20

Copilot

This comment was marked as resolved.

@kdp-cloud kdp-cloud requested a review from Copilot April 24, 2025 13:26
Copilot

This comment was marked as resolved.

@kdp-cloud kdp-cloud requested a review from Copilot April 24, 2025 13:32
Copilot

This comment was marked as resolved.

@kdp-cloud kdp-cloud requested a review from Copilot April 24, 2025 13:36
Copilot

This comment was marked as resolved.

@PhilReedData
Copy link
Collaborator

Thanks Kevin, I'll check this carefully in the next few days.

@kdp-cloud
Copy link
Contributor Author

Thanks @PhilReedData! I just want to add here that I like other instances can easily personalize their docs but this will make it more complicated for contributors, as they now have to think about "Do I mean the FAIRDOM-SEEK software, or do I mean the instance's name". I feel that if we go down that route, we should carefully document this.

Also for the page title, I needed to add some javascript that changes the title client-side, which is definitely not my preferred way of doing things. But as far as I know, you can't make variables in front matter dynamic and this is the only solution I could come up with. If you know of a better one, do let me know because I'm not much of a Jekyll expert.

@PhilReedData
Copy link
Collaborator

Good point, yes we need to be careful here and document it, and keep things as simple as we can.

Did you see Stuart's comment in the issue, that sometimes it will be appropriate to say 'FAIRDOM-SEEK' rather than the name of the instance, for example when talking about the overall platform.

I've put aside time on Tuesday morning next week to dive into this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: In Progress
Development

Successfully merging this pull request may close these issues.

Use more config variables for FAIRDOM SEEK mentions
2 participants