diff --git a/.wordlist.txt b/.wordlist.txt index 51b29076..3f2f86aa 100644 --- a/.wordlist.txt +++ b/.wordlist.txt @@ -1,4 +1,6 @@ ACL +AGPLv +AGPLv3 AOF AST Aldis @@ -39,6 +41,7 @@ Dropzone Embedder FOF FOREACH +foreach Falkor FalkorDB FalkorDB's diff --git a/_config.yml b/_config.yml index efccb889..59d7f0f0 100644 --- a/_config.yml +++ b/_config.yml @@ -1,6 +1,7 @@ remote_theme: just-the-docs/just-the-docs title: FalkorDB Docs description: The FalkorDB documentation +url: "https://docs.falkordb.com" logo: "/images/falkor-logo.png" logo_link: "https://www.falkordb.com" favicon_ico: "/images/favicon.ico" @@ -11,9 +12,9 @@ color_scheme: dark aux_links: "Docs Repository": - - "//github.com/falkordb/docs" + - "https://github.com/falkordb/docs" "FalkorDB Repository": - - "//github.com/falkordb/falkordb" + - "https://github.com/falkordb/falkordb" # Makes Aux links open in a new tab. Default is false @@ -25,10 +26,18 @@ nav_enabled: true plugins: - jekyll-sitemap - jekyll-redirect-from + - jekyll-seo-tag + +exclude: + - README.md + - Gemfile + - Gemfile.lock + - node_modules + - vendor # Footer last edited timestamp -last_edit_timestamp: true -last_edit_time_format: "%b %e %Y at %I:%M %p" # uses ruby's time format: https://ruby-doc.org/stdlib-2.7.0/libdoc/time/rdoc/Time.html +last_edit_timestamp: true +last_edit_time_format: "%b %e %Y at %I:%M %p" # uses ruby's time format: https://ruby-doc.org/core/Time.html # Footer "Edit this page on GitHub" link text gh_edit_link: true diff --git a/cloud/free-tier.md b/cloud/free-tier.md index 8da874be..c3717591 100644 --- a/cloud/free-tier.md +++ b/cloud/free-tier.md @@ -33,8 +33,7 @@ The free tier provides everything you need to explore FalkorDB and build initial | **Cloud Providers** | AWS, GCP | AWS, GCP | AWS, GCP | AWS, GCP, Azure | | **Call-to-Action** | [Sign up](https://app.falkordb.cloud/signup) | [Sign up](https://app.falkordb.cloud/signup) | [Sign up](https://app.falkordb.cloud/signup) | [Contact Us](mailto:info@falkordb.com) | -### Terms - +## Terms > ⚠️ Free instances that aren't utilized for 1 day will be stopped, and deleted after 7 days. Need an extension? Speak to [sales](https://www.falkordb.com/get-a-demo/) diff --git a/commands/index.md b/commands/index.md index e43a16c7..b09250c4 100644 --- a/commands/index.md +++ b/commands/index.md @@ -9,7 +9,7 @@ has_children: true ## FalkorDB Features -FalkorDB exposes graph database functionality within Redis using the [openCypher](https://opencypher.org/) query language. Its basic commands accept openCypher queries, while additional commands are exposed for configuration or metadata retrieval. +FalkorDB is a graph database that exposes its functionality using the [openCypher](https://opencypher.org/) query language. Its basic commands accept openCypher queries, while additional commands are exposed for configuration or metadata retrieval. ## FalkorDB API diff --git a/design/client-spec.md b/design/client-spec.md index acfdb2ee..225648ba 100644 --- a/design/client-spec.md +++ b/design/client-spec.md @@ -155,7 +155,7 @@ Each is emitted as a 2-array: 2) column name (string) ``` -The first element is the [ColumnType enum](https://github.com/FalkorDB/FalkorDB/blob/master/src/resultset/formatters/resultset_formatter.h#L14-L19), which as of RedisGraph v2.1.0 will always be `COLUMN_SCALAR`. This element is retained for backwards compatibility, and may be ignored by the client unless RedisGraph versions older than v2.1.0 must be supported. +The first element is the [ColumnType enum](https://github.com/FalkorDB/FalkorDB/blob/master/src/resultset/formatters/resultset_formatter.h#L14-L19), which as of FalkorDB v2.1.0 will always be `COLUMN_SCALAR`. This element is retained for backwards compatibility, and may be ignored by the client unless FalkorDB versions older than v2.1.0 must be supported. ### Reading result rows @@ -189,7 +189,7 @@ It is the client's responsibility to store the [ValueType enum](https://github.c The `ValueType` for the first entry is `VALUE_NODE`. The node representation contains 3 top-level elements: 1. The node's internal ID. -2. An array of all label IDs associated with the node (currently, each node can have either 0 or 1 labels, though this restriction may be lifted in the future). +2. An array of all label IDs associated with the node (nodes can have zero or more labels). 3. An array of all properties the node contains. Properties are represented as 3-arrays - [property key ID, `ValueType`, value]. ```sh @@ -232,11 +232,11 @@ The final top-level member of the GRAPH.QUERY reply is the execution statistics. The statistics always include query execution time, while any combination of the other elements may be included depending on how the graph was modified. 1. "Labels added: (integer)" -2. "Labels removed: (integer)" (since RedisGraph 2.10) +2. "Labels removed: (integer)" 3. "Nodes created: (integer)" 4. "Nodes deleted: (integer)" 5. "Properties set: (integer)" -6. "Properties removed: (integer)" (since RedisGraph 2.10) +6. "Properties removed: (integer)" 7. "Relationships created: (integer)" 8. "Relationships deleted: (integer)" 9. "Indices created: (integer)" diff --git a/design/third-party.md b/design/third-party.md index 8e371394..7992a12d 100644 --- a/design/third-party.md +++ b/design/third-party.md @@ -49,13 +49,13 @@ Below is a list of these libraries along with their respective licenses. - **License**: [Apache License 2.0](https://github.com/RoaringBitmap/CRoaring?tab=License-1-ov-file#readme) ### 11. RedisGraph -- **License**: [RSALv2](https://redis.io/legal/rsalv2-agreement/) or [SSPLv1](https://redis.io/legal/server-side-public-license-sspl/) +- **License**: [RSALv2](https://redis.io/legal/rsalv2-agreement/) or [SSPLv1](https://redis.io/legal/server-side-public-license-sspl/) or [AGPLv3](https://www.gnu.org/licenses/agpl-3.0.html) ### 12. Redis -- **License**: [RSALv2](https://redis.io/legal/rsalv2-agreement/) or [SSPLv1](https://redis.io/legal/server-side-public-license-sspl/) +- **License**: [RSALv2](https://redis.io/legal/rsalv2-agreement/) or [SSPLv1](https://redis.io/legal/server-side-public-license-sspl/) or [AGPLv3](https://www.gnu.org/licenses/agpl-3.0.html) ### 13. RediSearch -- **License**: [RSALv2](https://redis.io/legal/rsalv2-agreement/) or [SSPLv1](https://redis.io/legal/server-side-public-license-sspl/) +- **License**: [RSALv2](https://redis.io/legal/rsalv2-agreement/) or [SSPLv1](https://redis.io/legal/server-side-public-license-sspl/) or [AGPLv3](https://www.gnu.org/licenses/agpl-3.0.html) --- diff --git a/getting-started/clients.md b/getting-started/clients.md index d2ce5bea..39c61508 100644 --- a/getting-started/clients.md +++ b/getting-started/clients.md @@ -33,6 +33,8 @@ FalkorDB provides official Object-Graph Mapping (OGM) libraries that allow you t ## Additional Clients +**Note:** Some clients below were originally developed for RedisGraph. While many may work with FalkorDB due to protocol compatibility, they are not officially tested or supported. For best results, use the official FalkorDB clients listed above. + | Project | Language | License | Author | Package | | --------------------------------------------------------- | ---------- | ---------- | ------------------------------------------- | ---------------------------------------- | | [nredisstack][nredisstack-url] | .NET | MIT | [Redis][redis-url] | [nuget][nredisstack-package] | diff --git a/operations/opentelemetry.md b/operations/opentelemetry.md index cf07d9b1..476b458a 100644 --- a/operations/opentelemetry.md +++ b/operations/opentelemetry.md @@ -2,7 +2,7 @@ title: "OpenTelemetry Integration" nav_order: 5 parent: Operations -description: "Comprehensive guide for setting up OpenTelemetry observability and tracing with FalkorDB Python applications" +description: "Guide for setting up OpenTelemetry tracing with FalkorDB Python applications" redirect_from: - /opentelemetry.html - /opentelemetry @@ -10,7 +10,7 @@ redirect_from: # OpenTelemetry Tracing with FalkorDB-py Guide -This guide explains how to set up and use OpenTelemetry (OTel) to monitor and trace your FalkorDB Python applications. +This guide explains how to set up and use OpenTelemetry (OTel) tracing to monitor your FalkorDB Python applications. ## Overview diff --git a/udfs/index.md b/udfs/index.md index fd7ad9b0..7e8e9eb7 100644 --- a/udfs/index.md +++ b/udfs/index.md @@ -397,7 +397,7 @@ load_graph(g) compute_jaccard_sim(g) ``` -The scripts load our two UDF libraries `collection` and `similarity`, construct a graph, and compute Jaccard similarity between `Alice` and every other node in the graph via the query: +The scripts load our two UDF libraries, `collection` and `similarity`, construct a graph, and compute Jaccard similarity between `Alice` and every other node in the graph via the query: ```bash MATCH (alice:Person {name: 'Alice'}), (n)