Skip to content

Docs: only one non-obvious link to github on a page, and it is broken #220

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

Closed
huonw opened this issue Nov 26, 2020 · 4 comments · Fixed by #222
Closed

Docs: only one non-obvious link to github on a page, and it is broken #220

huonw opened this issue Nov 26, 2020 · 4 comments · Fixed by #222
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@huonw
Copy link
Contributor

huonw commented Nov 26, 2020

What were you initially searching for in the docs?

A link to the repository in order to look at the source code for the aws_lambda_powertools.utilities.typing.LambdaContext class.

Is this related to an existing part of the documentation? Please share a link

I started on a subpage https://awslabs.github.io/aws-lambda-powertools-python/utilities/typing/ and then moved to the homepage https://awslabs.github.io/aws-lambda-powertools-python/ .

Describe how we could make it clearer

I think there's two issues here:

  1. the "Edit on Github" link (that is nominally for editing the documentation) in the sidebar is broken. For instance, neither of the pages linked work:
  2. there's no obvious "here's the repository" link on either of those pages (or any others)

If you have a proposed update, please share it here

  1. fix the links, which might require wrangling gatsby to use develop/docs instead of HEAD
  2. many projects have a link to their repository as part of the docs template, and so visible on every page; for instance, one or more of:
@huonw huonw added the documentation Improvements or additions to documentation label Nov 26, 2020
@heitorlessa heitorlessa self-assigned this Nov 26, 2020
@heitorlessa
Copy link
Contributor

Hi @huonw - Thank you for flagging this. This is not the experience we want customers to have.

We'll get this fixed by EOW and ping you here.

@heitorlessa heitorlessa reopened this Nov 26, 2020
@heitorlessa heitorlessa added the pending-release Fix or implementation already in dev waiting to be released label Nov 26, 2020
@heitorlessa
Copy link
Contributor

Hi @huonw Addressed both feedbacks and we'll publish a new docs version today - Here's how the new link to the source code looks like

image

@heitorlessa
Copy link
Contributor

This is now available in the docs - Thanks a lot for the feedback @huonw to help us improve it

@heitorlessa heitorlessa removed the pending-release Fix or implementation already in dev waiting to be released label Nov 27, 2020
@huonw
Copy link
Contributor Author

huonw commented Nov 29, 2020

Looks great!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Development

Successfully merging a pull request may close this issue.

2 participants