README: build from source path and CLI example output are out of date
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 2/5
- Tempo stimato
- 1-3 ore
- Idoneità per principianti
- 92/100
- Tipo di issue
- Documentazione
- Chiarezza
- Specificata chiaramente
- Stato di attività
- Attiva
- Stack tecnologico
- go
- Ambito
- build-system, cli, documentation
Direzione di ricerca
Aggiorna le sezioni Source, CLI Example e gli esempi di toxic-attributes nel README. Esegui prima make build, avvia ./dist/toxiproxy-server e confronta i comandi e l'output documentati con toxiproxy-cli list; il lavoro è completato quando il percorso, l'indicazione del comando, le colonne, il valore di enabled e l'uso ripetuto di -a corrispondono tutti alla CLI attuale.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
A few parts of the README no longer match what the tools actually do.
- Build from source
The "Source" install section says:
$ make build
$ ./toxiproxy-server
make build writes the binaries to dist/, so ./toxiproxy-server does not exist.
The command should be ./dist/toxiproxy-server.
- CLI example output
In the "CLI Example" section, the output shown for toxiproxy-cli list does not
match the current CLI:
- The hint says
toxiproxy-client inspect <proxyName>, but the CLI prints
toxiproxy-cli inspect <proxyName>. - The columns are shown as
Listen, Upstream, Name, Enabled, Toxicswithtrue
in the Enabled column. The CLI printsName, Listen, Upstream, Enabled, Toxics
and showsenabled.
- Setting multiple toxic attributes
The example only shows a single attribute (-a latency=1000). It is not obvious
how to pass more than one. The CLI accepts the -a flag multiple times
(-a latency=1000 -a jitter=500), which is not mentioned anywhere. This was
also a point of confusion in #139.
Steps to reproduce: build from main with make build, start
./dist/toxiproxy-server, and run the commands from the "CLI Example" section.
- Lingua principale
- Go
- Stelle
- 12.4k
- Fork
- 509
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Preparare l'ambiente
Non abbiamo ancora controllato i file di configurazione di questo progetto. 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 Shopify/toxiproxy
-
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 65/100
-
Difficoltà 3/5 1-2 giorni Idoneità per principianti 38/100
-
Difficoltà 4/5 3-5 giorni Idoneità per principianti 35/100
-
Add docker compose sampleAperta
Difficoltà 3/5 1-2 giorni Idoneità per principianti 35/100
-
Difficoltà 5/5 Più di una settimana Idoneità per principianti 20/100
Tutte le issue di Shopify/toxiproxy
Issue simili
-
bug
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 92/100
open-telemetry/opentelemetry-go-compile-instrumentation#1417 ·
I maintainer di solito rispondono entro 2 giorni
-
agent-research-finding agent-research-recommend chore ready-for-agent
Difficoltà 2/5 1-3 ore Idoneità per principianti 85/100
jordansmall/spindrift#4068 · 1 commento ·
I maintainer di solito rispondono entro 1 giorno
-
Type/Task
Difficoltà 2/5 1-3 ore Idoneità per principianti 74/100
OpenNSW/nsw-srilanka#537 ·
I maintainer di solito rispondono entro 1 giorno
-
security
Difficoltà 2/5 1-2 giorni Idoneità per principianti 62/100
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 90/100
I maintainer di solito rispondono entro 1 giorno