jsdelivr / globalping

A global network of probes to run network tests like ping, traceroute and DNS resolve
https://www.jsdelivr.com/globalping
248 stars 31 forks source link

docs: revise readme #455

Closed inventarSarah closed 9 months ago

inventarSarah commented 9 months ago

A summary of the changes:

jimaek commented 9 months ago

I stopped the review at the last comment, will continue after the updates. Also we're about to ship a new feature https://github.com/jsdelivr/globalping/pull/453 Lets document it here as well.

I think it should be in the tips and tricks section and maybe a mention in the CLI section. The idea is that the magic field can accept not just locations but also previous measurement IDs to select the exact same probes. This is useful for running comparisons of endpoints from the same probes for better data. Or to run continuous tests from the same probes

inventarSarah commented 9 months ago

RE. new feature #453

Updated the content with info about new feature -> still WIP as I need to add examples (added placeholders)

inventarSarah commented 9 months ago

RE. new feature #453

Updated the content with info about new feature -> still WIP as I need to add examples (added placeholders)

  • added info to the "Location" section within "basics of writing tests"
  • added a new section in under "best practices"
  • added info to the "no UUIDs" section

I reworked the section with the available information and added examples. Once we're happy with the readme, I can move the content for the new feature in a separate PR so you can release it when the feature's available (let me know if we should do this)

jimaek commented 9 months ago

Thank you