Commit bba2816e authored by Riccardo Padovani's avatar Riccardo Padovani

Update contributing and readme

parent 5ef7ba67
...@@ -91,6 +91,8 @@ git pull ...@@ -91,6 +91,8 @@ git pull
git checkout -b ilMioNuovoContributo git checkout -b ilMioNuovoContributo
``` ```
E ricordati di aggiungere il tuo nome al file AUTHORS.md ;-)
### Preparare l'ambiente per lo sviluppo ### Preparare l'ambiente per lo sviluppo
*Testato su Ubuntu 14.04* *Testato su Ubuntu 14.04*
...@@ -128,6 +130,42 @@ In caso si facciano modifiche frequenti, può risultare conveniente l'aggiunta ...@@ -128,6 +130,42 @@ In caso si facciano modifiche frequenti, può risultare conveniente l'aggiunta
della flag `-w` al comando, che ricompila gli assets quando sono rilevate della flag `-w` al comando, che ricompila gli assets quando sono rilevate
modifiche. modifiche.
### Esecuzione del sito in locale
Per eseguire il sito in locale, è possibile eseguire questo comando (una volta
dentro il virtualenv o con il sito installato globalmente):
```
uitwww run -d -p 8000
```
Esso avvierà un'istanza in debug-mode (*da non eseguire in produzione!!!*), che
ascolta su [localhost:8000][localhost]. Se si vuole attivare anche la cache
statica, bisogna aggiungere come argomento il path della directory che la dovrà
contenere:
```
uitwww run -d -p 8000 path/to/cache
```
## Generazione di una build
Per creare una build dell'intero sito, è necessario disporre di Python 3,
[virtualenv][2], [pyinvoke][3] e nodejs. Dopo averli installati si può crearla
con il seguente comando:
```
$ invoke build
```
Esso scaricherà tutte le dipendenze da internet (la prima volta), compilerà gli
assets e genererà il pacchetto, salvandolo in ``build/packages``. È possibile
rimuovere tutti i file creati dal processo con il comando:
```
$ invoke clean
```
[2]: https://virtualenv.pypa.io [2]: https://virtualenv.pypa.io
[3]: http://www.pyinvoke.org [3]: http://www.pyinvoke.org
[git]: http://code.ubuntu-it.org/ubuntu-it-web/www/wikis/git-setup [git]: http://code.ubuntu-it.org/ubuntu-it-web/www/wikis/git-setup
...@@ -135,3 +173,4 @@ modifiche. ...@@ -135,3 +173,4 @@ modifiche.
[irc]: http://chat.ubuntu-it.org/#ubuntu-it-web [irc]: http://chat.ubuntu-it.org/#ubuntu-it-web
[vanilla]: https://github.com/ubuntudesign/ubuntu-vanilla-theme [vanilla]: https://github.com/ubuntudesign/ubuntu-vanilla-theme
[test]: http://wwwtest.ubuntu-it.org [test]: http://wwwtest.ubuntu-it.org
[localhost]: http://localhost:8000
...@@ -3,74 +3,44 @@ ...@@ -3,74 +3,44 @@
Questo repository contiene tutto il codice sorgente del [sito web][1] di Questo repository contiene tutto il codice sorgente del [sito web][1] di
ubuntu-it. Il tutto è rilasciato sotto licenza GNU-AGPL v3+. ubuntu-it. Il tutto è rilasciato sotto licenza GNU-AGPL v3+.
Il sito è realizzato con [flask](http://flask.pocoo.org) e Python 3. Per contribuire dai un'occhiata al file CONTRIBUTING.md
## Esecuzione del sito in locale Il gruppo web si pone come obiettivo la diffusione, con la massima chiarezza e
semplicità, di tutte le informazioni necessarie all'utenza italiana di Ubuntu,
aggiornamento notizie e informazioni generali di supporto, ad integrazione degli
altri gruppi della comunità italiana.
Per eseguire il sito in locale, è possibile eseguire questo comando (una volta
dentro il virtualenv o con il sito installato globalmente):
``` ## Chi siamo
$ uitwww run -d -p 8000
```
Esso avvierà un'istanza in debug-mode (*da non eseguire in produzione!!!*), che - DarioCavedon (*ic3d*) - **Amministratore**
ascolta su `localhost:8000`. Se si vuole attivare anche la cache statica, - PietroAlbini (*pietroalbini*) - **Amministratore**
bisogna aggiungere come argomento il path della directory che la dovrà - RiccardoPadovani (*rpadovani*)
contenere: - PaoloRotolo (*paolorotolo*)
- MattiaMigliorini (*deshack*)
- SilviaBindelli (*Dolasilla*)
- EmanueleBoncimino (*almaidinajad*)
- LucaLumetti (*lumetti-luca*)
- MercuryTuts (*mercurytuts*)
```
$ uitwww run -d -p 8000 path/to/cache
```
## Generazione di una build ## Planet Ubuntu-it
Per creare una build dell'intero sito, è necessario disporre di Python 3, Il [planet italiano di Ubuntu][planet] è gestito dal gruppo Web.
[virtualenv][2], [pyinvoke][3] e nodejs. Dopo averli installati si può crearla
con il seguente comando:
``` Per qualunque informazione, segnalazione o suggerimento che riguarda il planet,
$ invoke build scrivere a planet@ubuntu-it.org.
```
Esso scaricherà tutte le dipendenze da internet (la prima volta), compilerà gli
assets e genererà il pacchetto, salvandolo in ``build/packages``. È possibile
rimuovere tutti i file creati dal processo con il comando:
``` ## Contatti
$ invoke clean
```
## Hacking Per qualunque informazione, segnalazione o suggerimento che riguarda il Gruppo
Web potete:
Per preparare l'ambiente di sviluppo è necessario disporre di Python 3, - scrivere a gruppo-web@ubuntu-it.org.
[virtualenv][2], [pyinvoke][3] e nodejs. Dopo averli installati si può - postare nella [sezione rilevante sul forum][forum]
generarlo con il seguente comando:
```
$ invoke devel
```
Esso scaricherà tutte le dipendenze da internet (la prima volta), compilerà gli
assets e creerà un virtualenv con dentro installato il sito (in modalità
modificabile). Per attivare il virtualenv, bisogna dare in ogni sessione di
terminale il seguente comando:
```
$ source build/envs/devel/bin/activate
```
Se si modificano gli assets è necessario ricompilarli. Lo si può effettuare con
il seguente comando:
```
$ invoke assets
```
In caso si facciano modifiche frequenti, può risultare conveniente l'aggiunta
della flag `-w` al comando, che ricompila gli assets quando sono rilevate
modifiche.
[1]: http://www.ubuntu-it.org [1]: http://www.ubuntu-it.org
[2]: https://virtualenv.pypa.io [planet]: http://planet.ubuntu-it.org
[3]: http://www.pyinvoke.org [forum]: http://forum.ubuntu-it.org/viewforum.php?f=45
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment