Skip to content

Links to the archived Java repositories point at their folders here - #31

Merged
jwrosewell merged 1 commit into
rcfrom
docs/monorepo-links
Nov 3, 2026
Merged

jwrosewell merged 1 commit into
rcfrom
docs/monorepo-links

Conversation

@jwrosewell

Copy link
Copy Markdown
Contributor

What changed

The six repositories this one was created from are archived, and the note at the top of each README names the folder here that now holds its code. 39 links in 37 files still pointed at those repositories. Each one now points at the same file, folder or README heading on main in this repository.

Only the URLs change. Link text, code, package names and Maven coordinates are as they were.

Mapping

Earlier repository Folder here
pipeline-java pipeline/
device-detection-java device-detection/
ip-intelligence-java ip-intelligence/
location-java location/
device-detection-java-examples examples/device-detection/
ip-intelligence-java-examples examples/ip-intelligence/

Each kind of link moved in the same way.

  • A link to the repository itself now links the folder, so https://github.com/51Degrees/ip-intelligence-java-examples became https://github.com/51Degrees/51degrees-java/tree/main/examples/ip-intelligence.
  • A link to a heading of the repository's README now links the same heading in the folder's README, so https://github.com/51Degrees/pipeline-java#native-library-access became https://github.com/51Degrees/51degrees-java/blob/main/pipeline/README.md#native-library-access.
  • A link to a file on master or main now links that file under the folder on main.

One file link needed more than the folder. The Device Detection console example UpdateDataFile.java linked device-detection-java/blob/master/device-detection-java-examples/console/..., a path the archived repository no longer has. It now links the file's own place here, examples/device-detection/console/src/main/java/fiftyone/devicedetection/examples/console/UpdateDataFile.java.

Files

Four READMEs hold six of the links.

  • device-detection/README.md, lines 215 and 222
  • examples/device-detection/README.md, line 153
  • ip-intelligence/README.md, line 107
  • pipeline/README.md, lines 97 and 125

The other 33 links are in example sources. The doc comment line "This example is available in full on GitHub" linked each source's copy in the earlier repository, and now links the same file here.

  • 12 in examples/device-detection
  • 18 in examples/ip-intelligence
  • 2 in location/geo-location.shell.examples
  • 1 in pipeline/pipeline.developer-examples, the usage sharing Main.java

How it was checked

  • Read every text file on rc at 99217cd through the API, including the two large generated C++ files in full, and searched them for links of the form github.com/51Degrees/<name>, raw.githubusercontent.com/51Degrees/<name>, 51degrees.github.io/<name> and api.github.com/repos/51Degrees/<name>.
  • Confirmed with gh repo view that the six repositories are archived, and read the note at the top of each README for its folder here.
  • Checked every new target against the tree of main at e4d9f53, and every heading against the headings of the README it names. main and rc differ only in README.md, .github/images/logo.png and .github/workflows/only-rc-into-main.yml, so each target is the same on both.
  • Compared every changed file with its rc version byte by byte. The 39 links are the only changed lines, and the line endings are as they were, CRLF in device-detection/README.md and LF in the other 36.
  • No build or test was run, because only comments and README text changed.

Links left as they are

  1. The History section of the root README.md, lines 132 to 137 and 142 to 148, with 12 links. The section names the earlier repositories on purpose, as the record of where this code came from (README: what it does, how to install it and where it came from #26), so its links stay on them.
  2. Two Java string constants in the message shown when the native library fails to load, line 32 of device-detection/.../interop/Constants.java and of ip-intelligence/.../interop/Constants.java. They are code, which this change does not touch.
  3. The creator context demo page page.html links https://github.com/51Degrees/pipeline-java on line 150, and CreatorContextPageTests.java checks on line 306 that the page contains that address. Changing the page alone would fail The_Page_Ends_With_Find_Out_More, and the test is code.
  4. The <scm> <url> and <connection> of the four parent poms, pipeline/pom.xml, device-detection/pom.xml, ip-intelligence/pom.xml and location/pom.xml. The open pull request on package text (Package descriptions use the words people search for, and source links point at this repository #27) changes these four poms and six others, and it already points these links here, so this change leaves its ten files alone.
  5. Links to repositories that are not archived, which are device-detection-data and ip-intelligence-data (10 links in 7 files), specifications, common-ci and selenium-api-tests.

No link pins a tag or a commit of an earlier repository, and nothing here links an earlier repository of another language.

Still open

  • Items 2 and 3 need a code change of their own. The matching addresses here are https://github.com/51Degrees/51degrees-java/tree/main/device-detection, https://github.com/51Degrees/51degrees-java/tree/main/ip-intelligence and https://github.com/51Degrees/51degrees-java/tree/main/pipeline, and the test in item 3 would change with the page.
  • Some link text still names the earlier repositories, for example "device-detection-java README" and "Examples can be found in device-detection-java-examples repository.", because only URLs were in scope.
  • pipeline/README.md line 125 says device detection examples are in "the corresponding repository". It now links device-detection/, the equivalent of the repository it linked, and that folder's README links on to the examples. Linking examples/device-detection/ instead would save a step.

pipeline-java, device-detection-java, ip-intelligence-java,
location-java, device-detection-java-examples and
ip-intelligence-java-examples are archived, and the note at the top of
each README names the folder of this repository that now holds its
code. Four READMEs and 33 example source files still linked those
repositories, so each of the 39 links now points at the same file,
folder or README heading on main here.

Only the URLs change. The History section of the root README, two Java
string constants, the creator context demo page and its test, and the
four parent poms that the open package text pull request (#27) changes
keep their links.
@jwrosewell
jwrosewell marked this pull request as ready for review November 3, 2026 19:53
@jwrosewell
jwrosewell merged commit 9ffbcf8 into rc Nov 3, 2026
2 checks passed
@jwrosewell
jwrosewell deleted the docs/monorepo-links branch November 3, 2026 19:53
jwrosewell added a commit that referenced this pull request Nov 4, 2026
* README: what it does, how to install it and where it came from (#26)

The README now opens with what the code does in the words developers search for, then the install command, try-it links and, where there are any, the repositories it was created from. It ends with a Find out more section, and the logo is a file in the repository. Everything else the README said is kept.

* Check that only rc merges into the default branch (#29)

* Point links to the archived Java repositories at their folders here (#31)

pipeline-java, device-detection-java, ip-intelligence-java,
location-java, device-detection-java-examples and
ip-intelligence-java-examples are archived, and the note at the top of
each README names the folder of this repository that now holds its
code. Four READMEs and 33 example source files still linked those
repositories, so each of the 39 links now points at the same file,
folder or README heading on main here.

Only the URLs change. The History section of the root README, two Java
string constants, the creator context demo page and its test, and the
four parent poms that the open package text pull request (#27) changes
keep their links.

* Drop the moved example folders and fix the native model example name (#33)

The examples moved to examples/, which the device detection and IP
Intelligence Doxyfiles already read, so the old folders go. Point the
location IMAGE_PATH at the shared documentation images, and name the
native model example console/NativeModelCloud.java in place of the
doubled example command.

* Link this repository from the native library message and the demo page (#32)

When the native library fails to load, both on-premise engines suggest
rebuilding the binary from the source code and instructions in
device-detection-java or ip-intelligence-java, which are archived. The
instructions for building the native binary are now in the README of
device-detection/ and ip-intelligence/ here, beside the engine source,
so the message links those folders.

The creator context demo page linked pipeline-java as the source of the
demo and of the code it runs on, and now links pipeline/ here. The test
that checks the page ends with somewhere to go next asserts the new
address.

* Link the hardware profile engine to its specification page (#34)

* Merged Pull Request '#36 update-packages/rc->rc: Update packages'

Co-authored-by: Automation51D <51DCI@51Degrees.com>

* Merged Pull Request '#35 update-submodules/rc->rc: Update submodules'

Co-authored-by: Automation51D <51DCI@51Degrees.com>

---------

Co-authored-by: Automation51D <60396166+Automation51D@users.noreply.github.com>
Co-authored-by: Automation51D <51DCI@51Degrees.com>
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