This source tree contains the AWS SDK for Go V2 developer and migration guides.
The documentation is generated using Hugo, which is a static website generator. This project uses the Docsy Hugo theme for presentation and formatting of the docs content type.
-
Verify Hugo
hugo version
Output:
hugo v0.91.2-1798BD3F+extended darwin/amd64 BuildDate=2021-12-23T15:33:34Z VendorInfo=gohugoioThis project requires that the
extendedversion of Hugo is installed. Follow the download instructions to ensure the correct version is present. -
Fork the SDK repository
-
Checkout the documentation branch replacing
USERNAMEwith your GitHub username.git clone --single-branch -b documentation git@github.com:USERNAME/aws-sdk-go-v2.git aws-sdk-go-v2-docs cd aws-sdk-go-v2-docs -
Install NodeJS (LTS)
-
Initialize project submodules and dependencies
make setup
Hugo comes with a built-in development server that allows you to iterate and preview your documentation changes in realtime. This can be done by using the following Hugo command:
make previewThe Hugo test server will print the endpoint to the terminal after it has
started, (e.g. http://localhost:1313). Use ctrl+c to terminate the preview
server.
The content of the docs can be previewed without installing Hugo or NodeJS, but Docker is required instead. The following command will run the Hugo preview server in a sandboxed container, with the preview endpoint expose locally.
make container-preview
The Hugo test server will print the endpoint to the terminal after it has
started, (e.g. http://localhost:1313). Use ctrl+c to terminate the preview
server, and container.
Pull requests should be submitted to the SDK Repository, to help
speed up the process and reduce the time to merge please ensure that Allow edits and access to secrets by maintainers is checked before submitting your
PR. This will allow the project maintainers to make minor adjustments or
improvements to the submitted PR, allow us to reduce the roundtrip time for
merging your request.
To generate the documentation content in preparation for releasing the updates, the following command should be run.
make generate
This command will update the static version of the documentation into the
docs/ folder.