Repository navigation
Describe the examples as they run today in AGENTS.md and the example READMEs - #162
Draft
jwrosewell wants to merge 1 commit into
Draft
jwrosewell wants to merge 1 commit into
jwrosewell wants to merge 1 commit into
Conversation
…READMEs AGENTS.md said the IP Intelligence example needs the Lite file as an argument and stops without one, that an example started in an examples folder cannot find its data file, and gave output with a pricing link. The examples now default to the Lite file, look for cxx/data in each folder above the one Java runs in, and end with the Enterprise note, the contact link and the Find out more section. The READMEs gave jar names from 4.4.20 and 4.4.19, and the IP Intelligence README named only TestResourceKey for the cloud examples.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Documentation only. AGENTS.md and the two example READMEs described how the examples behaved before the free data file and Find out more changes, so an agent or a person following them was told to pass the Lite file as an argument, to run from the repository root only, and to expect a pricing link.
What was out of date
Failed to find IP Intelligence data fileand stops, and that an example started inexamples/device-detectioncannot find its data file. Onrcthe examples default to the free Lite file, download it when it is missing, and look forcxx/datain the folder Java runs in and each folder above it (#48, #133).All doneand the Find out more section.TestResourceKeyfor the cloud examples, which read_51DEGREES_RESOURCE_KEYfirst.What changed
AGENTS.md's Run, Correct output and Pitfalls sections, and the jar names, run notes and key name in examples/device-detection/README.md and examples/ip-intelligence/README.md, in commit 3842399d.
How it was checked
The text was written from runs of the examples, not from the code.
GettingStartedOnPremandOfflineProcessingfrom the examples folder with no arguments, on ubuntu-22.04 and windows-latest. All eight runs ended with exit code 0, downloaded or found the Lite file, readneeds the Enterprise data filefor each property the Lite file lacks, and closed with the contact note,Used a 'Lite' data file,All doneand the Find out more section, in that order, as the new Correct output section gives.Checks
Documentation only, so no full build. The pull request's quick checks run on the head.
What it releases
Nothing. Markdown changes release nothing (ci/README.md).
Base branch
rcat de74c8c. A trial merge with #137, #158 and #159 is clean.What remains