Skip to content

Describe the examples as they run today in AGENTS.md and the example READMEs - #162

Draft
jwrosewell wants to merge 1 commit into
rcfrom
docs/examples-as-they-run
Draft

jwrosewell wants to merge 1 commit into
rcfrom
docs/examples-as-they-run

Conversation

@jwrosewell

Copy link
Copy Markdown
Contributor

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

  • AGENTS.md said the IP Intelligence example looks for the Enterprise file and needs the Lite file as an argument, that without one it logs Failed to find IP Intelligence data file and stops, and that an example started in examples/device-detection cannot find its data file. On rc the examples default to the free Lite file, download it when it is missing, and look for cxx/data in the folder Java runs in and each folder above it (#48, #133).
  • Its Correct output section gave a pricing link and none of the closing lines the examples write now, being the Enterprise note with the contact link, the data file line, All done and the Find out more section.
  • The READMEs gave jar names from 4.4.20 and 4.4.19, where the examples folders' own version is 4.5.127-SNAPSHOT, and the IP Intelligence README named only TestResourceKey for the cloud examples, which read _51DEGREES_RESOURCE_KEY first.

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.

  • Run 43673589701, on the head plus a throwaway workflow, built each product's console examples as its README says and ran GettingStartedOnPrem and OfflineProcessing from 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, read needs the Enterprise data file for each property the Lite file lacks, and closed with the contact note, Used a 'Lite' data file, All done and the Find out more section, in that order, as the new Correct output section gives.
  • The Run section's commands from the repository root are those of the fresh clone workflow, whose green run 43584351849 on #137 gave the output the section quotes.

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

rc at de74c8c. A trial merge with #137, #158 and #159 is clean.

What remains

  • The Cloud examples section still says what the cloud examples do with no resource key today. The change that makes a cloud example with no key end cleanly, which is next, updates that section with it.

…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.
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.

1 participant