From 31db77efaefb9f738ea6cb14ff02bb0e6228b344 Mon Sep 17 00:00:00 2001 From: Kris McGinnes Date: Mon, 9 Mar 2026 16:44:03 -0500 Subject: [PATCH] Rename additionaldocs to docs --- .dockerignore | 2 +- .kiro/steering/documentation.md | 2 +- README.md | 24 +++++++++--------- {additionaldocs => docs}/README.md | 0 {additionaldocs => docs}/connections.md | 0 {additionaldocs => docs}/development.md | 0 .../ecs/ECS_FARGATE_DEPLOYMENT.md | 0 .../ecs/images/ecs-cluster.png | Bin .../ecs/images/fargate-service.png | Bin .../ecs/images/iam-role.png | Bin .../ecs/images/target-group.png | Bin {additionaldocs => docs}/features/README.md | 0 .../getting-started/README.md | 0 {additionaldocs => docs}/sagemaker/README.md | 0 ...aph-explorer-neptune-analytics-policy.json | 0 .../graph-explorer-neptune-db-policy.json | 0 .../sagemaker/install-graph-explorer-lc.sh | 0 {additionaldocs => docs}/troubleshooting.md | 8 +++--- 18 files changed, 18 insertions(+), 18 deletions(-) rename {additionaldocs => docs}/README.md (100%) rename {additionaldocs => docs}/connections.md (100%) rename {additionaldocs => docs}/development.md (100%) rename {additionaldocs => docs}/ecs/ECS_FARGATE_DEPLOYMENT.md (100%) rename {additionaldocs => docs}/ecs/images/ecs-cluster.png (100%) rename {additionaldocs => docs}/ecs/images/fargate-service.png (100%) rename {additionaldocs => docs}/ecs/images/iam-role.png (100%) rename {additionaldocs => docs}/ecs/images/target-group.png (100%) rename {additionaldocs => docs}/features/README.md (100%) rename {additionaldocs => docs}/getting-started/README.md (100%) rename {additionaldocs => docs}/sagemaker/README.md (100%) rename {additionaldocs => docs}/sagemaker/graph-explorer-neptune-analytics-policy.json (100%) rename {additionaldocs => docs}/sagemaker/graph-explorer-neptune-db-policy.json (100%) rename {additionaldocs => docs}/sagemaker/install-graph-explorer-lc.sh (100%) rename {additionaldocs => docs}/troubleshooting.md (94%) diff --git a/.dockerignore b/.dockerignore index 0c6d25db4..bd235c830 100644 --- a/.dockerignore +++ b/.dockerignore @@ -10,6 +10,6 @@ node_modules coverage # Ignore documentation related files -additionaldocs +docs images *.md diff --git a/.kiro/steering/documentation.md b/.kiro/steering/documentation.md index 0a47a4a7e..c00eafd75 100644 --- a/.kiro/steering/documentation.md +++ b/.kiro/steering/documentation.md @@ -1,6 +1,6 @@ --- inclusion: fileMatch -fileMatchPattern: "{**/*.md,additionaldocs/**}" +fileMatchPattern: "{**/*.md,docs/**}" --- # Project Documentation Standards diff --git a/README.md b/README.md index 33af5d616..68ae905e0 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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 @@ -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 @@ -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 @@ -160,13 +160,13 @@ If either Graph Explorer or the proxy-server are served over an HTTPS connection > [!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). > [!CAUTION] diff --git a/additionaldocs/README.md b/docs/README.md similarity index 100% rename from additionaldocs/README.md rename to docs/README.md diff --git a/additionaldocs/connections.md b/docs/connections.md similarity index 100% rename from additionaldocs/connections.md rename to docs/connections.md diff --git a/additionaldocs/development.md b/docs/development.md similarity index 100% rename from additionaldocs/development.md rename to docs/development.md diff --git a/additionaldocs/ecs/ECS_FARGATE_DEPLOYMENT.md b/docs/ecs/ECS_FARGATE_DEPLOYMENT.md similarity index 100% rename from additionaldocs/ecs/ECS_FARGATE_DEPLOYMENT.md rename to docs/ecs/ECS_FARGATE_DEPLOYMENT.md diff --git a/additionaldocs/ecs/images/ecs-cluster.png b/docs/ecs/images/ecs-cluster.png similarity index 100% rename from additionaldocs/ecs/images/ecs-cluster.png rename to docs/ecs/images/ecs-cluster.png diff --git a/additionaldocs/ecs/images/fargate-service.png b/docs/ecs/images/fargate-service.png similarity index 100% rename from additionaldocs/ecs/images/fargate-service.png rename to docs/ecs/images/fargate-service.png diff --git a/additionaldocs/ecs/images/iam-role.png b/docs/ecs/images/iam-role.png similarity index 100% rename from additionaldocs/ecs/images/iam-role.png rename to docs/ecs/images/iam-role.png diff --git a/additionaldocs/ecs/images/target-group.png b/docs/ecs/images/target-group.png similarity index 100% rename from additionaldocs/ecs/images/target-group.png rename to docs/ecs/images/target-group.png diff --git a/additionaldocs/features/README.md b/docs/features/README.md similarity index 100% rename from additionaldocs/features/README.md rename to docs/features/README.md diff --git a/additionaldocs/getting-started/README.md b/docs/getting-started/README.md similarity index 100% rename from additionaldocs/getting-started/README.md rename to docs/getting-started/README.md diff --git a/additionaldocs/sagemaker/README.md b/docs/sagemaker/README.md similarity index 100% rename from additionaldocs/sagemaker/README.md rename to docs/sagemaker/README.md diff --git a/additionaldocs/sagemaker/graph-explorer-neptune-analytics-policy.json b/docs/sagemaker/graph-explorer-neptune-analytics-policy.json similarity index 100% rename from additionaldocs/sagemaker/graph-explorer-neptune-analytics-policy.json rename to docs/sagemaker/graph-explorer-neptune-analytics-policy.json diff --git a/additionaldocs/sagemaker/graph-explorer-neptune-db-policy.json b/docs/sagemaker/graph-explorer-neptune-db-policy.json similarity index 100% rename from additionaldocs/sagemaker/graph-explorer-neptune-db-policy.json rename to docs/sagemaker/graph-explorer-neptune-db-policy.json diff --git a/additionaldocs/sagemaker/install-graph-explorer-lc.sh b/docs/sagemaker/install-graph-explorer-lc.sh similarity index 100% rename from additionaldocs/sagemaker/install-graph-explorer-lc.sh rename to docs/sagemaker/install-graph-explorer-lc.sh diff --git a/additionaldocs/troubleshooting.md b/docs/troubleshooting.md similarity index 94% rename from additionaldocs/troubleshooting.md rename to docs/troubleshooting.md index afe93d0a2..0fa27c114 100644 --- a/additionaldocs/troubleshooting.md +++ b/docs/troubleshooting.md @@ -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 @@ -65,7 +65,7 @@ The following instructions can be used as an example to bypass the warnings for > [!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 @@ -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)