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

Update reference_genomes_custom_genomes.md #4586

Merged
merged 9 commits into from
Dec 18, 2023

Conversation

jennaj
Copy link
Member

@jennaj jennaj commented Dec 12, 2023

Completely redone with cross-links. Easier to give a user one FAQ for this specific problem with full context re usual followup. Shows up nicely in forums.

Completely redone with cross-links. Easier to give a user one FAQ for this specific problem with full context re usual followup.
@github-actions github-actions bot added the faqs label Dec 12, 2023
@hexylena
Copy link
Member

hexylena commented Dec 13, 2023

@jennaj

Shows up nicely in forums.

I'm guessing it's not what you meant, but, we could make the GTN show up more nicely in discourse if it's helpful to you:

  1. iframes are supported, we could allow-list the GTN domain + create an embed widget
  2. apparently we can support the 'oembed' API to maybe have a richer preview that includes more of the FAQ for users, if it's helpful.

https://meta.discourse.org/t/create-rich-link-previews-with-onebox/98088

@jennaj
Copy link
Member Author

jennaj commented Dec 13, 2023

That extra would be very good. Right now I mean the FAQ title, but pushing the content itself would be fabulous. Could you help to set this up?

Related:

  1. Tutorial titles also show up already, but an extra peek would be nicer.
  2. Searches at the site render as a default GalaxyTraining! but including the search terms directly would be nicer.
  3. Title on a full topic or pathway view would also be nice to add in.

jennaj and others added 2 commits December 13, 2023 09:59
Longer but people do not end up here unless something complicated is going on. This now covers/links to everything they will need in one FAQ.
@jennaj jennaj marked this pull request as ready for review December 13, 2023 19:30
@hexylena
Copy link
Member

I think short term we can improve the title/preview, but all of those previews will be rather limited in length due to that field not supporting longer/richer texts.

long term, the oEmbed API doesn't look too bad to implement, but it'll take some more work to provide a nice experience. We'll have to decide how each type of page should look in the preview which is going to be some work, and maybe we need a dynamic page at least for the search results to render nicely which is more work, but, probably worth doing.

Doing some testing here: https://help.galaxyproject.org/t/gtn-link-preview-testing-ideas/11321

Tutorial titles also show up already, but an extra peek would be nicer.

unfortunately we are limited by what discourse will display, I've removed the truncation because some platforms seem to show longer descriptions.

here's the longest discourse will natively display, so
image

Searches at the site render as a default GalaxyTraining! but including the search terms directly would be nicer.

Again unfortunately since it's a completely static site, we can't change the title field that gets rendered to include search terms. I've got a commit adding them dynamically when you're searching, it'll show up for the user, but that doesn't solve your problem at all.

Title on a full topic or pathway view would also be nice to add in.

Oh, yes, we can improve this at least!

hexylena added a commit that referenced this pull request Dec 14, 2023
…another.md

Rewritten, updated against UI, more crosslinks.
jennaj and others added 2 commits December 14, 2023 13:40
…y_server_to_another.md


Love the typo bots!

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Copy link
Member Author

@jennaj jennaj left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

updated to remove spaces

Copy link
Member Author

@jennaj jennaj left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removed the export to file download/remote server options (on purpose). These have changed a ton and need a new FAQ that we can cross link into this one. The work is still in progress.. so maybe at next full release 24.N. I'll make a ticket as a reminder and assign myself. #4592

@jennaj
Copy link
Member Author

jennaj commented Dec 14, 2023

Failing the check for the fa-link icon. Could we add it? Could also be added here https://github.com/galaxyproject/training-material/blob/main/faqs/galaxy/datasets_icons.md

Or, am I getting the format wrong? Not sure what the ::before part means, is that the angle? Screenshot may help

Screen Shot 2023-12-14 at 2 02 13 PM

Copy link
Member Author

@jennaj jennaj left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Test link -- that seems to have been enough!

@jennaj
Copy link
Member Author

jennaj commented Dec 15, 2023

Let's also push this. I'd like to start using these for Q&A and see what else related remains are unclear to users out in the wild.

@hexylena
Copy link
Member

Could we add it?

yes, any icons you want, just add to _config.yml, it looks like we have galaxy-link already in the config. Also visible on this page.

I'm not sure how it works with just {% icon link %}, maybe our icon plugin is doing more than I thought, well, this works :)

Not sure what the ::before part means, is that the angle

it's a css selector, you just want link

@hexylena hexylena merged commit b903d70 into main Dec 18, 2023
1 check passed
@jennaj jennaj deleted the jennaj-faq-customgenomecoping branch December 18, 2023 17:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants