Skip to content

docs: minor improvements #1021

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

Merged
merged 2 commits into from
Jul 19, 2022
Merged

docs: minor improvements #1021

merged 2 commits into from
Jul 19, 2022

Conversation

saragerion
Copy link
Contributor

@saragerion saragerion commented Jul 18, 2022

Description of your changes

Changes introduced:

  • Clarification that people can use the library in both TypeScript and JavaScript code bases
  • References to Serverless TypeScript Demo
  • One-liner command to install all three utilities at once
  • Contribute CTA
  • Driving our roadmap CTA
  • Consistency with messaging of blog post (utilities key features etc)
  • Changed font size and remove ToC on the right side to improve readability in smaller screens

How to verify this change

Docs: npm run docs-runLocalDocker

Related issues, RFCs

N/A

PR status

Is this ready for review?: YES
Is it a breaking change?: NO

Checklist

  • My changes meet the tenets criteria
  • I have performed a self-review of my own code
  • I have commented my code where necessary, particularly in areas that should be flagged with a TODO, or hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have made corresponding changes to the examples
  • My changes generate no new warnings
  • The code coverage hasn't decreased
  • I have added tests that prove my change is effective and works
  • New and existing unit tests pass locally and in Github Actions
  • Any dependent changes have been merged and published in downstream module
  • The PR title follows the conventional commit semantics

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Jul 18, 2022
@github-actions
Copy link
Contributor

github-actions bot commented Jul 18, 2022

📊 Package size report   2%↑

File Before After
aws-lambda-powertools-logger-1.0.1.tgz 23.8 kB 2%↑24.3 kB
aws-lambda-powertools-metrics-1.0.1.tgz 17.3 kB 2%↑17.7 kB
aws-lambda-powertools-tracer-1.0.1.tgz 21.2 kB 2%↑21.6 kB
logger-bundle.zip 24.4 kB 2%↑24.8 kB
metrics-bundle.zip 17.7 kB 3%↑18.2 kB
tracer-bundle.zip 21.7 kB 2%↑22.1 kB
Total (Includes all files) 139.3 kB 2%↑141.8 kB
Tarball size 138.1 kB 2%↑140.7 kB
Unchanged files
File Size
aws-lambda-powertools-commons-1.0.1.tgz 6.3 kB
commons-bundle.zip 6.8 kB

🤖 This report was automatically generated by pkg-size-action
(options hash: 1d64a5ce3f3c0b9f2f620e4061d08910)

@saragerion saragerion changed the title docs: consistency with blog post messaging, added one-line installati… docs: minor improvements Jul 18, 2022
@saragerion saragerion marked this pull request as ready for review July 18, 2022 14:20
@saragerion saragerion self-assigned this Jul 18, 2022
Copy link
Contributor

@dreamorosi dreamorosi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Leaving this so others can see how the new layout looks (it looks great).

image

There's a missing URL for Middy in the main Docs page, looking forward to approve once that's fixed (others are only suggestions/comments which you can decide upon).

@@ -67,7 +67,6 @@ You can instrument your code with Powertools in three different ways:
| **POWERTOOLS_TRACER_CAPTURE_HTTPS_REQUESTS** | Captures HTTP(s) requests as segments. | [Tracer](./core/tracer) | `true` |
| **POWERTOOLS_LOGGER_LOG_EVENT** | Logs incoming event | [Logger](./core/logger) | `false` |
| **POWERTOOLS_LOGGER_SAMPLE_RATE** | Debug log sampling | [Logger](./core/logger) | `0` |
| **POWERTOOLS_LOGGER_LOG_EVENT** | Logs incoming events | [Logger](./core/logger) | `false` |
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Redundant

@saragerion saragerion requested a review from dreamorosi July 19, 2022 06:48
Copy link
Contributor

@dreamorosi dreamorosi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@github-actions
Copy link
Contributor

github-actions bot commented Jul 19, 2022

📊 Package size report   2%↑

File Before After
aws-lambda-powertools-logger-1.0.1.tgz 23.8 kB 2%↑24.3 kB
aws-lambda-powertools-metrics-1.0.1.tgz 17.3 kB 3%↑17.7 kB
aws-lambda-powertools-tracer-1.0.1.tgz 21.2 kB 2%↑21.6 kB
logger-bundle.zip 24.4 kB 2%↑24.8 kB
metrics-bundle.zip 17.7 kB 3%↑18.2 kB
tracer-bundle.zip 21.7 kB 2%↑22.2 kB
Total (Includes all files) 139.3 kB 2%↑142.0 kB
Tarball size 138.1 kB 2%↑140.9 kB
Unchanged files
File Size
aws-lambda-powertools-commons-1.0.1.tgz 6.3 kB
commons-bundle.zip 6.8 kB

🤖 This report was automatically generated by pkg-size-action
(options hash: d786e0d4c2096842d4243d1f036fb0e6)

Copy link
Contributor

@ijemmy ijemmy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not part of this PR. But should we consider having a dedicated README for each utility?

Copying the same README to every packages makes me feel uncomfortable. I'd prefer to simply put a link the official doc for the package so that we have only a single source of documents. The README at this level should be specific to contribution/development.

@saragerion
Copy link
Contributor Author

@ijemmy completely agree and thanks for bringing this up.

@saragerion saragerion merged commit 58bfcdf into main Jul 19, 2022
@saragerion saragerion deleted the docs/minor-improvements branch July 19, 2022 08:02
@saragerion saragerion mentioned this pull request Jul 19, 2022
11 tasks
dreamorosi pushed a commit that referenced this pull request Aug 2, 2022
* docs: consistency with blog post messaging, added one-line installation command, reduce font size

* docs: add middy link, add ToC items for CTAs
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
None yet
Development

Successfully merging this pull request may close these issues.

3 participants