Skip to content

README Link to documentation #160

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.

Sign up for GitHub

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

Jump to bottom
Closed
ghostsquad opened this issue Aug 10, 2020 · 1 comment
Closed

README Link to documentation #160

ghostsquad opened this issue Aug 10, 2020 · 1 comment
Labels
area/documentation Issues or PRs related to documentation and examples

Comments

@ghostsquad
Copy link

Describe the bug
The readme says:

Documentation, including installation and usage instructions, are available online.

But there's no link to where these are "online".
@ghostsquad ghostsquad added the kind/bug Categorizes issue or PR as related to a bug. label Aug 10, 2020
@mhausenblas mhausenblas added area/documentation Issues or PRs related to documentation and examples and removed kind/bug Categorizes issue or PR as related to a bug. labels Aug 10, 2020
@mhausenblas
Copy link
Contributor

It's linked from the repo, directly: https://aws.github.io/aws-controllers-k8s/

But fair point, we should also make it part of the top-level README.

Note, however, that we're not yet in a position where e2e install works, we're still in the MVP phase (see #22).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
area/documentation Issues or PRs related to documentation and examples
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@mhausenblas @ghostsquad