Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
37 commits
Select commit Hold shift + click to select a range
bfe433e
Add instructions for readme in each folder
kmcginnes Sep 9, 2025
f768d93
Add staging to changes
kmcginnes Sep 9, 2025
cd4de21
Add missing sections to ToC
kmcginnes Sep 10, 2025
dafe90e
Move ECS docs to deployment
kmcginnes Sep 10, 2025
5651f41
Move sagemaker docs to deployment
kmcginnes Sep 10, 2025
0b2f16f
Move EC2 instructions to deployment
kmcginnes Sep 10, 2025
70a8b4d
Move docker setup to deployment
kmcginnes Sep 10, 2025
129d196
Move docker build to development folder
kmcginnes Sep 10, 2025
7d2a6a5
Move environment variables to deployment folder
kmcginnes Sep 10, 2025
922607f
Move release preparation to development
kmcginnes Sep 10, 2025
e942b6c
Move development setup
kmcginnes Sep 10, 2025
7a143ea
Move troubleshooting in development
kmcginnes Sep 10, 2025
d4fbf44
Move troubleshooting tips in to folder and split
kmcginnes Sep 10, 2025
0ad8ea6
Move connections to user-guide
kmcginnes Sep 10, 2025
4a780b5
Split features doc in to files
kmcginnes Sep 11, 2025
58a6bc2
Move features in to user-guide
kmcginnes Sep 11, 2025
8f09de7
Move database connection info to getting-started
kmcginnes Sep 11, 2025
b2d825f
Update sterring to include summary
kmcginnes Sep 12, 2025
292cf38
Move connection info from root readme
kmcginnes Sep 12, 2025
0fa03f1
Move requirements in to getting started
kmcginnes Sep 12, 2025
049c669
Move security stuff to file
kmcginnes Sep 12, 2025
a51c617
Move health check and logging to file
kmcginnes Sep 12, 2025
2f72b48
Move default connection to its own file
kmcginnes Sep 12, 2025
72cb406
Fix links
kmcginnes Sep 12, 2025
21cb085
Move default-connection and update requirements
kmcginnes Sep 12, 2025
d2f2c7b
Move monitoring to administration
kmcginnes Sep 12, 2025
1df941b
Move backup-restore
kmcginnes Sep 12, 2025
d72ed7a
Move logging docs
kmcginnes Sep 12, 2025
fbe6fc8
Move database setup
kmcginnes Sep 12, 2025
1712f87
Moved default-connection.md to deployment
kmcginnes Sep 12, 2025
71d1242
Move https config
kmcginnes Sep 12, 2025
aab8182
Move platform-specific troubleshooting to deployment guides
kmcginnes Sep 12, 2025
3cb5a35
Remove extra content in readmes
kmcginnes Sep 12, 2025
86cd2ee
Remove git stuff that didn’t work
kmcginnes Sep 12, 2025
0db929e
Rename additionaldocs to docs
kmcginnes Sep 12, 2025
f520799
Remove extraneous code fence
kmcginnes Sep 12, 2025
a43d317
Remove generated docs
kmcginnes Sep 12, 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
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
42 changes: 40 additions & 2 deletions .kiro/steering/documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
### Documentation Hierarchy

- **README.md**: Project overview and quick start
- **additionaldocs/**: Detailed guides organized by user journey
- **docs/**: Detailed guides organized by user journey
- `getting-started/`: Installation, first connection, basic usage
- `user-guide/`: Feature documentation for end users
- `deployment/`: Production deployment guides
Expand Down Expand Up @@ -62,7 +62,7 @@

```
README.md # Project overview and quick start
additionaldocs/
docs/
├── getting-started/
│ ├── installation.md # Local and Docker setup
│ ├── first-connection.md # Connecting to your first database
Expand Down Expand Up @@ -92,6 +92,44 @@ additionaldocs/
- Use descriptive names that match user tasks: `first-connection.md`
- Group related content in folders by user journey

### Folder README Files

Each documentation folder should include a `README.md` file that serves as a
table of contents for that folder:

- **Purpose**: Explain what the folder contains and who it's for
- **Summary**: Briefly describe the folder's purpose and content
- **File Listing**: List all files in the folder with brief descriptions
- **Reading Order**: Suggest the recommended order for reading files
- **Prerequisites**: Note any required knowledge or setup before starting
- **Navigation**: Link to parent folder and related sections

Example folder README structure:

```markdown
# Getting Started

This section helps new users install and configure Graph Explorer for the first
time.

## Files in this section

1. [Installation](installation.md) - Local and Docker setup options
2. [First Connection](first-connection.md) - Connect to your first database
3. [Basic Usage](basic-usage.md) - Essential features walkthrough

## Prerequisites

- Basic familiarity with graph databases
- Access to a graph database endpoint
- Docker or Node.js >=24.4.0 installed

## Next Steps

After completing this section, see the [User Guide](../user-guide/) for detailed
feature documentation.
```

## Formatting Standards

### Code Examples
Expand Down
2 changes: 1 addition & 1 deletion .kiro/steering/structure.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ graph-explorer/
│ ├── graph-explorer/ # React frontend application
│ ├── graph-explorer-proxy-server/ # Express.js backend server
│ └── shared/ # Shared types and utilities
├── additionaldocs/ # Documentation
├── docs/ # Documentation
├── samples/ # Example configurations
└── [root config files] # Workspace-level configuration
```
Expand Down
12 changes: 6 additions & 6 deletions Changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@ editor with Neptune Analytics for the first time.

As before, if you are a Neptune user concerned about data integrity, check out
the
[instructions on configuring IAM permissions to restrict mutations](./README.md#permissions),
[instructions on configuring IAM permissions to restrict mutations](./docs/user-guide/security.md#permissions),
ensuring that users can enforce read-only operations.

### New features & major changes
Expand All @@ -163,15 +163,15 @@ ensuring that users can enforce read-only operations.

Graph Explorer v2.0 marks a significant milestone with the introduction of the
new
[query editor for Gremlin connections](./additionaldocs/features/README.md#query-search).
[query editor for Gremlin connections](./docs/user-guide/graph-explorer.md#query-search).
This powerful feature allows users to enter any valid Gremlin query and
visualize the returned nodes, edges, and scalar values directly from the
database. You can review the results in the sidebar and choose to add all nodes
& edges to the graph or add results individually.

For Neptune users concerned about data integrity, [the README](./README.md) now
includes
[instructions on configuring IAM permissions to restrict mutations](./README.md#permissions),
[instructions on configuring IAM permissions to restrict mutations](./docs/user-guide/security.md#permissions),
ensuring users can enforce read-only operations.

The release also changes the default strategy for representing node & edge
Expand Down Expand Up @@ -662,11 +662,11 @@ a more pleasant experience, especially for users with larger databases.
- **Improved** diagnostic logging in Neptune Notebooks by adding CloudWatch logs
([#517](https://github.com/aws/graph-explorer/pull/517))
- Check out the example
[lifecycle script](additionaldocs/sagemaker/install-graph-explorer-lc.sh)
[lifecycle script](docs/deployment/aws-sagemaker/install-graph-explorer-lc.sh)
and IAM policies for
[Neptune](additionaldocs/sagemaker/graph-explorer-neptune-db-policy.json)
[Neptune](docs/deployment/aws-sagemaker/graph-explorer-neptune-db-policy.json)
and
[Neptune Analytics](additionaldocs/sagemaker/graph-explorer-neptune-analytics-policy.json)
[Neptune Analytics](docs/deployment/aws-sagemaker/graph-explorer-neptune-analytics-policy.json)

**Bug Fixes and Minor Changes**

Expand Down
Loading