Document how to customise an image (optionally with templating)

Aperta
  • Qualcosa non va?
#286 1 commento 1 reazione 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
Documentazione
Chiarezza
Da chiarire
Stato di attività
Ferma
Stack tecnologico
docker, react, shell, unity
Ambito
devops, documentation

Direzione di ricerca

Inizia esaminando la documentazione esistente su customize-docker-images e la discussione collegata nella pull request 181. Chiarisci se l'ambito accettato consiste in una guida migliorata o in un generatore MDX/React per la personalizzazione delle immagini Unity e Docker; il lavoro sarà considerato completato quando sarà disponibile un documento revisionato e facile da seguire oppure un design del generatore approvato esplicitamente.

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

Descrizione

documentation

Since this has only been discussed in a few issues (I rememeber some older discussions on gitlab) or discord, it could be useful to add a section in the documentation on how to precisely customize images for different file support.

We had an idea of adding some overhead during the pipeline runs to inject (install) blender on each build,this is the plugin system from Webber's comment above. Until we have support for this (if we accept to go that way), I think including an easy to follow guide in the documentation could be helpful for many.

Right now, all we have is this:
https://game.ci/docs/docker/customize-docker-images

It is helpful, but I think it can be improved. Just another idea on top of this, we could use the power of mdx (react in markdown files) to allow people to pick their unity version, the tool they want and generate some ready to use scripts to publish what they need.

Example: A react component that generates a script from a form

  • dropdown: unity version
  • checkboxes: the tools (file formats) you need (blender, etc)
  • dropdown: GameCI version (feeding from docker releases list, auto picking the latest
  • input text: docker username

result: a shell script that eases building and publishing customized docker images to docker hub.

Now this should be discussed and accepted in an issue before it gets developed to avoid wasting precious developer time 🙏

Originally posted by @GabLeRoux in https://github.com/game-ci/docker/pull/181#issuecomment-1133642123

Lingua principale
MDX
Stelle
247
Fork
133
Merge medio
1h 28m
PR unite (30g)
1

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 game-ci/documentation

Tutte le issue di game-ci/documentation

Issue simili

Altre issue su DevOps

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.