Skip to content

Create consolidated configuration reference#1724

Merged
kmcginnes merged 2 commits intoaws:mainfrom
kmcginnes:consolidate-configuration-reference
Apr 24, 2026
Merged

Create consolidated configuration reference#1724
kmcginnes merged 2 commits intoaws:mainfrom
kmcginnes:consolidate-configuration-reference

Conversation

@kmcginnes
Copy link
Copy Markdown
Collaborator

Description

Consolidate all environment variable documentation into a single reference page at docs/references/configuration.md with two clear sections:

  • Application Configuration — server behavior: host, port, HTTPS settings, certificate paths, logging, proxy settings, CORS
  • Default Connection — pre-configuring a database connection: graph type, connection URL, AWS region, service type, IAM auth, and the JSON file approach

Changes:

  • Created docs/references/configuration.md combining env vars from development.md and all content from default-connection.md
  • Replaced the env var definitions in docs/development.md with a link to the new reference (dev-only variables like GRAPH_EXP_DEV_PORT remain in development.md)
  • Removed docs/references/default-connection.md (absorbed into the new page)
  • Added the new page to docs/references/README.md
  • Updated links in security.md, troubleshooting.md, and deploy-to-ecs-fargate.md

Validation

Documentation-only change. Verify that all links resolve correctly and the new reference page renders properly.

Related Issues

Check List

  • I confirm that my contribution is made under the terms of the Apache 2.0 license.
  • I have verified pnpm checks passes with no errors.
  • I have verified pnpm test passes with no failures.
  • I have covered new added functionality with unit tests if necessary.
  • I have updated documentation if necessary.

@kmcginnes kmcginnes marked this pull request as ready for review April 24, 2026 22:08
@kmcginnes kmcginnes merged commit f928f76 into aws:main Apr 24, 2026
3 checks passed
@kmcginnes kmcginnes deleted the consolidate-configuration-reference branch April 24, 2026 22:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Create a consolidated configuration reference

1 participant