Ogni estensione deve avere una documentazione che insegni agli utenti cosa fa l'estensione e come usarla.
La documentazione minima richiesta è questo insieme di tre file di markdown:
-
PREINSTALL.md
-
POSTINSTALL.md
-
CHANGELOG.md
Inoltre, dovresti anche considerare di produrre:
- Un file
README
per il repository pubblico dell'estensione. - Tutorial, guide e riferimenti di forma più lunga pubblicati sul tuo sito Web e collegati nel tuo
PREINSTALL.md
.
Per apprendere alcune best practice, frasi e strutture comuni, ti consigliamo di esaminare i file disponibili con le estensioni Firebase ufficiali .
Creazione di un README
La directory dell'estensione può facoltativamente contenere un file README. Tieni presente che il comando firebase ext:dev:init
non ne genera automaticamente uno per te.
La CLI di Firebase, tuttavia, supporta il seguente comodo comando per generare automaticamente un file README
contenente contenuti estratti dal file extension.yaml
e dal file PREINSTALL.md
:
firebase ext:info ./path/to/extension --markdown > README.md
Tutti i file README per le estensioni ufficiali Firebase vengono generati utilizzando questo comando.
Aggiungi informazioni sull'installazione
Dopo aver scritto o generato un file README, aggiungivi le informazioni di installazione. Puoi utilizzare il seguente snippet come modello:
--- ## 🧩 Install this extension ### Console [![Install this extension in your Firebase project](https://www.gstatic.com/mobilesdk/210513_mobilesdk/install-extension.png "Install this extension in your Firebase project")][install-link] [install-link]: https://console.firebase.google.com/project/_/extensions/install?ref=publisher_id/extension_name ### Firebase CLI ```bash firebase ext:install publisher_id/extension_name --project=[your-project-id] ``` > Learn more about installing extensions in the Firebase Extensions documentation: > [console](https://firebase.google.com/docs/extensions/install-extensions?platform=console), > [CLI](https://firebase.google.com/docs/extensions/install-extensions?platform=cli) ---
Scrittura di un file PREINSTALL
Il file PREINSTALL
è la panoramica della tua estensione, una sorta di pagina di "marketing".
Che contenuto c'è in questo file?
- Descrizione completa delle funzionalità della tua estensione
- Elenco dei prerequisiti, come la configurazione del database o l'accesso a un servizio non Google ( esempio )
- Breve descrizione delle eventuali attività di pre-installazione e relative istruzioni
- Breve descrizione di eventuali attività post-installazione ( esempio ) (le istruzioni dettagliate sono disponibili in
POSTINSTALL
) - Breve descrizione di eventuali implicazioni sulla fatturazione (iniziare con il testo standard )
Dove vengono visualizzati questi contenuti all'utente?
![Immagine del contenuto preinstallato nella console Firebase](https://cdn.statically.io/img/firebase.google.com/static/docs/extensions/publishers/images/preinstall_thumb.png?hl=it)
- Nella pagina dell'estensione su extensions.dev .
- Il repository del codice sorgente per la tua estensione (all'interno della directory delle estensioni)
- Come parte del file README dell'estensione (se utilizzi la CLI Firebase
--markdown > README.md
)
PREINSTALL
non possono accedere ai valori dei parametri per l'estensione, quindi non dovresti aspettarti che i riferimenti ai parametri vengano visualizzati con i valori effettivi.
Quali sono alcune delle migliori pratiche?
Mantieni l'intero contenuto del file PREINSTALL
sotto una pagina , se possibileFornisci il livello di dettaglio che un utente finale deve assolutamente conoscere prima di installare l'estensione Inserisci istruzioni dettagliate nel file POSTINSTALL
o in altri file supplementariIndica brevemente se fornisci altri strumenti o script per supportare l'estensione
Scrittura di un file POSTINSTALL
POSTINSTALL
POSTINSTALL
è la pagina di istruzioni dettagliate post-installazione dell'estensione.
Che contenuto c'è in questo file?
Istruzioni dettagliate per eventuali attività post-installazione richieste , come l'impostazione delle regole di sicurezza Firebase o l'aggiunta di codice lato client ( esempio ) Istruzioni generiche su come provare immediatamente l'estensione installata (ad esempio, "vai alla console, quindi esegui questa operazione") Informazioni di base su come attivare l'estensione, in particolare per le estensioni attivate da richiesta HTTP Brevi indicazioni su come monitorare l'estensione installata (iniziare con il testo standard )
Dove vengono visualizzati questi contenuti all'utente?
![Immagine del contenuto post-installazione nella console Firebase](https://cdn.statically.io/img/firebase.google.com/static/docs/extensions/publishers/images/postinstall_thumb.png?hl=it)
Nella console Firebase dopo che un utente ha installato la tua estensione (nella scheda dei dettagli dell'estensione installata) Assicurati di rivedere la visualizzazione del contenuto POSTINSTALL
installando l'estensione in un progetto reale .
Il repository del codice sorgente per la tua estensione (all'interno della directory delle estensioni)
POSTINSTALL
possono accedere ai valori dei parametri e a diverse variabili relative alle funzioni per l'estensione. Quando il contenuto POSTINSTALL
viene visualizzato nella console Firebase, vengono visualizzati i valori effettivi anziché i parametri o i riferimenti alle variabili. Scopri di più di seguito su come fare riferimento a parametri e variabili nel file POSTINSTALL
.
Quali sono alcune delle migliori pratiche?
Mantieni l'intero contenuto del file POSTINSTALL
conciso ma descrittivo.Separare il contenuto utilizzando intestazioni per suddividere compiti o concetti distinti. Valuta la possibilità di pubblicare istruzioni dettagliate per un flusso di lavoro o un'attività specifica sul tuo sito web ( esempio ) o in file di markdown supplementari all'interno del repository delle estensioni ( esempio ). Parametri di riferimento e variabili correlate alle funzioni in modo che l'utente possa vederne i valori configurati nel contesto delle istruzioni
Riferimento a parametri e variabili
POSTINSTALL
dell'estensione. Se fai riferimento a parametri e variabili correlate alle funzioni (vedi tabella seguente) nel file POSTINSTALL
, la console popola questi riferimenti con i valori effettivi per l'istanza installata.
POSTINSTALL
utilizzando la seguente sintassi:${param: PARAMETER_NAME }
POSTINSTALL
. Firebase supporta queste variabili in modo che tu possa fornire più facilmente indicazioni agli utenti dopo l'installazione. Sono disponibili solo per l'uso nel file POSTINSTALL
perché i valori per queste variabili non sono disponibili fino a dopo l'installazione.
name
nell'oggetto risorsa della funzione all'interno di extension.yaml
.
Riferimento per la variabile correlata alla funzione | Descrizione | Valore variabile (popolato automaticamente da Firebase dopo l'installazione dell'estensione) |
---|---|---|
${function: function-name .location} | ||
Luogo in cui viene distribuita la funzione | Valore di esempio:us-central1 | |
${function: function-name .name} | ||
Nome della funzione distribuita finale, che include l'ID istanza dell'estensione | Formato generalizzato: Valore di esempio: | |
${function: function-name .url} (applicabile solo per le funzioni HTTP) | ||
URL della funzione distribuita finale, a cui il codice client può effettuare richieste HTTP | Formato generalizzato: Valore di esempio: |
Documentare come attivare un'estensione
POSTINSTALL
. Per indicazioni su come fornire queste istruzioni, espandi la sezione seguente applicabile alla tua estensione.
Scrivere un file CHANGELOG
Che contenuto c'è in questo file?
CHANGELOG.md
che documenta le modifiche incluse in ogni nuova versione dell'estensione che pubblichi. Metti ogni versione sotto un'intestazione di livello 2 ( ##
); altrimenti, puoi utilizzare la formattazione Markdown che preferisci.
## Version 0.1.3 feature - Support deletion of directories (issue #148). ## Version 0.1.2 feature - Add a new param for recursively deleting subcollections in Cloud Firestore (issue #14). fixed - Fixed "cold start" errors experienced when the extension runs after a period of inactivity (issue #48). ## Version 0.1.1 Initial release of the _Delete User Data_ extension.
Dove vengono visualizzati questi contenuti all'utente?
Nella console Firebase e nella CLI, quando gli utenti eseguono l'aggiornamento alle nuove versioni della tua estensione. La console Firebase e la CLI visualizzano solo le modifiche che avrebbero effetto se l'utente completasse l'aggiornamento. Il repository del codice sorgente della tua estensione (all'interno della directory dell'estensione).