Skip to content

Commit f5ddf3e

Browse files
authored
docs: fix broken links, invalid JSON, and unclear terminology (#1697)
1 parent 0d1468f commit f5ddf3e

6 files changed

Lines changed: 12 additions & 12 deletions

File tree

docs/getting-started/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Graph Explorer is distributed as a Docker image. The image includes the Graph Ex
44

55
## Try It Out
66

7-
The fastest way to try Graph Explorer is with the [Air Routes sample](../../samples/air_routes/readme.md). It launches Graph Explorer and a Gremlin Server pre-loaded with sample data using Docker Compose — no database setup or AWS account required.
7+
The fastest way to try Graph Explorer is with the [Air Routes sample](../../samples/air_routes/README.md). It launches Graph Explorer and a Gremlin Server pre-loaded with sample data using Docker Compose — no database setup or AWS account required.
88

99
### Prerequisites
1010

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# Connecting to BlazeGraph
22

3-
- Build and run the Docker container as normal and connect the proxy-server to BlazeGraph and your workbench to the proxy-server.
4-
- If using Docker, ensure that the container running the workbench can properly access the container running BlazeGraph. You can find documentation on how to connect containers via [Docker networks](https://docs.docker.com/network/).
3+
- Build and run the Docker container as normal and connect Graph Explorer to BlazeGraph through the proxy server.
4+
- If using Docker, ensure that the container running Graph Explorer can properly access the container running BlazeGraph. You can find documentation on how to connect containers via [Docker networks](https://docs.docker.com/network/).

docs/guides/troubleshooting.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Which will result in the following URLs:
3232

3333
### HTTP Only
3434

35-
If you do not want to use SSL and HTTPS, you can disable it by setting the following [environment variables](/docs/development.md#environment-variables):
35+
If you do not want to use SSL and HTTPS, you can disable it by setting the following [environment variables](../development.md#environment-variables):
3636

3737
```
3838
PROXY_SERVER_HTTPS_CONNECTION=false
@@ -65,7 +65,7 @@ The following instructions can be used as an example to bypass the warnings for
6565
<!-- prettier-ignore -->
6666
> [!TIP]
6767
> To get rid of the "Not Secure" warning, see
68-
[Using self-signed certificates on Chrome](/docs/development.md#using-self-signed-certificates-on-chrome).
68+
[Using self-signed certificates on Chrome](../development.md#using-self-signed-certificates-on-chrome).
6969

7070
## Schema Sync Fails
7171

@@ -165,5 +165,5 @@ New Neptune Notebooks automatically apply the correct IAM permissions to write t
165165

166166
Below are examples of which IAM permissions you need for Graph Explorer.
167167

168-
- [IAM permissions for Neptune DB](/docs/guides/deploy-to-sagemaker/graph-explorer-neptune-db-policy.json)
169-
- [IAM permissions for Neptune Analytics](/docs/guides/deploy-to-sagemaker/graph-explorer-neptune-analytics-policy.json)
168+
- [IAM permissions for Neptune DB](./deploy-to-sagemaker/graph-explorer-neptune-db-policy.json)
169+
- [IAM permissions for Neptune Analytics](./deploy-to-sagemaker/graph-explorer-neptune-analytics-policy.json)

docs/references/default-connection.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,24 +27,24 @@ These are the valid environment variables used for the default connection, their
2727

2828
First, create a `config.json` file containing values for the connection attributes:
2929

30-
```js
30+
```json
3131
{
3232
"PUBLIC_OR_PROXY_ENDPOINT": "https://public-endpoint",
3333
"GRAPH_CONNECTION_URL": "https://{your-cluster-id}.us-west-2.neptune.amazonaws.com:8182",
3434
"USING_PROXY_SERVER": true,
3535
"IAM": true,
3636
"SERVICE_TYPE": "neptune-db",
3737
"AWS_REGION": "us-west-2",
38-
// Possible Values are "gremlin", "sparql", "openCypher"
3938
"GRAPH_TYPE": "gremlin",
4039
"GRAPH_EXP_HTTPS_CONNECTION": true,
4140
"PROXY_SERVER_HTTPS_CONNECTION": true,
42-
// Measured in milliseconds (i.e. 240000 is 240 seconds or 4 minutes)
4341
"GRAPH_EXP_FETCH_REQUEST_TIMEOUT": 240000,
44-
"GRAPH_EXP_NODE_EXPANSION_LIMIT": 500,
42+
"GRAPH_EXP_NODE_EXPANSION_LIMIT": 500
4543
}
4644
```
4745

46+
`GRAPH_TYPE` accepts `"gremlin"`, `"sparql"`, or `"openCypher"`. `GRAPH_EXP_FETCH_REQUEST_TIMEOUT` is measured in milliseconds (e.g., 240000 is 4 minutes).
47+
4848
Pass the `config.json` file path to the `docker run` command.
4949

5050
```bash

samples/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,4 @@ These samples show possible configurations of Graph Explorer using open source d
66

77
This sample uses Gremlin Server as the database pre-loaded with the air routes sample data and shows how to configure Graph Explorer to connect to it automatically with a default connection.
88

9-
[Air Routes](./air_routes/readme.md)
9+
[Air Routes](./air_routes/README.md)
File renamed without changes.

0 commit comments

Comments
 (0)