Il nuovo repository GuITeX

  • Creatore
    Topic
  • #81530
    robitex
    Amministratore del forum
      Up
      0
      Down
      ::


      Ormai è noto già da qualche tempo, è stato aperto un progetto collaborativo su github.com.

      Vi sono già caricati i sorgenti di due guide tematiche, la classe LaTeX stessa con cui vengono composte, ed altro materiale del gruppo per la diffusione di TeX tra gli utenti italiani.

      Ho aperto questo post per ospitare le discussioni in merito a questo progetto.
      Apro subito le domande 🙂
      Quando l’amministratore approva un merge proveniente da un contributore la procedura migliore è la seguente?
      – eseguo il merge in locale dando il comando dalla directory nel progetto:
      $ git pull path/alrepo/contributore/nomeprogetto master
      – poi eseguo l’aggiornamento in remoto
      $ git push origin master

      Va bene questa procedura?
      R.

    Visualizzazione 12 filoni di risposte
    • Autore
      Risposte
      • #81531
        Up
        0
        Down
        ::


        Piccolo appunto: nei sorgenti delle guide non credo ci dovrebbero essere i file della classe [tt]guidatematica[/tt]: non so come state facendo voi, ma io l’ho messa nel mio albero locale, non ce l’ho in ogni cartella contenente il sorgente di una guida.

        robitex” post=80772Quando l’amministratore approva un merge proveniente da un contributore la procedura migliore è la seguente?
        – eseguo il merge in locale dando il comando dalla directory nel progetto:
        $ git pull path/alrepo/contributore/nomeprogetto master
        – poi eseguo l’aggiornamento in remoto
        $ git push origin master

        Va bene questa procedura?
        R.

        Essenzialmente sì: https://help.github.com/articles/using-pull-requests#merging-a-pull-request
        Il pull dovrebbe essere equivalente a fetch+merge

      • #81532
        robitex
        Amministratore del forum
          Up
          0
          Down
          ::


          Grazie per la conferma e per l’ottimo link.
          In realtà ero indeciso se includere o meno il file di classe. All’inizio l’avevo escluso perché così si evita la ridondanza ed il lavoro in più nel gestire gli aggiornamenti della classe per le guide tematiche stessa.
          Poi, sono stato attratto dal suggerimento di ansys che ha incluso il file di classe nella richiesta di merge.
          Così infatti, si fornisce all’utente che clona il repo tutto quanto occorre per compilare la guida.

          Soppesando vantaggi e svantaggi tendo a favorire l’esclusione della classe dal repo, per la migliore chiarezza e semplicità.

          Altro problema è il rapporto con il sito principale.
          Si potrebbe includere il pdf nel repo e lasciare scaricare direttamente l’ultima versione con il link diretto senza più caricare nulla sul sito.
          Ma, per gli stessi motivi già visti, preferire escludere il pdf dal repo con una procedura simile a questa:
          1 L’Autore esegue un commit con aggiornamenti alla guida.
          2 Manda via posta elettronica il pdf che rimane un file locale escluso dal repo al GuIT Web Team
          3 La guida viene controllata ed inserita nel sito via ftp senza che venga tracciato il numero di versione per evitare di dover modificare anche la pagina web del sito

          Nascono due problemi:
          1 – tracciare il numero di versione (proporrei di usare i git tag) ed eliminare i riferimenti all’interno della guida
          2 – far saper agli interessati che la guida è stata aggiornata

          Scusate se scrivo di domenica ma in questo periodo non distinguo più i giorni.
          R.

        • #81533
          admin
          Amministratore del forum
            Up
            0
            Down
            ::


            Avevo pensato di mettere i file necessari della guida tematica proprio per quello che dice Roberto: se qualcuno scarica il progetto ha tutto quello che gli occorre per compilare. Noi dei GuIT, al 99,9 % teniamo la classe già sul nostro PC, ma magari qualcuno no. Tuttavia, se si arriva a scaricare un progetto di una guida, ci vuole poco anche a scaricare la classe guidatematica. Tirando le somme, sì, si può togliere.

            Ciao
            Orlando

          • #81534
            Up
            0
            Down
            ::


            Dal mio punto di vista concordo con Roberto: credo che la classe vada tolta dai repository anche perché è disponibile su un repository dedicato, perciò chi è interessato a collaborare ad una guida clona sia il repository della guida che quello della classe ed è a posto.

            Piccola domanda: come si fa a diventare membri? 😛 Credo che quella famosa guida a git sia davvero indispensabile. 🙂

            Ciao
            Claudio

          • #81535
            robitex
            Amministratore del forum
              Up
              0
              Down
              ::

              cfiandra” post=80801Dal mio punto di vista concordo con Roberto: credo che la classe vada tolta dai repository anche perché è disponibile su un repository dedicato, perciò chi è interessato a collaborare ad una guida clona sia il repository della guida che quello della classe ed è a posto.

              Piccola domanda: come si fa a diventare membri? 😛 Credo che quella famosa guida a git sia davvero indispensabile. 🙂

              Ciao
              Claudio

              Per diventare membro del gruppo devi prima attivare un account github, poi l’amministratore ti inserisce nel gruppo guitex ed eventualmente, crea i repo che ti servono.

              E sulle domande che accennavo all’inizio? Cosa ne pensate?

            • #81536
              Up
              0
              Down
              ::

              robitex” post=80780Grazie per la conferma e per l’ottimo link.
              In realtà ero indeciso se includere o meno il file di classe. All’inizio l’avevo escluso perché così si evita la ridondanza ed il lavoro in più nel gestire gli aggiornamenti della classe per le guide tematiche stessa.
              Poi, sono stato attratto dal suggerimento di ansys che ha incluso il file di classe nella richiesta di merge.
              Così infatti, si fornisce all’utente che clona il repo tutto quanto occorre per compilare la guida.

              Soppesando vantaggi e svantaggi tendo a favorire l’esclusione della classe dal repo, per la migliore chiarezza e semplicità.

              Altro problema è il rapporto con il sito principale.
              Si potrebbe includere il pdf nel repo e lasciare scaricare direttamente l’ultima versione con il link diretto senza più caricare nulla sul sito.
              Ma, per gli stessi motivi già visti, preferire escludere il pdf dal repo con una procedura simile a questa:
              1 L’Autore esegue un commit con aggiornamenti alla guida.
              2 Manda via posta elettronica il pdf che rimane un file locale escluso dal repo al GuIT Web Team
              3 La guida viene controllata ed inserita nel sito via ftp senza che venga tracciato il numero di versione per evitare di dover modificare anche la pagina web del sito

              Nascono due problemi:
              1 – tracciare il numero di versione (proporrei di usare i git tag) ed eliminare i riferimenti all’interno della guida
              2 – far saper agli interessati che la guida è stata aggiornata

              Scusate se scrivo di domenica ma in questo periodo non distinguo più i giorni.
              R.

              Scusami, ma non ho capito quale siano i problemi, cioè non ho capito perché tracciare il numero di versione sia un problema e perché non si possa continuare a scrivere un messaggio qui sul forum quando viene pubblicata una nuova versione della guida

            • #81537
              robitex
              Amministratore del forum
                Up
                0
                Down
                ::


                Semplice…
                Tento solo di capire se posso lavorare meno 🙂
                😉
                Buon Natale
                R.

              • #81538
                Up
                0
                Down
                ::

                robitex” post=80808Semplice…
                Tento solo di capire se posso lavorare meno 🙂
                😉
                Buon Natale
                R.

                Il tuo lavoro non dovrebbe essere “solo” quello di caricare le nuove versione delle guide sul sito, quando usciranno di tanto in tanto?

              • #81539
                robitex
                Amministratore del forum
                  Up
                  0
                  Down
                  ::

                  Elrond” post=80827

                  Semplice…
                  Tento solo di capire se posso lavorare meno 🙂
                  😉
                  Buon Natale
                  R.

                  Il tuo lavoro non dovrebbe essere “solo” quello di caricare le nuove versione delle guide sul sito, quando usciranno di tanto in tanto?

                  Ricevo la guida in pdf via email
                  L’apro e controllo il numero e la data di emissione e la sfoglio in cerca di errori grossolani
                  Contatto l’Autore per coniscere le novità ed i cambiamenti
                  Cancello la vecchia guida dal sito
                  Salvo la vecchia giuda in locale come backup
                  Carico sul sito la nuova
                  Aggiorno il testo html con numero e data e cose salienti poi chiudo
                  R.

                • #81540
                  Up
                  0
                  Down
                  ::

                  robitex” post=80828Ricevo la guida in pdf via email
                  L’apro e controllo il numero e la data di emissione e la sfoglio in cerca di errori grossolani
                  Contatto l’Autore per coniscere le novità ed i cambiamenti
                  Cancello la vecchia guida dal sito
                  Salvo la vecchia giuda in locale come backup
                  Carico sul sito la nuova
                  Aggiorno il testo html con numero e data e cose salienti poi chiudo
                  R.

                  Avevo pensato a un lavoro come:

                  • Ricevo la guida in pdf via email
                  • L’apro e controllo il numero e la data di emissione e la sfoglio in cerca di errori grossolani
                  • Contatto l’Autore per coniscere le novità ed i cambiamenti
                  • Cancello la vecchia guida dal sito
                  • Salvo la vecchia giuda in locale come backup
                  • Carico sul sito la nuova
                  • Aggiorno il testo html con numero e data e cose salienti poi chiudo

                  Se il sorgente della guida è su Github e si fa uso dei tag per segnare le versioni è facile ricompilare il sorgente di una versione specifica, non c’è bisogno di una copia di backup qui sul sito del GuiT. Se è un lavoro troppo dispendioso, alla lunga, si potrebbe togliere il riferimento alla versione dalla pagina http://www.guitex.org/home/it/guide-tematiche

                  Avevi proposto di caricare le guide su un altro sito (peccato che su Github abbiano tolto la possibilità di caricare file esterni al repository proprio quindici giorni fa), in quel caso tutta la trafila di controllo degli errori e verifica di cambiamenti non ci sarebbe proprio stata, corretto?

                  Che ne dici?

                • #81541
                  robitex
                  Amministratore del forum
                    Up
                    0
                    Down
                    ::


                    Ecco appunto.
                    Pensavo di lasciare la tracciatura delle versioni per caricare via ftp le nuove version.
                    Il problema è che gli utenti che hanno già la guida non si accorgerebbero dell’uscita dell’aggiornamento a meno che l’autore stesso non prepari un breve testo di annuncui priprii come succede in ctan.
                    La procedura diventa:
                    L’Autore aggiorna la guida ma anche il file history.txt con le modifiche apportate.
                    Poi manda l’email con il pdf e fa l’annuncio sul forum incollando le info dall’history.
                    Va bene?

                  • #81542
                    Up
                    0
                    Down
                    ::

                    robitex” post=80853Il problema è che gli utenti che hanno già la guida non si accorgerebbero dell’uscita dell’aggiornamento a meno che l’autore stesso non prepari un breve testo di annuncui priprii come succede in ctan.

                    Tutte le guide hanno un loro filone sul forum perciò l’annuncio si potrebbe dare in via principale sul forum. In questo caso credo convenga segnalare il link del filone nel readme del repository.

                    Ciao
                    Claudio

                  • #81543
                    robitex
                    Amministratore del forum
                      Up
                      0
                      Down
                      ::


                      O forse viceversa…
                      Sto pensando anche ad un paio di file da aggiungere al progetto della classe: un readme predisposto per markdown ed un file history template.
                      R.

                  Visualizzazione 12 filoni di risposte
                  • Devi essere connesso per rispondere a questo topic.

                  Go to top