Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion .dockerignore
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,6 @@ node_modules
coverage

# Ignore documentation related files
additionaldocs
docs
images
*.md
2 changes: 1 addition & 1 deletion .kiro/steering/documentation.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
inclusion: fileMatch
fileMatchPattern: "{**/*.md,additionaldocs/**}"
fileMatchPattern: "{**/*.md,docs/**}"
---

# Project Documentation Standards
Expand Down
24 changes: 12 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,8 @@ Run Graph Explorer wherever it fits your workflow: as a Docker container, on an

## Learn More

- [Getting Started](./additionaldocs/getting-started/README.md) - Set up Graph Explorer with Docker, EC2, or from source
- [Features Overview](./additionaldocs/features/README.md) - Detailed guide to all features and functionality
- [Getting Started](./docs/getting-started/README.md) - Set up Graph Explorer with Docker, EC2, or from source
- [Features Overview](./docs/features/README.md) - Detailed guide to all features and functionality
- [Roadmap](./ROADMAP.md) - See what's planned for future releases
- [Discussions](https://github.com/aws/graph-explorer/discussions) - Ask questions, share ideas, and connect with the community
- [Submit an Issue](https://github.com/aws/graph-explorer/issues/new/choose) - Report bugs or request new features
Expand All @@ -42,12 +42,12 @@ Run Graph Explorer wherever it fits your workflow: as a Docker container, on an

## Getting Started

There are many ways to deploy and run Graph Explorer. If you are new to graph databases and Graph Explorer, we recommend that you check out the [Getting Started](./additionaldocs/getting-started/README.md) guide.
There are many ways to deploy and run Graph Explorer. If you are new to graph databases and Graph Explorer, we recommend that you check out the [Getting Started](./docs/getting-started/README.md) guide.

- [Local Docker Setup](./additionaldocs/getting-started/README.md#local-docker-setup) - A quick start guide to deploying Graph Explorer locally using the official Docker image.
- [Amazon EC2 Setup](./additionaldocs/getting-started/README.md#amazon-ec2-setup) - A quick start guide to setting up Graph Explorer on Amazon EC2 with Neptune.
- [Local Development](./additionaldocs/getting-started/README.md#local-development-setup) - A quick start guide building the Docker image from source code.
- [Troubleshooting](./additionaldocs/troubleshooting.md) - A collection of helpful tips if you run in to issues while setting up Graph Explorer.
- [Local Docker Setup](./docs/getting-started/README.md#local-docker-setup) - A quick start guide to deploying Graph Explorer locally using the official Docker image.
- [Amazon EC2 Setup](./docs/getting-started/README.md#amazon-ec2-setup) - A quick start guide to setting up Graph Explorer on Amazon EC2 with Neptune.
- [Local Development](./docs/getting-started/README.md#local-development-setup) - A quick start guide building the Docker image from source code.
- [Troubleshooting](./docs/troubleshooting.md) - A collection of helpful tips if you run in to issues while setting up Graph Explorer.
- [Samples](./samples) - A collection of Docker Compose files that show various ways to configure and use Graph Explorer.

### Minimum Recommended Versions
Expand All @@ -60,7 +60,7 @@ For non-Neptune databases, we recommend at least TinkerPop 3.6.

## Connections

Graph Explorer supports visualizing both **property graphs** and **RDF graphs**. You can connect to Amazon Neptune or you can also connect to open graph databases that implement an Apache TinkerPop Gremlin endpoint or the SPARQL 1.1 protocol, such as Blazegraph. For additional details on connecting to different graph databases, see [Connections](./additionaldocs/connections.md).
Graph Explorer supports visualizing both **property graphs** and **RDF graphs**. You can connect to Amazon Neptune or you can also connect to open graph databases that implement an Apache TinkerPop Gremlin endpoint or the SPARQL 1.1 protocol, such as Blazegraph. For additional details on connecting to different graph databases, see [Connections](./docs/connections.md).

### Providing a Default Connection

Expand Down Expand Up @@ -140,13 +140,13 @@ docker run -p 80:80 -p 443:443 \

## Development

For development guidance, see [Development](./additionaldocs/development.md).
For development guidance, see [Development](./docs/development.md).

## Security

You can use Graph Explorer to connect to a publicly accessible graph database endpoint, or connect to a proxy endpoint that redirects to a private graph database endpoint.

Graph Explorer supports the HTTPS protocol by default and provides a self-signed certificate as part of the Docker image. You can choose to use HTTP instead by changing the [environment variable default settings](./additionaldocs/development.md#environment-variables).
Graph Explorer supports the HTTPS protocol by default and provides a self-signed certificate as part of the Docker image. You can choose to use HTTP instead by changing the [environment variable default settings](./docs/development.md#environment-variables).

### HTTPS Connections

Expand All @@ -160,13 +160,13 @@ If either Graph Explorer or the proxy-server are served over an HTTPS connection
<!-- prettier-ignore -->
> [!TIP]
>
> To get rid of the “Not Secure” warning, see [Using self-signed certificates on Chrome](./additionaldocs/development.md#using-self-signed-certificates-on-chrome).
> To get rid of the “Not Secure” warning, see [Using self-signed certificates on Chrome](./docs/development.md#using-self-signed-certificates-on-chrome).

## Permissions

Graph Explorer does not provide any mechanisms for controlling user permissions. If you are using Graph Explorer with AWS, Neptune permissions can be controlled through IAM roles.

For information about what permissions Graph Explorer requires check out the documentation on [SageMaker configuration](./additionaldocs/sagemaker/README.md#minimum-database-permissions).
For information about what permissions Graph Explorer requires check out the documentation on [SageMaker configuration](./docs/sagemaker/README.md#minimum-database-permissions).

<!-- prettier-ignore -->
> [!CAUTION]
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes.
8 changes: 4 additions & 4 deletions additionaldocs/troubleshooting.md → docs/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Which will result in the following URLs:

### HTTP Only

If you do not want to use SSL and HTTPS, you can disable it by setting the following [environment variables](/additionaldocs/development.md#environment-variables):
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):

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

## Schema Sync Fails

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

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

- [IAM permissions for Neptune DB](https://raw.githubusercontent.com/aws/graph-explorer/main/additionaldocs/sagemaker/graph-explorer-neptune-db-policy.json)
- [IAM permissions for Neptune Analytics](https://raw.githubusercontent.com/aws/graph-explorer/main/additionaldocs/sagemaker/graph-explorer-neptune-analytics-policy.json)
- [IAM permissions for Neptune DB](/docs/sagemaker/graph-explorer-neptune-db-policy.json)
- [IAM permissions for Neptune Analytics](/docs/sagemaker/graph-explorer-neptune-analytics-policy.json)