Skip to content

Theming still needed for "general" guide pages #280

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
lailleo opened this issue Jul 14, 2022 · 11 comments
Open

Theming still needed for "general" guide pages #280

lailleo opened this issue Jul 14, 2022 · 11 comments

Comments

@lailleo
Copy link
Member

lailleo commented Jul 14, 2022

As it stands, guides published not under a job don't have any CSS assigned. Mentors have been asking for some form of theming to publish these and directly link to.

@nonowazu
Copy link
Contributor

The answer depends on a lot of things, but to start:

  • What's the route for those "guides"?
  • What's meant (or desired) out of the css?

@xpdota
Copy link
Contributor

xpdota commented Jul 20, 2022

Speaking for myself, an example would be the general healer prog guide. Ideally, it should just look like any other healer guide page. As for the "route", I think that would vary by guide. e.g. mine would be from the healer role landing page.

@nonowazu
Copy link
Contributor

@xpdota - given how hugo works, templates are rendered based on routes. Having a route as an example informs how the template generation works. You can read the docs about that here.

@nonowazu
Copy link
Contributor

If you're just looking for something generic, just

mkdir content/jobs/melee/ninja/guides/
cat << EOF > content/jobs/melee/ninja/guides/standardized-title.md
---
title: My first guide
card_header_image: /img/jobs/nin/basic.png
authors:
  - nono
patch: "6.11"
lastmod: 2022-07-20T01:02:03.456Z
changelog:
  - date: 2022-07-20T01:02:03.456Z
    message: My first guide submission
---
I can read more about how frontmatter works in the documentation [here](https://gohugo.io/content-management/front-matter#readout)
EOF

If you need something closer to other guide pages, look at `kind:` and `layout:` frontmatter variables.

@nonowazu
Copy link
Contributor

Actually, if that's all you need, then you can close this issue since the functionality is available in the static site today (assuming you created the folders and configure the editor for it – see docs here).

@furstblumier
Copy link
Member

furstblumier commented Jul 20, 2022

What is desired is the possibility to create a guide under eg
https://www.thebalanceffxiv.com/jobs/healers/
For eg healer independent guides. The guide should link to idk
https://www.thebalanceffxiv.com/jobs/healers/my-cool-guide
And render like any other healer guide. Instead of sage in the header with the job symbol something generic healer like should be visible etc

@furstblumier
Copy link
Member

furstblumier commented Jul 20, 2022

Same for general guides that do not fall under a job category. Eg https://www.thebalanceffxiv.com/jobs/my-general-guide

@furstblumier
Copy link
Member

Actually instead of putting it under /jobs/ it would be better to have them under https://www.thebalanceffxiv.com/general-guides/

@nonowazu
Copy link
Contributor

nonowazu commented Jul 20, 2022

Thank you for answering the questions. For role-based guides, I would suggest /jobs/${role}/guides/, just putting /jobs/${role}/foo.md results in nasty work because of how the template lookups happen:

image

There are several solutions for this (from least preferable to most preferable):

  • create brand-new routes that don't interfere and let type frontmatter do its job normally
  • copy the relevant templates under layouts/jobs to layouts/guide, modify them, then set type: in the frontmatter for those sections
  • change the template in layouts/jobs/single.html to be a bit more pragmatic about its search path (either via default, override-able option, or some other method)

@MlleCanary
Copy link
Collaborator

Actually instead of putting it under /jobs/ it would be better to have them under https://www.thebalanceffxiv.com/general-guides/

This would allow us to differentiate similar to the way that raid guides are done, which would allow for general healing guides, general dps guides, general tank guides, prog guides for each class, and all the other general guides that have been in the planning or drafting stage to be in one place.

From an organizing and editing perspective, this makes the most sense to me and would not require any redesign of role landing pages to accomodate another guide.

If the structure were to be similar to the raid guides, where it could be organized by type (instead of Ultimate/Savage/Panda/Eden/Whatever Healer/Tank/DPS/All) would allow a lot of flexibility going forward and not look strange if some jobs had guides ready to go immediately and others did not have anything on that page from role landing.

@nonowazu
Copy link
Contributor

I'll re-emphasize because I think it was missed from my previous post to encourage the solution to nest generic guides under a guides route (e.g., /jobs/healers/guides/, /jobs/melee/ninja/guides/, etc). This makes sense for a number of reasons:

  • it allows someone who's looking through the github to differentiate at a glance between the following (yes, I chose the same name, but I think this is important):
    • /content/jobs/healers/scholar/basic-guide.md
    • /content/jobs/guides/basic-guide.md
    • /content/jobs/healers/scholar/guides/basic-guide.md
    • /content/jobs/healers/scholar/raids/ultimate/basic-guide.md
  • It allows for easy overriding in hugo frontmatter and in the editor (IIRC, the editor will pick up things in the same directory as part of the same 'collection', and I'm pretty sure you don't want someone accidentally overwriting, say, the healer role landing page)
  • It matches the original content management plan somewhere way up in the early annuls of that website discussion channel I no longer have access to (and while I'm on this topic, someone should probably document that in part in glam so that anyone who wants to come along and make improvements isn't beholden to a private document in a private channel)
  • The editor update (from point 2) is cleaner with less mistakes (and, in theory, easier preview styling)

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

No branches or pull requests

5 participants