-
Notifications
You must be signed in to change notification settings - Fork 662
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
redirect to new developer guide (#2948)
* replace all static index.html files with a redirect to new site * update README * remove everything else * remove workflow
- Loading branch information
Showing
254 changed files
with
1,537 additions
and
40,974 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,85 +1 @@ | ||
# AWS SDK for Go V2 Documentation | ||
|
||
This source tree contains the AWS SDK for Go V2 developer and migration guides. | ||
|
||
The documentation is generated using [Hugo](https://gohugo.io/), which is a | ||
static website generator. This project uses the [Docsy](https://www.docsy.dev/) | ||
Hugo theme for presentation and formatting of the docs content type. | ||
|
||
## Development | ||
|
||
### Getting Started | ||
|
||
1. [Install Hugo](https://gohugo.io/getting-started/installing) | ||
1. Verify Hugo | ||
```bash | ||
hugo version | ||
``` | ||
**Output**: | ||
``` | ||
hugo v0.91.2-1798BD3F+extended darwin/amd64 BuildDate=2021-12-23T15:33:34Z VendorInfo=gohugoio | ||
``` | ||
This project requires that the `extended` version of Hugo is installed. | ||
Follow the download instructions to ensure the correct version is present. | ||
1. Fork the SDK [repository](https://github.com/aws/aws-sdk-go-v2) | ||
1. Checkout the documentation branch replacing `USERNAME` with your GitHub username. | ||
```bash | ||
git clone --single-branch -b documentation [email protected]:USERNAME/aws-sdk-go-v2.git aws-sdk-go-v2-docs | ||
cd aws-sdk-go-v2-docs | ||
``` | ||
1. Install [NodeJS (LTS)](https://nodejs.org/en/) | ||
1. Initialize project submodules and dependencies | ||
```bash | ||
make setup | ||
``` | ||
|
||
### Previewing Changes | ||
|
||
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: | ||
|
||
```bash | ||
make 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. | ||
|
||
#### Preview without Hugo installed | ||
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. | ||
|
||
### Submitting PRs | ||
Pull requests should be submitted to the [SDK Repository][sdkrepo], 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. | ||
|
||
### Building Content for Release | ||
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. | ||
|
||
### References | ||
* [Hugo Documentation](https://gohugo.io/documentation/) | ||
* [Docsy Documentation](https://www.docsy.dev/docs/) | ||
|
||
[sdkrepo]: https://github.com/aws/aws-sdk-go-v2 | ||
The aws-sdk-go-v2 developer guide has [migrated](https://docs.aws.amazon.com/sdk-for-go/v2/developer-guide/welcome.html). |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.