Skip to content
This repository has been archived by the owner on Sep 22, 2023. It is now read-only.

feat: add SDK sizes #958

Merged
merged 11 commits into from
Sep 19, 2023
Merged

feat: add SDK sizes #958

merged 11 commits into from
Sep 19, 2023

Conversation

Mercy811
Copy link
Contributor

@Mercy811 Mercy811 commented Sep 1, 2023

Amplitude Developer Docs PR

Description

Add info on how to check SDK sizes based on https://amplitude.atlassian.net/wiki/spaces/GOV/pages/1787166927/Amplitude+SDK+Non+Functional+Requirement

Example:
image

Deadline

When do these changes need to be live on the site?

Change type

  • Doc bug fix. Fixes #[insert issue number]. Amplitude contributors include Jira issue number.
  • Doc update.
  • New documentation.
  • Non-documentation related fix or update.

PR checklist:

  • My documentation follows the style guidelines of this project.
  • I previewed my documentation on a local server using mkdocs serve.
  • Running mkdocs serve didn't generate any failures.
  • I have performed a self-review of my own documentation.

@amplitude-dev-docs

@github-actions
Copy link

github-actions bot commented Sep 1, 2023

🦙 MegaLinter status: ✅ SUCCESS

Descriptor Linter Files Fixed Errors Elapsed time
✅ MARKDOWN markdownlint 17 0 0.66s

See detailed report in MegaLinter reports
Set VALIDATE_ALL_CODEBASE: true in mega-linter.yml to validate all sources, not only the diff

MegaLinter is graciously provided by OX Security

@aws-amplify-us-east-1
Copy link

This pull request is automatically being deployed by Amplify Hosting (learn more).

Access this pull request here: https://pr-958.d19s7xzcva2mw3.amplifyapp.com

Copy link
Collaborator

@justin-fiedler justin-fiedler left a comment

Choose a reason for hiding this comment

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

Thanks @Mercy811. This is really helpful. Can you please add Python too - https://pypi.org/project/amplitude-analytics/#files

includes/size/java.md Outdated Show resolved Hide resolved
includes/size/ios.md Outdated Show resolved Hide resolved
Copy link
Contributor

@markzegarelli markzegarelli left a comment

Choose a reason for hiding this comment

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

@Mercy811 It would be better if we could link directly to pages in bundlephobia or Maven. We can do this with the macros plugin that Justin added earlier this week.

includes/size/browser.md Outdated Show resolved Hide resolved
includes/size/ios.md Outdated Show resolved Hide resolved
@Mercy811
Copy link
Contributor Author

Mercy811 commented Sep 1, 2023

Hi @justin-fiedler, thanks for reminding me to add Python.

@Mercy811
Copy link
Contributor Author

Mercy811 commented Sep 1, 2023

Hi @markzegarelli, I was trying to use macros until I read that

At this macros are not supported in Snippets from includes files. If you can find a way to make this work, please submit a PR.

@markzegarelli
Copy link
Contributor

👍 Yeah, looking at it now, I think it would be overkill to add the macros directly the the article content for this. I'll add this use case to a list of pain points I'm compiling and revisit next week.

Hi @markzegarelli, I was trying to use macros until I read that

At this macros are not supported in Snippets from includes files. If you can find a way to make this work, please submit a PR.

@Mercy811
Copy link
Contributor Author

Mercy811 commented Sep 1, 2023

Sounds great. Thank you @markzegarelli for looking at this.

Copy link
Collaborator

@justin-fiedler justin-fiedler left a comment

Choose a reason for hiding this comment

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

Thanks @Mercy811. I think some direct links would be nice otherwise looks great.

docs/data/sdks/browser-2/index.md Outdated Show resolved Hide resolved
docs/data/sdks/android-kotlin/index.md Outdated Show resolved Hide resolved
@markzegarelli markzegarelli merged commit 165c7de into main Sep 19, 2023
3 of 4 checks passed
@markzegarelli markzegarelli deleted the AMP-83794-add-SDK-size branch September 19, 2023 18:09
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants