Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added Auto-Generated API Reference #507

Merged
merged 1 commit into from
Nov 16, 2023
Merged

Added Auto-Generated API Reference #507

merged 1 commit into from
Nov 16, 2023

Conversation

xWink
Copy link
Member

@xWink xWink commented Nov 16, 2023

Changes

  • Added docs/api-reference.md
    • Contains API Spec for all CRDs
  • Changed docs/reference to docs/api-types to be more consistent with Gateway API directory format (and this naming makes more sense)
  • Updated mkdocs to use the new API reference
  • Added new api-reference target in Makefile to do the auto-generation
  • Added condition in Makefile to only export env vars when not using the help target
    • The export commands use aws CLI commands which add a substantial slowdown to their execution and cause make help to take a long time
    • Additionally, make help changing the env is a weird behaviour that people likely don't expect

Copy link
Contributor

@zijun726911 zijun726911 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

export CLUSTER_VPC_ID ?= $(shell aws eks describe-cluster --name $(CLUSTER_NAME) | jq -r ".cluster.resourcesVpcConfig.vpcId")
export AWS_ACCOUNT_ID ?= $(shell aws sts get-caller-identity --query Account --output text)
export REGION ?= $(shell aws configure get region)
endif
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems we can also put IMG, VERSION, ECRIMAGES in this if block

@xWink xWink merged commit de47ec1 into aws:main Nov 16, 2023
5 checks passed
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.

2 participants