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

redirect to new developer guide #2948

Merged
merged 4 commits into from
Jan 7, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 0 additions & 14 deletions .github/workflows/validate-documentation-generation.yml

This file was deleted.

41 changes: 0 additions & 41 deletions Dockerfile

This file was deleted.

46 changes: 0 additions & 46 deletions Makefile

This file was deleted.

86 changes: 1 addition & 85 deletions README.md
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).
6 changes: 0 additions & 6 deletions archetypes/default.md

This file was deleted.

38 changes: 0 additions & 38 deletions assets/icons/logo.svg

This file was deleted.

13 changes: 0 additions & 13 deletions assets/scss/_variables_project.scss

This file was deleted.

14 changes: 0 additions & 14 deletions builddocs.sh

This file was deleted.

Loading