[redesign] Better ways to share Less/EJS across sites

Aperta
  • Qualcosa non va?
#308 1 commento 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
25/100
Tipo di issue
Funzionalità
Chiarezza
Da chiarire
Stato di attività
Ferma
Stack tecnologico
node.js
Ambito
build-system, web-dev

Direzione di ricerca

Start by reviewing the shared Less and EJS resources described across the documentation, blog, and pulsar-edit.github.io repositories, then inspect 11ty-config-pulsar and package.json for the proposed Node module approach. Done should mean the sites can share the relevant includes, mixins, headers, and footers with less duplication, but the issue needs a concrete design before implementation begins.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

enhancement
Have you checked for existing feature requests?
  • Completed
Summary

I don't even know if there's a good solution here, but this is our current situation:

  • For all the redesigns, the documentation repo is the CSS source of truth; it emits a stylesheet that the others consume. The blog and pulsar-edit.github.io repos define their own CSS overrides, but often want to consult the original Less includes (i.e., the breakpoints and mixins) and can't; so they get duplicated across repos.
  • The sites may or may not want to highlight different things in their navigation areas, but otherwise should basically have the same page header and page footer. Right now, this is another thing that must be duplicated across three repos.

I don't have a preferred recommendation here because they'd all involve some pain. But here are some ideas:

  • Git submodule? (Ugh.)
    • Pros: would allow us to reference the individual files rather easily.
    • Cons: Now we've got four repos instead of three, and keeping everything in sync still requires manual submodule updates and redeploys of each site.
  • Extend 11ty-config-pulsar?
    • Not sure how easy it is to even reference Less or EJS resources from a Node module, but maybe it's possible via require.resolve or something. And maybe it can define some EJS helpers that can do most of the work instead of forcing us to reach in and include the module's own EJS files.
    • Pros: We're already using it in the other two repos.
    • Cons: Same deployment headaches as above, though they may be slightly mitigated if the package.json version just points to github:confused-Techie/11ty-config-pulsar#main and therefore always gets the latest upon redeploy.
What benefits does this feature provide?

Less duplication; more consistency.

Any alternatives?

The two possible solutions above are the only ones I can think of for now, but I'm eager to hear others if folks have ideas.

Other than that, the alternative is living with the status quo — which is annoying but not debilitating.

Other examples:

No response

Lingua principale
EJS
Stelle
31
Fork
33
Merge medio
2m
PR unite (30g)
2

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di pulsar-edit/pulsar-edit.github.io

Tutte le issue di pulsar-edit/pulsar-edit.github.io

Issue simili

Altre issue su Build System

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.