picture: image/dropbox_geoblast.jpg tags: [Markdown, Modello] date: 2019-03-05
Condivisione di alcuni modelli Markdown comuni
Markdown ha praticamente sostituito altri strumenti di testo nel nostro uso quotidiano, ma a differenza di altri editor di testo, non ci sono molti modelli di progetto predefiniti. Qualche giorno fa ho visto su Dropbox Paper
alcuni modelli Markdown che sono stati realizzati molto bene. Li ho organizzati e aggiunto alcuni modelli Markdown comuni per la condivisione.
I modelli includono:
Infine, allego il codice sorgente del documento in inglese
Brainstorming
Codice sorgente
# 💡 Brainstorming: Aggiungi un argomento
| **Obiettivo** | Che tipo di idee vuoi? |
| -------------- | ----------------------------------- |
| **Partecipanti** | @menziona te stesso e altri |
| **Correlati** | - 🔗 [Inserisci alcuni documenti o link]() |
## Ispirazione
Usa la barra degli strumenti che appare quando premi "invio" per aggiungere immagini, video, ecc.
## Idee
Fai una domanda al team per far fluire le cose
----------
## Passi successivi
- [ ] Pensa fuori dagli schemi @qualcuno
- [ ] Da fare a fatto @qualcuno
Effetto visivo (con rientri regolati)
💡 Brainstorming: Aggiungi un argomento
Obiettivo | Che tipo di idee vuoi? |
---|---|
Partecipanti | @menziona te stesso e altri |
Correlati | -Documento correlato 1 <br> - Inserisci documento correlato |
Ispirazione
Usa la barra degli strumenti che appare quando premi "invio" per aggiungere immagini, video, ecc.
Idee
Fai una domanda al team per far fluire le cose
Passi successivi
- [ ] Pensa fuori dagli schemi @qualcuno
- [ ] Da fare a fatto @qualcuno
Note riunione
Codice sorgente
# 🕘 Note riunione: Aggiungi il nome dell'evento
# 2019-03-02
****
## Partecipanti
@menziona te stesso e aggiungi altri
## Ordine del giorno
- Argomenti da discutere
## Discussione
- Argomenti effettivamente discussi
## Azioni da intraprendere
- [ ] Completiamo questo compito @qualcuno
Effetto visivo (con rientri regolati)
🕘 Note riunione: Aggiungi il nome dell'evento
2019-03-02
Partecipanti
@menziona te stesso e aggiungi altri
Ordine del giorno
- Argomenti da discutere
Discussione
- Argomenti effettivamente discussi
Azioni da intraprendere
- [ ] Completiamo questo compito @qualcuno
Piano di progetto
# 📋 Piano di progetto: Aggiungi un progetto
| **Descrizione** | Cosa hai in mente? |
| --------------- | ---------------------------------- |
| **Stato** | In anticipo 🌱 | In corso 🔨 | Completato ⭐ |
| **Team** | Ruolo: @qualcuno<br>Ruolo: @qualcuno|
| **Correlati** | - [Documento correlato 1](document1) <br>- [Inserisci documento correlato](http://document) |
## Cronologia
| Titolo | Data (Scadenza) | Assegnato a | Descrizione |
| -------| :-------------: | ----------- | ----------- |
| | 03.01-03.12 | | |
## Dettagli
Usa la barra degli strumenti che appare quando premi "invio" per aggiungere immagini, video, ecc.
## Attività da fare
- [ ] Completeremo questo compito @qualcuno
- [ ] Risolviamo questo compito oggi @qualcuno
Effetto visivo (con rientri regolati)
📋 Piano di progetto: Aggiungi un progetto
Descrizione | Cosa hai in mente? |
---|---|
Stato | In anticipo 🌱 |
Team | Ruolo: @qualcuno<br> Ruolo: @qualcuno |
Correlati | -Documento correlato 1 <br> - Inserisci documento correlato |
Cronologia
Titolo | Data | Assegnato a | Descrizione |
---|---|---|---|
03.01-03.12 |
Dettagli
Usa la barra degli strumenti che appare quando premi "invio" per aggiungere immagini, video, ecc.
Attività da fare
- [ ] Completeremo questo compito @qualcuno
- [ ] Risolviamo questo compito oggi @qualcuno
Documentazione RestAPI
### Il titolo della tua rest api
Alcuna descrizione della tua api
**Metodo:** POST
**Content-Type:** application/json
**Endpoint**
```bash
https://apis.example.com/v1/example
Payload del corpo della richiesta
Nome Proprietà | Tipo | Descrizione |
---|---|---|
name | string | il nome di questo modello |
admin | boolean | Se il modello è admin |
Payload della risposta
Nome Proprietà | Tipo | Descrizione |
---|---|---|
id | string | l'id del server |
name | string | il nome di questo modello |
admin | boolean | Se il modello è admin |
Esempio di richiesta
curl 'https://apis.example.com/v1/example' \
-H 'Content-Type: application/json' \
-H 'Authorization: ${TOKEN}' \
-d \
'{
"name": "test",
"admin": true
}'
Nell'esempio sopra, sostituiresti ${TOKEN}
con il token di autorizzazione generato, fai riferimento a: Autorizzazione utente.
Una richiesta riuscita è indicata da un codice di stato HTTP 200 OK
. La risposta contiene l'id del tuo modello
Esempio di risposta
{
"id": "A163D1C8AA1FD43CAF521B74FC5A46BE",
"name": "test",
"admin": "true",
"expiresIn": "3600"
}
Codici di errore comuni
invalid_argument
: il [name] potrebbe essere troppo lungo per il databasepermission_denied
: potresti non avere il permesso per questa operazione
Per altri errori potresti dover fare riferimento al codice di errore globale.
**Effetto visivo** (con rientri regolati)
### Il titolo della tua rest api
Alcuna descrizione della tua api
**Metodo:** POST
**Content-Type:** application/json
**Endpoint**
```bash
https://apis.example.com/v1/example
Payload del corpo della richiesta
Nome Proprietà | Tipo | Descrizione |
---|---|---|
name | string | il nome di questo modello |
admin | boolean | Se il modello è admin |
Payload della risposta
Nome Proprietà | Tipo | Descrizione |
---|---|---|
id | string | l'id del server |
name | string | il nome di questo modello |
admin | boolean | Se il modello è admin |
Esempio di richiesta
curl 'https://apis.example.com/v1/example' \
-H 'Content-Type: application/json' \
-H 'Authorization: ${TOKEN}' \
-d \
'{
"name": "test",
"admin": true
}'
Nell'esempio sopra, sostituiresti ${TOKEN}
con il token di autorizzazione generato, fai riferimento a: Autorizzazione utente.
Una richiesta riuscita è indicata da un codice di stato HTTP 200 OK
. La risposta contiene l'id del tuo modello
Esempio di risposta
{
"id": "A163D1C8AA1FD43CAF521B74FC5A46BE",
"name": "test",
"admin": "true",
"expiresIn": "3600"
}
Codici di errore comuni
invalid_argument
: il [name] potrebbe essere troppo lungo per il databasepermission_denied
: potresti non avere il permesso per questa operazione
Per altri errori potresti dover fare riferimento al codice di errore globale.
Codice sorgente del documento in inglese
Brainstorming
# 💡 Brainstorm: Aggiungi un argomento
| **Goal** | What kinds of ideas do you want? |
| ---------------- | ----------------------------------- |
| **Participants** | @mention yourself and others |
| **Related** | - + (some Related documents ) |
## Inspiration
Add images, videos, and more by using the toolbar that appears when you hit return
## Ideas
Ask the group a question to get things flowing
----------
## Next steps
[ ] Think outside the box @someone
[ ] From to do to done @someone
Piano di progetto
# 📋 Project plan: Add a project
| **Description** | What do you have in mind? |
| --------------- | --------------------------------------------------------------------------------------------------------------------------------- |
| **Status** | Early 🌱 | In progress 🔨 | Finished ⭐ |
| **Team** | Role: @someone<br>Role: @someone |
| **Related** | - [document1](document1.md) <br>- [document2](http://document2.md) |
## Timeline
Title | Dates | Assigned to | Description
--- | --- | --- | ---
| March 1, 2019 - March 6, 2019 | |
## Details
Add images, videos, and more by using the toolbar that appears when you hit return
## To-dos
[ ] We’ll get this done @someone
[ ] Let’s tackle this today @someone
Note riunione
# 🕘 Meeting notes: Add an event name
# Mar 2, 2019
****
## Attendees
@mention yourself and add others
## Agenda
- Stuff to talk about
## Discussion
- Stuff we actually talked about
## Action items
[ ] Let’s get this done @someone
Modelli REST API
### The title of your rest api
Some description of your api
**Method:** POST
**Content-Type:** application/json
**Endpoint**
```bash
https://apis.example.com/v1/example
Request Body Payload
Property Name | Type | Description |
---|---|---|
name | string | the name of this model |
admin | boolean | Whether the model is admin |
Response Payload
Property Name | Type | Description |
---|---|---|
id | string | the id of the server |
name | string | the name of this model |
admin | boolean | Whether the model is admin |
Sample request
curl 'https://apis.example.com/v1/example' \
-H 'Content-Type: application/json' \
-H 'Authorization: ${TOKEN}' \
-d \
'{
"name": "test",
"admin": true
}'
In the example above, you would replace ${TOKEN}
with the generated Auth token, Refer: User Authorization .
A successful request is indicated by a 200 OK
HTTP status code. The response contains id of your model
Sample response
{
"id": "A163D1C8AA1FD43CAF521B74FC5A46BE",
"name": "test",
"admin": "true",
"expiresIn": "3600"
}
Common error codes
invalid_argument
: the [name] may be tool long for databasepermission_denied
: you may have no permission for this operation
Other errors you may need to refer to the global error code.