Personalizzazione dei metadati del front-end con docs-italia-theme
AgostinoPurificato opened this issue · comments
Problema
La guida al catalogo viene deployata utilizzando per il front-end la libreria docs-italia-theme.
In tale libreria è presente un codice che verifica l'ambiente di deploy del documento, e se rileva che è un ambiente locale (quindi al di fuori di docs italia), "impone" dei valori a determinati elementi di una lista:
# Run only for local development
if os.environ.get('READTHEDOCS', None) != 'True':
context['LOCAL'] = True
context['PRODUCTION_DOMAIN'] = 'localhost'
context['slug'] = 'demo-document'
context['current_version'] = 'bozza'
context['rtd_language'] = 'it'
context['publisher_project'] = u'Progetto demo'
context['publisher_project_slug'] = 'progetto-demo'
context['publisher'] = u'Organizzazione demo'
context['publisher_slug'] = 'organizzazione-demo'
context['tags'] = [
('demo', '#'),
('docs italia', '#')
]
Tali valorizzazioni si traducono nella non possibilità di controllare i valori evidenziati in rosso nelle successive immagini:
Possibili soluzioni
- Creare un fork della libreria docs-italia-theme modificando il codice affinché possano essere modificati i valori evidenziati sopra anche senza il deploy su docs italia.
- Continuare ad utilizzare il front-end con i metadati "forzati" così come fatto finora, per poi migrare/integrare la guida direttamente sul portale schema.gov.it. In questo modo, il front-end sarà quello di schema (di cui gli amministratori del catalogo hanno già pieno controllo), e non sarà necessario creare fork della libreria docs-italia-theme (non verrà più utilizzata).
In sostanza, se si prevede di migrare la guida su schema.gov.it oppure di deployarla su Docs Italia, si potrebbe pensare di lasciare il front-end così com'è, evitando modifiche che a tendere non porterebbero valore.
Mentre, se si prevede di utilizzare l'attuale deploy su github in maniera stabile, potrebbe aver senso creare una fork della libreria docs-italia-theme in modo da avere il controllo del front-end.