API Documentation Detail
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Idoneità per principianti
- 25/100
- Tipo di issue
- Documentazione
- Chiarezza
- Da chiarire
- Stato di attività
- Ferma
- Stack tecnologico
- graphql
- Ambito
- api, databases, documentation, testing
Direzione di ricerca
Inizia facendo un inventario delle aree di documentazione richieste: migrazioni e dump del database, convenzioni di denominazione di db, buildQuery, wrangler.toml e lo script dello scraper, endpoint REST e GraphQL e test. Esamina il sito della documentazione esistente e le posizioni delle pagine della documentazione prima di scrivere. Il lavoro è completato quando il workflow documentato copre le modifiche al database fino al testing degli endpoint, inclusi codici di errore, esempi, file modificati e aree a cui prestare attenzione.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
DB Design / Changes:
- db migrations + process of implementation of a new db change + documentation for all moving parts (db dump, process of running migration file on local instance, testing scraper - where to find script)
- db naming conventions
- buildQuery
Scraper:
- documentation on understanding wrangler.toml files, how scrapers work, what to expect from them
Endpoint:
- error codes and meanings GOOD PRACTICE - along with endpoint info.
- rest endpoint
- all files changed
- areas of focus, things to look out for
- what a typical change entails
- graphql
- difference between rest and graphql
- example of implementation
- where to test on docs page
Testing:- testing throughout the process [db change -> endpoint]
- Lingua principale
- MDX
- Stelle
- 0
- Fork
- 1
- Merge medio
- 23g 5h
- PR unite (30g)
- 1
Preparare l'ambiente
Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di icssc/docs
-
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 45/100
-
OG Images 404Forse di nuovo libera @alexanderl19 l’ha presa 639 giorni fa e non c’è nessuna pull request aperta. Apertabug
-
Deploys & Staging PreviewsForse di nuovo libera @andrew-wang0 l’ha presa 641 giorni fa e non c’è nessuna pull request aperta. Aperta
-
Add Page DescriptionsForse di nuovo libera @alexanderl19 l’ha presa 696 giorni fa e non c’è nessuna pull request aperta. Aperta
-
Centralized Calendar API Reference and ArchitectureForse già presa @spicecat l’ha presa 865 giorni fa. Apertadocs:addition
Issue simili
-
room-commons replace accepts an empty old string and silently prepends the new text to the pageAperta
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 68/100
doobidoo/mcp-memory-service#1650 ·
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 76/100
I maintainer di solito rispondono entro 1 giorno
-
yandex engine: parsing error from a russian IP, yandex.com redirects to yandex.ruForse già presa @evgeniylebedev l’ha presa oggi. Aperta
Difficoltà 2/5 1-3 ore Idoneità per principianti 73/100
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 88/100
objectionary/phino#2058 ·
I maintainer di solito rispondono entro 1 giorno