Skip to content

Use more config variables for FAIRDOM SEEK mentions #20

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
bedroesb opened this issue Feb 21, 2025 · 5 comments · May be fixed by #40
Open

Use more config variables for FAIRDOM SEEK mentions #20

bedroesb opened this issue Feb 21, 2025 · 5 comments · May be fixed by #40
Assignees

Comments

@bedroesb
Copy link
Contributor

When the documentation will be deployed for another instance, it can be easily changed by setting the variable.

@PhilReedData
Copy link
Collaborator

Good idea, I will look into this. I have seen it done in TeSS, for example; are there other Jekyll/ETT sites which do it? Is _config.yml the best place to set this variable?

@PhilReedData PhilReedData self-assigned this Feb 24, 2025
@bedroesb
Copy link
Contributor Author

bedroesb commented Feb 24, 2025

To start of you can replace everywhere the mention of FAIRDOM SEEK with {{ site.title }} which will give https://github.com/seek4science/seek-documentation/blob/main/_config.yml#L12

@PhilReedData
Copy link
Collaborator

PhilReedData commented Apr 14, 2025

Question for @NielsGeudens and @kdp-cloud: I'm looking at what config variables would be helpful for documentation that forks the main SEEK docs. For example, Bert has suggested {{ site.title }} which would be FAIRDOM-SEEK by default. Do you have any suggestions for DataHub or others? I will come up with a list and bring it to a SEEK tech call in the next few weeks. Perhaps we could start collecting useful config varaibles in this issue.

I will update the aliases page as well, which can be inspiration. Some more aliases suggestions came up at the FAIRDOM Mini Hackathon which I will be adding soon.

I might be inspired by the config feature in TeSS, for supporting forks (eg SciLifeLab, Taxila). Or possibly the locales feature in TeSS, for supporting translation. I couldn't find the equivalent site name/title configuration setting in the SEEK code or docs.

@PhilReedData
Copy link
Collaborator

@kdp-cloud to look at adding site name variable to the config for parent SEEK Docs, as seen in DataHub.

@stuzart
Copy link
Member

stuzart commented Apr 23, 2025

should be careful to keep separate the software title and the instance name. FAIRDOM-SEEK is still the underlying software even if the instance has it's own name. For example IBISBAHub is the instance name, but FAIRDOM-SEEK is still the software.

@kdp-cloud kdp-cloud linked a pull request Apr 24, 2025 that will close this issue
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 a pull request may close this issue.

4 participants