Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: revise readme #455

Merged
merged 18 commits into from
Dec 11, 2023
Merged

docs: revise readme #455

merged 18 commits into from
Dec 11, 2023

Conversation

inventarSarah
Copy link
Contributor

A summary of the changes:

  • fix typos and the likes
  • add "alerts" to highlight information and make text more interesting
  • add list of integrations at the top
  • put sponsor/donor-related information into one section
  • add a new section that describes the basics of writing tests
    • moved some content from the "best practices" and "integration" sections in there but also added new content
  • streamline integrations section to focus on their benefits and what sets them apart (repeating information (eg what types of locations you can provide) have been moved to the "get started writing tests" section
  • restructure Best practice section
    • moved "basic" information to the new section
    • created a subsection that talks about location-specific tips
    • moved everything that is not a best practice into a new section, "things to keep in mind"
    • I also added emojis here - it helps make the text look more interesting and because we want to have more interesting headers here anyway, I thought it would be a good fit
  • added a support and feedback section

README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@jimaek
Copy link
Member

jimaek commented Dec 6, 2023

I stopped the review at the last comment, will continue after the updates.
Also we're about to ship a new feature #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
Copy link
Contributor Author

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

@inventarSarah
Copy link
Contributor Author

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)

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@@ -193,124 +242,119 @@ Other acceptable location examples:
- as396982, as16509
- comcast, google, ovh, orange, t-mobile
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lets add:

  • eyeball, datacenter

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
This is completely automated and managed by our platform.
Here's when a probe is considered online and available through our API:
- **It's up-to-date.** A probe running an older version will be forced to auto-update before it becomes available.
- **It passes quality control tests.** Every probe must pass a test, ensuring it's connected to a reasonably stable network without packet loss. This test is done regularly; if a probe fails, it gets taken offline.
Copy link
Member

@jimaek jimaek Dec 11, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lets add:

  • It's not behind a VPN. We block probes that we detect as being hosted behind a VPN or any other proxying technique. Such probes would report incorrect latency and routing data making them unusable.

@jimaek jimaek merged commit 74355a3 into jsdelivr:master Dec 11, 2023
@jimaek
Copy link
Member

jimaek commented Dec 11, 2023

Thank you

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants