typing-monkeys / appuntiuniversita Goto Github PK

Ho trovato questa action https://github.com/marketplace/actions/github-wiki-action che ci permette di creare automaticamente la Wiki del progetto partendo da dei file all'interno della repo.

Questo ci permette di tenere traccia delle varie modifiche alla documentazione e gestire tutto da un unico posto. Ci permette anche di tracciare chi contribuisce alla Wiki in modo semplice. Usando solo la sezione wiki della repo non so come funziona il fatto di sapere l'autore o gli autori della determinata pagina.

Potremmo pensare di fare un branch a parte solo per la Wiki o aggiungere direttamente la cartella wiki/ tra quelle che abbiamo del nostro progetto o "nasconderla" dentro la cartella .github/.

Potrebbe essere utile automatizzare la parte Credits del README per renderla coerente alle contribuzioni senza andare necessariamente ad aggiornarla ogni volta. Oppure trovare un'altra alternativa per menzionare eventuali contributors

• Completare l'integrazione degli appunti di Knowledge già esistenti

Finire di redigere il riassunto di Simulazione.

Finire di redigere il riassunto di Cybersecurity.

• Santini ☑️

  • Controllare il pdf contiene tutti gli argomenti delle slide
    • Il pdf risulta incompleto. Mancano la maggior parte degli argomenti.
  • Ethereum & Smart Contract Security
  • Race Conditions
  • Fuzz Testing
  • SQL Injection
  • XSS
  • Os Security
  • ID Managing
  • Aggiungere "Pagina dedica"
    • "When in doubt, whip it out. - cirt. Christopher Wistopher"

• Bistarelli ☑️

  • CIA (cap1)
  • Attack Trees (cap1)
  • Security Principles (cap1)
  • Authentication paswords (cap3) and kerberos (no libro)
  • Security Protocols (cap22)
  • Access controls - DAC-RBAC-ABAC (cap4)
  • Mac (cap2)
  • Secure interpretation (no libro?)
  • Trust (cap27)
  • DB security (cap 5)
  • Blockchain (No libro)
  • Aggiungere "Pagina dedica"
    • "Oui, con quanto sentimento defeco sul tuo naso, così che ti coli sul mento"

Penso sia arrivato il momento di cercare di migliorare ancora di più questa repo per guidare il più possibile le persone su come contribuire, effettuare alcuni controlli automatici sulle PR ed il loro contenuto, fornire varie guide su come utilizzare GitHub o configurare i vari IDE e rendere il più possibile uniformi i vari appunti.

Wiki

Pensavo di aprire una Wiki qui su GitHub per andarci a scrivere alcune guide:

• Setup dell'ambiente di sviluppo:
  • VSCode + Docker
  • TexStudio + MikTex + LuaLatex
  • Eventuali sezioni di Troubleshooting (#46)
• Breve guida su come installare e configurare git e GitHub e come contribuire

README

Potremmo migliorare il README con le seguenti modifiche:

• Vari badge come Wiki, Numero PR, Numero Issues, Numero Stars, Versione Attuale, ...
• Ricontrollare vari typo ed impaginazione
• Aggiungere emoji ai titoli (?)
• Sezione Credits migliorata (#47)
• Breve spiegazione su come contribuire (?)
• Breve spiegazione sugli appunti ed il loro contenuto (?)

Automazioni

Possiamo cercare di rendere automatici alcuni controlli ed azioni:

• Per ora abbiamo un'action che tagga il codice in automatico (esempio v2.1.3) e ne effettua la release. Potrebbe essere migliorato (?)
• Controllare in automatico le PR:
  • Controllare che il nome della PR rispecchi gli standard della community (feat:, fix:, doc:, ecc.)
  • Contenga dei file specifici (per esempio, deve esserci per forza un main.tex, ecc.)
  • Controlli l'ortografia dei file modificati
  • Controlli eventuali errori sintattici di LaTex (chktex)
• Bot per i contributor (?)
• Action per i contributor (?)

Repo

• Modificare le labels aggiungendone di più significative
• Aprire la sezione Discussioni (?)
• Completare la sezione "Community Standards":
  • Aggiungere il Code of Conduct
  • Contributing
  • Secure policy (?)
  • Pull Request Template
  • Repository admins accept content reports (?)

Appunti

Dovremmo trovare il modo di rendere il più uniforme possibile il template degli appunti

• utilizzare i submodules di git e mettere il devcontainer ed il template in una repo a parte facendo in modo di poter modificare solo alcune parti (?)
• introdurre uno standard nel formato e contenuto, del tipo per i vari appunti deve esserci per forza un README che indica le parti del programma (checkbox) e gli argomenti coperti dalle dispense (così possiamo sapere subito se quegli appunti sono completi oppure no); non si usano vspace in determinate parti del codice; vengono individuate alcune componenti standard da utilizzare tipo come formattare i paragrafi ecc.

• Aggiungere i vari progetti sviluppati durante il corso
• Aggiungere gli appunti ( ? )

C'è un problema con l'action che controlla il codice delle PR.
Se nel path di un file c'è uno spazio (tipo magistrale/Anno 1/...) l'action non comprende bene il path e pensa siano 2 separati.

Un possibile fix potrebbe essere quello di mettere i file tra virgolette.

Ci sarebbe qualche materiale su probabilità e statistica?

Pensavo che potremmo aprire la sezione Projects per questa repo e creare vari progetti per tener meglio traccia di cosa sta succedendo.
Pensavo di creare almeno questi:

• Appunti: questo progetto terrà traccia solo delle issue e pr che sono relative agli appunti (label riscrittura e nuovo materiale). Potremmo creare le seguenti colonne nel progetto:
  • TODO: pr e issue aggiunte e non ancora iniziate a controllare/risolvere
  • In Progress: iniziate a sviluppare o controllare
  • Waiting Approve: almeno 1 persona ha approvato la pr
  • Ready: i requisiti per il merge sono soddisfatti, va solo effettuato il merge
  • Done: completata
• Actions: ci aiuterà a tener traccia delle issue e pr riguardanti le action di GitHub (label actions). Penso possiamo trattarla come sopra
• Make this Monkey Great Again: ci aiuterà a tener traccia di tutte le varie modifiche che dobbiamo apportare descritte nella issue #48. Qui dovremmo capire meglio come organizzare il tutto, forse va bene usare il modello precedente o solo un TODO, In Progress, Done.

Ci sono anche delle action che ci permettono di gestire in automatico alcuni aspetti del progetto, e.g. assegnare in automatico ad un progetto una PR in base alle labels, oppure spostare da una colonna all'altra una PR se è successo un determinato evento.
Anche qui dobbiamo studiarci meglio ed approfondire.

Recentemente ho trovato tectonic un compilatore (ma forse anche qualcosina di più) LaTex scritto in Rust.
Questo sembra molto interessante dato che permette di creare in automatico progetti LaTex con una struttura coerente e sempre ben definita. Offre anche la possibilità di iniziare il progetto partendo da un template che, tramite url, prende e aggiunge in automatico al progetto.
Ha un file di configurazione per dirgli come compilare il progetto e che nome ed estensione dare al risultato finale della compilazione. Si possono usare i comandi compile e build, che simulano un po' il funzionamento di devbuild e release.
Quando viene fatta la build di un progetto il risultato viene messo in una cartella specifica (impostabile dal file di configurazione).

Tutto questo potrebbe tornarci utile per poter effettuare la build di ogni documento LaTex quando avviene una release ed aggiungere tutti i pdf aggiornati come Assets dela Release in modo da poter essere scaricati più facilmente.

Questo, ovviamente, ha un costo che è quello di riadattare tutti i progetti ad avere la stessa struttura che richiede tectonic.
E' anche possibile evitare di far questo e compilare comunque i progetti così come sono, ma la rigorosità della strututra che offre tectonic sembra molto interessante.

Aggiunta degli appunti tratti dal libro di testo.
Ci siamo accorti che il libro consigliato da Carpi risulta essere la via migliore per sostenere questo esame.

• Scrittura degli appunti tratti dal libro di testo
• Rilettura finale

Completare gli appunti di Vinti

L'esame di statistica è un po' vecchiotto e avrei prototipi più aggiornati, inoltre non ci sono file per architettura degli elaboratori.

Che domanda hai ?
Ho notato che ci sono appunti sia scritti in markdown che alcuni in pdf.
Avendo gli appunti scritti in obsidian hanno un formato non interamente compatibile con il markdown di github, posso quindi contribuire pubblicandoli in pdf?