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 Static Site Generator v0.78.0-FD62817B/extended darwin/amd64 BuildDate: 2020-11-03T13:20:38ZThis 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 -
Initialize Project Submodules
git submodule update --init --recursive themes/docsy
-
Install NodeJS (LTS)
-
Install Project Dependencies
npm install
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:
hugo serverPull 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.
hugo -d docs
This command will update the static version of the documentation into the docs/ folder.