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.

Sign up for GitHub

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

Replace table of GeoIP client APIs with links to specific sections of… #1243

Merged
merged 3 commits into from
Jan 2, 2025
Merged

Replace table of GeoIP client APIs with links to specific sections of… #1243

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7a94f55
Replace table of GeoIP client APIs with links to specific sections of…
kevcenteno Dec 10, 2024
9dd2de3
Use relative links in binary database snippet
kevcenteno Dec 11, 2024
a47e253
Remove mention of OSS license
kevcenteno Jan 2, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions assets/snippets/binary-databases.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
Binary databases make use of the
[MaxMind DB file format](https://maxmind.github.io/MaxMind-DB/). MaxMind
provides official client APIs in the language listed below. The following client
APIs are open source and licensed under the Apache License, Version 2.0.
provides [official client APIs](https://dev.maxmind.com/geoip/docs/databases/#official-client-apis)
Copy link
Member

Choose a reason for hiding this comment

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

These links probably shouldn't include the scheme and hostname. It might make sense to use ref/relref too, but I don't see us using that Hugo feature elsewhere.

Copy link
Member Author

Choose a reason for hiding this comment

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

Good catch: 9dd2de3

that are open source and licensed under the Apache License, Version 2.0. We also provide a list of
Copy link
Member

Choose a reason for hiding this comment

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

This is not new, but for newer things, we tend to license under Apache 2 or MIT rather than just Apache 2. This makes our libraries more compatible with GPL v2. The Ruby libraries, for instance, are licensed this way.

Copy link
Member Author

Choose a reason for hiding this comment

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

Ah okay, should I mention that our open source libraries are licensed under either Apache or MIT, or could I just omit mentioning the license types?

Copy link
Member

Choose a reason for hiding this comment

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

I personally think we could just leave it vague without specifying the particular licenses. @christophermluna do you have a preference?

Copy link
Member Author

Choose a reason for hiding this comment

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

I'm going to keep things vague. It probably makes the most sense for a license-interested reader to go straight to the client API repo to view the associated license.

[unsupported and unofficial client APIs](https://dev.maxmind.com/geoip/docs/databases/#unofficial-client-apis)
and [unsupported and unofficial integrations](https://dev.maxmind.com/geoip/docs/databases/#integrations)
with various applications.

You can also use the [mmdbinspect tool](https://github.com/maxmind/mmdbinspect)
(in beta), a command line interface built with Go, to look up one or more IPs
Expand Down
9 changes: 0 additions & 9 deletions content/geoip/docs/databases/anonymous-ip.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,15 +16,6 @@ for assistance.

{{< snippet "snippets/binary-databases.md" >}}

| Language or Framework | Documentation | Example |
| --------------------- | ---------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
| .NET (C#) | [GitHub - Database Usage](https://github.com/maxmind/GeoIP2-dotnet#database-usage) | [Anonymous IP Example](https://github.com/maxmind/GeoIP2-dotnet#anonymous-ip-database) |
| Java | [GitHub - Database Usage](https://github.com/maxmind/GeoIP2-java#database-usage) | [Anonymous IP Example](https://github.com/maxmind/GeoIP2-java#anonymous-ip) |
| Node.js | [GitHub - Database Usage](https://github.com/maxmind/GeoIP2-node#database-usage) | [Anonymous IP Example](https://github.com/maxmind/GeoIP2-node#anonymous-ip-database-example) |
| PHP | [GitHub - Database Reader](https://github.com/maxmind/GeoIP2-php#database-reader) | [Anonymous IP Example](https://github.com/maxmind/GeoIP2-php#anonymous-ip-example) |
| Python | [GitHub - Database Usage](https://github.com/maxmind/GeoIP2-python#database-usage) | [Anonymous IP Example](https://github.com/maxmind/GeoIP2-python#anonymous-ip-database) |
| Ruby | [GitHub - Database Reader](https://github.com/maxmind/GeoIP2-ruby#database-reader) | [Anonymous IP Example](https://github.com/maxmind/GeoIP2-ruby#anonymous-ip-example) |

## CSV Database

{{< snippet "snippets/csv-databases-intro.md" >}}
Expand Down
9 changes: 0 additions & 9 deletions content/geoip/docs/databases/asn.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,15 +12,6 @@ associated with IPv4 and IPv6 addresses.

{{< snippet "snippets/binary-databases.md" >}}

| Language or Framework | Documentation | Example |
| --------------------- | ---------------------------------------------------------------------------------- | -------------------------------------------------------------------- |
| .NET (C#) | [GitHub - Database Usage](https://github.com/maxmind/GeoIP2-dotnet#database-usage) | [ASN Example](https://github.com/maxmind/GeoIP2-dotnet#asn) |
| Java | [GitHub - Database Usage](https://github.com/maxmind/GeoIP2-java#database-usage) | [ASN Example](https://github.com/maxmind/GeoIP2-java#asn) |
| Node.js | [GitHub - Database Usage](https://github.com/maxmind/GeoIP2-node#database-usage) | [ASN Example](https://github.com/maxmind/GeoIP2-node#asn-example) |
| PHP | [GitHub - Database Reader](https://github.com/maxmind/GeoIP2-php#database-reader) | &bull; |
| Python | [GitHub - Database Usage](https://github.com/maxmind/GeoIP2-python#database-usage) | [ASN Example](https://github.com/maxmind/GeoIP2-python#asn-database) |
| Ruby | [GitHub - Database Reader](https://github.com/maxmind/GeoIP2-ruby#database-reader) | [ASN Example](https://github.com/maxmind/GeoIP2-ruby#asn-example) |

## CSV Database

{{< snippet "snippets/csv-databases-intro.md" >}}
Expand Down
9 changes: 0 additions & 9 deletions content/geoip/docs/databases/city-and-country.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,15 +19,6 @@ on our product pages:

{{< snippet "snippets/binary-databases.md" >}}

| Language or Framework | Documentation | Example |
| --------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------- |
| .NET (C#) | [GitHub - Database Usage](https://github.com/maxmind/GeoIP2-dotnet#database-usage) | [City Example](https://github.com/maxmind/GeoIP2-dotnet#city-database) |
| Java | [GitHub - Database Usage](https://github.com/maxmind/GeoIP2-java#database-usage) | [City Example](https://github.com/maxmind/GeoIP2-java#city) |
| Node.js | [GitHub - Database Usage](https://github.com/maxmind/GeoIP2-node#database-usage) | [City Example](https://github.com/maxmind/GeoIP2-node#city-example) |
| PHP | [GitHub - Database Reader](https://github.com/maxmind/GeoIP2-php#database-reader) | [City Example](https://github.com/maxmind/GeoIP2-php#city-example) |
| Python | [GitHub - Database Usage](https://github.com/maxmind/GeoIP2-python#database-usage) | [City Example](https://github.com/maxmind/GeoIP2-python#city-database) |
| Ruby | [GitHub - Database Reader](https://github.com/maxmind/GeoIP2-ruby#database-reader) | [City Example](https://github.com/maxmind/GeoIP2-ruby#city-example) |

## CSV Databases

{{< snippet "snippets/csv-databases-intro.md" >}}
Expand Down
9 changes: 0 additions & 9 deletions content/geoip/docs/databases/connection-type.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,15 +16,6 @@ pricing, please

{{< snippet "snippets/binary-databases.md" >}}

| Language or Framework | Documentation | Example |
| --------------------- | ---------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
| .NET (C#) | [GitHub - Database Usage](https://github.com/maxmind/GeoIP2-dotnet#database-usage) | [Connection Type Example](https://github.com/maxmind/GeoIP2-dotnet#connection-type-database) |
| Java | [GitHub - Database Usage](https://github.com/maxmind/GeoIP2-java#database-usage) | [Connection Type Example](https://github.com/maxmind/GeoIP2-java#connection-type) |
| Node.js | [GitHub - Database Usage](https://github.com/maxmind/GeoIP2-node#database-usage) | [Connection Type Example](https://github.com/maxmind/GeoIP2-node#connection-type-example) |
| PHP | [GitHub - Database Reader](https://github.com/maxmind/GeoIP2-php#database-reader) | [Connection Type Example](https://github.com/maxmind/GeoIP2-php#connection-type-example) |
| Python | [GitHub - Database Usage](https://github.com/maxmind/GeoIP2-python#database-usage) | [Connection Type Example](https://github.com/maxmind/GeoIP2-python#connection-type-database) |
| Ruby | [GitHub - Database Reader](https://github.com/maxmind/GeoIP2-ruby#database-reader) | [Connection Type Example](https://github.com/maxmind/GeoIP2-ruby#connection-type-example) |

## CSV Database

{{< snippet "snippets/csv-databases-intro.md" >}}
Expand Down
9 changes: 0 additions & 9 deletions content/geoip/docs/databases/domain.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,15 +15,6 @@ please

{{< snippet "snippets/binary-databases.md" >}}

| Language or Framework | Documentation | Example |
| --------------------- | ---------------------------------------------------------------------------------- | -------------------------------------------------------------------------- |
| .NET (C#) | [GitHub - Database Usage](https://github.com/maxmind/GeoIP2-dotnet#database-usage) | [Domain Example](https://github.com/maxmind/GeoIP2-dotnet#domain-database) |
| Java | [GitHub - Database Usage](https://github.com/maxmind/GeoIP2-java#database-usage) | [Domain Example](https://github.com/maxmind/GeoIP2-java#domain) |
| Node.js | [GitHub - Database Usage](https://github.com/maxmind/GeoIP2-node#database-usage) | [Domain Example](https://github.com/maxmind/GeoIP2-node#domain-example) |
| PHP | [GitHub - Database Reader](https://github.com/maxmind/GeoIP2-php#database-reader) | [Domain Example](https://github.com/maxmind/GeoIP2-php#domain-example) |
| Python | [GitHub - Database Usage](https://github.com/maxmind/GeoIP2-python#database-usage) | [Domain Example](https://github.com/maxmind/GeoIP2-python#domain-database) |
| Ruby | [GitHub - Database Reader](https://github.com/maxmind/GeoIP2-ruby#database-reader) | [Domain Example](https://github.com/maxmind/GeoIP2-ruby#domain-example) |

## CSV Database

{{< snippet "snippets/csv-databases-intro.md" >}}
Expand Down
9 changes: 0 additions & 9 deletions content/geoip/docs/databases/enterprise.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,15 +21,6 @@ for assistance.

{{< snippet "snippets/binary-databases.md" >}}

| Language or Framework | Documentation | Example |
| --------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
| .NET (C#) | [GitHub - Database Usage](https://github.com/maxmind/GeoIP2-dotnet#database-usage) | [Enterprise Example](https://github.com/maxmind/GeoIP2-dotnet#enterprise-database) |
| Java | [GitHub - Database Usage](https://github.com/maxmind/GeoIP2-java#database-usage) | [Enterprise Example](https://github.com/maxmind/GeoIP2-java#enterprise) |
| Node.js | [GitHub - Database Usage](https://github.com/maxmind/GeoIP2-node#database-usage) | [Enterprise Example](https://github.com/maxmind/GeoIP2-node#enterprise-example) |
| PHP | [GitHub - Database Reader](https://github.com/maxmind/GeoIP2-php#database-reader) | [Enterprise Example](https://github.com/maxmind/GeoIP2-php#enterprise-example) |
| Python | [GitHub - Database Usage](https://github.com/maxmind/GeoIP2-python#database-usage) | [Enterprise Example](https://github.com/maxmind/GeoIP2-python#enterprise-database) |
| Ruby | [GitHub - Database Reader](https://github.com/maxmind/GeoIP2-ruby#database-reader) | [Enterprise Example](https://github.com/maxmind/GeoIP2-ruby#enterprise-example) |

## CSV Database

{{< snippet "snippets/csv-databases-intro.md" >}}
Expand Down
9 changes: 0 additions & 9 deletions content/geoip/docs/databases/isp.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,15 +15,6 @@ To learn more about the GeoIP2 ISP database, including terms and pricing, please

{{< snippet "snippets/binary-databases.md" >}}

| Language or Framework | Documentation | Example |
| --------------------- | ---------------------------------------------------------------------------------- | -------------------------------------------------------------------- |
| .NET (C#) | [GitHub - Database Usage](https://github.com/maxmind/GeoIP2-dotnet#database-usage) | [ISP Example](https://github.com/maxmind/GeoIP2-dotnet#isp-database) |
| Java | [GitHub - Database Usage](https://github.com/maxmind/GeoIP2-java#database-usage) | [ISP Example](https://github.com/maxmind/GeoIP2-java#isp) |
| Node.js | [GitHub - Database Usage](https://github.com/maxmind/GeoIP2-node#database-usage) | [ISP Example](https://github.com/maxmind/GeoIP2-node#isp-example) |
| PHP | [GitHub - Database Reader](https://github.com/maxmind/GeoIP2-php#database-reader) | [ISP Example](https://github.com/maxmind/GeoIP2-php#isp-example) |
| Python | [GitHub - Database Usage](https://github.com/maxmind/GeoIP2-python#database-usage) | [ISP Example](https://github.com/maxmind/GeoIP2-python#isp-database) |
| Ruby | [GitHub - Database Reader](https://github.com/maxmind/GeoIP2-ruby#database-reader) | [ISP Example](https://github.com/maxmind/GeoIP2-ruby#isp-example) |

## CSV Database

{{< snippet "snippets/csv-databases-intro.md" >}}
Expand Down
Loading