Aggiunge il capitolo Introduzione all'indice del libro #149

nicolaerario · 2023-10-17T06:40:44Z

Capitolo di introduzione aggiunto all'indice del libro
Rinominato il file del capitolo di introduzione in modo da essere più specifico
Uniforma gli script di formattazione
Aggiunta struttura language driven per i capitoli
Aggiunge linee guida per la nomenclatura dei capitoli nel Contributing.md

package.json

Cadienvan · 2023-10-17T07:14:01Z

@nicolaerario domanda.. Come mai rinominare da README a introduzione? Inizialmente era stato fatto per permettere una prima vista al capitolo entrando nella folder anche dal repo.

nicolaerario · 2023-10-17T07:26:21Z

@nicolaerario domanda.. Come mai rinominare da README a introduzione? Inizialmente era stato fatto per permettere una prima vista al capitolo entrando nella folder anche dal repo.

Secondo me ogni "capitolo" ha bisogno del suo file. Guardala al contrario: metti 10 capitoli, ognuno in un README e poi prova a cercarne uno specifico con lo strumento cerca

corradopetrelli

Perfetto! 😄
Ultima cosa, modifica pure il file CONTRIBUTING.md dato che ora format:write contiene il glob. Dopo ci siamo 🚀

nicolaerario · 2023-10-17T07:46:23Z

Perfetto! 😄 Ultima cosa, modifica pure il file CONTRIBUTING.md dato che ora format:write contiene il glob. Dopo ci siamo 🚀

Già fatto in realtà 😎
è in c95e4b7

corradopetrelli

Perfetto!

guizzo

LGTM

Cadienvan · 2023-10-17T10:31:21Z

@nicolaerario domanda.. Come mai rinominare da README a introduzione? Inizialmente era stato fatto per permettere una prima vista al capitolo entrando nella folder anche dal repo.

Secondo me ogni "capitolo" ha bisogno del suo file. Guardala al contrario: metti 10 capitoli, ognuno in un README e poi prova a cercarne uno specifico con lo strumento cerca

Mmmmh.. Non mi hai convinto al 100%. Quando si contribuisce lo si può fare guardando i nomi delle cartelle più che dei file, ma in cambio si ha la visibilità da Github accedendo alla folder del suo contenuto. Ma se altri sono d'accordo mi adeguo senza problemi. Per il resto approvo tutto!

nicolaerario · 2023-10-17T10:39:28Z

@nicolaerario domanda.. Come mai rinominare da README a introduzione? Inizialmente era stato fatto per permettere una prima vista al capitolo entrando nella folder anche dal repo.

Secondo me ogni "capitolo" ha bisogno del suo file. Guardala al contrario: metti 10 capitoli, ognuno in un README e poi prova a cercarne uno specifico con lo strumento cerca

Mmmmh.. Non mi hai convinto al 100%. Quando si contribuisce lo si può fare guardando i nomi delle cartelle più che dei file, ma in cambio si ha la visibilità da Github accedendo alla folder del suo contenuto. Ma se altri sono d'accordo mi adeguo senza problemi. Per il resto approvo tutto!

Ho capito che vuoi dire.
Tutto sta nel decidere se risparmiare un click (perché basta cliccare il file per avere lo stesso identico risultato) per avere decine di files (impropriamente) chiamati README.
Ne perdi in ricerca, in indicizzazione, in semantica; oltre al fatto che, paradossalmente, non sei nemmeno "obbligato" a folderizzare.

Assolutamente nessun problema comunque. Si modifica se non piace 👌

Cadienvan · 2023-10-17T10:40:42Z

Aspettiamo altri approvals, se non ci sono dubbi procedi senza problemi! Si è sempre in tempo a cambiare idea!

corradopetrelli · 2023-10-17T11:24:59Z

A me va benissimo come dice @nicolaerario anche perchè mi sembra più intuitivo a livello di UX nella ricerca.
L'unico dubbio è quando verranno introdotte le traduzioni come faremo se avremo un'architettura flat?

Potremmo addentrarci in vari approcci, ne propongo tre:

Approccio "folder-driven"

docs/
├─ introduzione/
│  ├─ en.md
│  ├─ it.md
├─ capitolo-foo/
│  ├─ en.md
│  ├─ it.md

Approccio "prefix-driven"

docs/
├─ introduzione-it-it.md
├─ introduzione-en-us.md
├─ capitolo-foo-it-it.md
├─ capitolo-foo-en-us.md

Approccio "language-driven"

docs/
├─ it/
│  ├─ introduzione.md
│  ├─ capitolo-foo.md
├─ en/
│  ├─ introduzione.md
│  ├─ capitolo-foo.md

Che ne pensate?

guizzo · 2023-10-17T11:27:34Z

A me va benissimo come dice @nicolaerario anche perchè mi sembra più intuitivo a livello di UX nella ricerca. L'unico dubbio è quando verranno introdotte le traduzioni come faremo se avremo un'architettura flat?

Potremmo addentrarci in vari approcci, ne propongo tre:

Approccio "folder-driven"
docs/
├─ introduzione/
│  ├─ en.md
│  ├─ it.md
├─ capitolo-foo/
│  ├─ en.md
│  ├─ it.md
Approccio "prefix-driven"
docs/
├─ introduzione-it-it.md
├─ introduzione-en-us.md
├─ capitolo-foo-it-it.md
├─ capitolo-foo-en-us.md
Approccio "language-driven"
docs/
├─ it/
│  ├─ introduzione.md
│  ├─ capitolo-foo.md
├─ en/
│  ├─ introduzione.md
│  ├─ capitolo-foo.md
Che ne pensate?

Così su due piedi (non è vero, sono seduto) mi sembra avere senso l'approccio ~~folder-driven~~ language-driven

nicolaerario · 2023-10-17T12:14:45Z

A me va benissimo come dice @nicolaerario anche perchè mi sembra più intuitivo a livello di UX nella ricerca. L'unico dubbio è quando verranno introdotte le traduzioni come faremo se avremo un'architettura flat?

Potremmo addentrarci in vari approcci, ne propongo tre:

Approccio "folder-driven"
docs/
├─ introduzione/
│  ├─ en.md
│  ├─ it.md
├─ capitolo-foo/
│  ├─ en.md
│  ├─ it.md
Approccio "prefix-driven"
docs/
├─ introduzione-it-it.md
├─ introduzione-en-us.md
├─ capitolo-foo-it-it.md
├─ capitolo-foo-en-us.md
Approccio "language-driven"
docs/
├─ it/
│  ├─ introduzione.md
│  ├─ capitolo-foo.md
├─ en/
│  ├─ introduzione.md
│  ├─ capitolo-foo.md
Che ne pensate?

Io, ultimamente, vado di language driven:
miodominio.com/it/foo
miodominio.com/en/bar

fulgido · 2023-10-19T22:55:29Z

Se rinominiamo il file del capitolo, per questo capitolo, poi dovremmo farlo anche negli altri per coerenza, giusto?

corradopetrelli · 2023-10-20T04:59:40Z

Se rinominiamo il file del capitolo, per questo capitolo, poi dovremmo farlo anche negli altri per coerenza, giusto?

Giusto

Cadienvan · 2023-10-21T14:09:07Z

Perfetto, cambierei solo il nome della PR per meglio riflettere il senso di questa modifica.
@nicolaerario che ne dici di aggiungere al CONTRIBUTING anche un paragrafo, verso l'inizio, riguardo a come nominare il file nella maniera corretta quando sei ambassador e prendi in mano un branch..? Poi per me possiamo mergiare.

nicolaerario · 2023-10-23T07:19:54Z

Perfetto, cambierei solo il nome della PR per meglio riflettere il senso di questa modifica. @nicolaerario che ne dici di aggiungere al CONTRIBUTING anche un paragrafo, verso l'inizio, riguardo a come nominare il file nella maniera corretta quando sei ambassador e prendi in mano un branch..? Poi per me possiamo mergiare.

Non ho inteso cosa voglia dire "per meglio riflettere il senso di questa modifica" (focus: aggiunge l'introduzione all'indice, si? I side effects sono riportati nel body); ho riformulato meglio il titolo comunque.

Sono d'accordo nel definire nel contributing la corretta nomenclatura del file: consiglio di farlo non appena avremo una linea guida definita.
Come suggerito sopra, come dovrebbe essere?

docs/introduzione/introduzione.md
docs/introduzione.md
docs/it/introduzione.md
docs/introduzione-it-it.md
docs/introduzione/it.md

Credo potrebbe essere conveniente mergiare adesso e fare una PR apposita per il naming una volta definito.

EDIT: Come scritto sopra, io voto per docs/it/introduzione.md che risulterebbe in nomedellibro.com/it/introduzione

guizzo · 2023-10-23T07:26:47Z

EDIT: Come scritto sopra, io voto per docs/it/introduzione.md che risulterebbe in nomedellibro.com/it/introduzione

Ripensando a mente fresca all'url finale a cui verrà esposto il libro, convengo anch'io con l'approccio language driven 👍

Cadienvan · 2023-10-23T07:27:30Z

Anche io vado per quello anche se per ora abbiamo solo l'it.

JeyDi · 2023-10-23T08:35:40Z

Ciao! Anche a me piace molto l'approccio nomedellibro.com/it/introduzione e quindi docs/it/introduzione.md

Cadienvan · 2023-10-23T10:39:21Z

Per velocizzare la decisione abbiamo creato un survey su telegram!

Cadienvan · 2023-10-27T19:58:33Z

Let's go con il language-driven @nicolaerario !
Il sondaggio ha detto 76% contro meno del 20 per gli altri modelli proposti!

Muove capitolo introduzione nella cartella it Aggiorna indice alla nuova struttura

Cadienvan · 2023-10-28T08:49:24Z

Per completezza chiedo la review al @Il-Libro-Open-Source/drafting-group , poi ci siamo!

serenasensini

Tutto ok! Aggiungerei piccolo riferimento anche agli strumenti JetBrains, che offrono il plugin Prettier installabile tramite il menù dedicato

nicolaerario · 2023-10-30T14:38:40Z

Tutto ok! Aggiungerei piccolo riferimento anche agli strumenti JetBrains, che offrono il plugin Prettier installabile tramite il menù dedicato

Grazie @serenasensini , ho aperto una issue dedicata: #158

nicolaerario requested a review from a team October 17, 2023 06:40

nicolaerario force-pushed the index-update branch from 5ead33c to 26a13c4 Compare October 17, 2023 06:54

corradopetrelli requested changes Oct 17, 2023

View reviewed changes

package.json Outdated Show resolved Hide resolved

nicolaerario requested a review from corradopetrelli October 17, 2023 07:35

nicolaerario force-pushed the index-update branch from 127bda1 to c95e4b7 Compare October 17, 2023 07:43

corradopetrelli requested changes Oct 17, 2023

View reviewed changes

nicolaerario requested a review from corradopetrelli October 17, 2023 07:47

corradopetrelli previously approved these changes Oct 17, 2023

View reviewed changes

guizzo previously approved these changes Oct 17, 2023

View reviewed changes

Cadienvan previously approved these changes Oct 21, 2023

View reviewed changes

nicolaerario changed the title ~~Aggiunge l'introduzione all'indice del libro~~ Aggiunge il capitolo Introduzione all'indice del libro Oct 23, 2023

feat: aggiunge introduzione all'indice del libro

89a5f67

nicolaerario force-pushed the index-update branch from c95e4b7 to 0c25165 Compare October 26, 2023 18:30

nicolaerario added 3 commits October 28, 2023 09:08

chore: uniforma gli scripts di formattazione

9138344

chore: aggiunge format script per lefthook

58d334c

feat: scaffold della struttura delle cartelle

8a6cda9

Muove capitolo introduzione nella cartella it Aggiorna indice alla nuova struttura

nicolaerario dismissed stale reviews from corradopetrelli, guizzo, and Cadienvan via 8a6cda9 October 28, 2023 07:09

nicolaerario force-pushed the index-update branch from 0c25165 to 8a6cda9 Compare October 28, 2023 07:09

feat: aggiunge la nomenclatura dei capitoli

ec6e857

nicolaerario requested review from a team, Cadienvan, guizzo and corradopetrelli October 28, 2023 07:51

guizzo approved these changes Oct 28, 2023

View reviewed changes

corradopetrelli approved these changes Oct 28, 2023

View reviewed changes

Cadienvan approved these changes Oct 28, 2023

View reviewed changes

Cadienvan requested a review from a team October 28, 2023 08:49

serenasensini approved these changes Oct 30, 2023

View reviewed changes

nicolaerario mentioned this pull request Oct 30, 2023

Aggiungere riferimenti ad altri IDE nel CONTRIBUTING #158

Closed

Cadienvan merged commit 658f39e into main Oct 31, 2023
1 check passed

Cadienvan deleted the index-update branch October 31, 2023 08:12

guizzo pushed a commit that referenced this pull request Oct 31, 2023

Aggiunge il capitolo Introduzione all'indice del libro (#149)

56d6613

Cadienvan pushed a commit that referenced this pull request Nov 11, 2023

Aggiunge il capitolo Introduzione all'indice del libro (#149)

2945a55

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Aggiunge il capitolo Introduzione all'indice del libro #149

Aggiunge il capitolo Introduzione all'indice del libro #149

nicolaerario commented Oct 17, 2023 •

edited

Loading

Cadienvan commented Oct 17, 2023

nicolaerario commented Oct 17, 2023

corradopetrelli left a comment

nicolaerario commented Oct 17, 2023 •

edited

Loading

corradopetrelli left a comment

guizzo left a comment

Cadienvan commented Oct 17, 2023 •

edited by nicolaerario

Loading

nicolaerario commented Oct 17, 2023

Cadienvan commented Oct 17, 2023

corradopetrelli commented Oct 17, 2023

guizzo commented Oct 17, 2023 •

edited

Loading

nicolaerario commented Oct 17, 2023

fulgido commented Oct 19, 2023

corradopetrelli commented Oct 20, 2023

Cadienvan commented Oct 21, 2023

nicolaerario commented Oct 23, 2023 •

edited

Loading

guizzo commented Oct 23, 2023

Cadienvan commented Oct 23, 2023

JeyDi commented Oct 23, 2023

Cadienvan commented Oct 23, 2023

Cadienvan commented Oct 27, 2023

Cadienvan commented Oct 28, 2023

serenasensini left a comment

nicolaerario commented Oct 30, 2023

Aggiunge il capitolo Introduzione all'indice del libro #149

Aggiunge il capitolo Introduzione all'indice del libro #149

Conversation

nicolaerario commented Oct 17, 2023 • edited Loading

Cadienvan commented Oct 17, 2023

nicolaerario commented Oct 17, 2023

corradopetrelli left a comment

Choose a reason for hiding this comment

nicolaerario commented Oct 17, 2023 • edited Loading

corradopetrelli left a comment

Choose a reason for hiding this comment

guizzo left a comment

Choose a reason for hiding this comment

Cadienvan commented Oct 17, 2023 • edited by nicolaerario Loading

nicolaerario commented Oct 17, 2023

Cadienvan commented Oct 17, 2023

corradopetrelli commented Oct 17, 2023

guizzo commented Oct 17, 2023 • edited Loading

nicolaerario commented Oct 17, 2023

fulgido commented Oct 19, 2023

corradopetrelli commented Oct 20, 2023

Cadienvan commented Oct 21, 2023

nicolaerario commented Oct 23, 2023 • edited Loading

guizzo commented Oct 23, 2023

Cadienvan commented Oct 23, 2023

JeyDi commented Oct 23, 2023

Cadienvan commented Oct 23, 2023

Cadienvan commented Oct 27, 2023

Cadienvan commented Oct 28, 2023

serenasensini left a comment

Choose a reason for hiding this comment

nicolaerario commented Oct 30, 2023

nicolaerario commented Oct 17, 2023 •

edited

Loading

nicolaerario commented Oct 17, 2023 •

edited

Loading

Cadienvan commented Oct 17, 2023 •

edited by nicolaerario

Loading

guizzo commented Oct 17, 2023 •

edited

Loading

nicolaerario commented Oct 23, 2023 •

edited

Loading