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

Host Javascript API docs (close #1255) #1256

Merged
merged 36 commits into from
Nov 28, 2023

Conversation

Jack-Keene
Copy link
Contributor

@Jack-Keene Jack-Keene commented Oct 20, 2023

This PR adds hosted api docs to gh-pages for the browser and node trackers. The homepage can be found here:

https://snowplow.github.io/snowplow-javascript-tracker/docs/

@snowplowcla snowplowcla added the cla:yes [Auto generated] Snowplow Contributor License Agreement has been signed. label Oct 20, 2023
@bundlemon
Copy link

bundlemon bot commented Oct 20, 2023

BundleMon

Files added (6)
Status Path Size Limits
libraries/browser-tracker-core/dist/index.mod
ule.js
+25.6KB 26KB / +10%
trackers/javascript-tracker/dist/sp.js
+24.73KB 25KB / +10%
trackers/javascript-tracker/dist/sp.lite.js
+15.04KB 15.5KB / +10%
trackers/browser-tracker/dist/index.umd.min.j
s
+14.91KB 15KB / +10%
libraries/tracker-core/dist/index.module.js
+13.36KB 15KB / +10%
trackers/browser-tracker/dist/index.module.js
+3.51KB 5KB / +10%

Total files change +97.15KB 0%

Final result: ✅

View report in BundleMon website ➡️


Current branch size history

Comment on lines 4 to 6
push:
branches:
- issue/1255-host_js_docs
Copy link
Contributor Author

@Jack-Keene Jack-Keene Nov 27, 2023

Choose a reason for hiding this comment

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

This will get changed to something like:

on:
  workflow_run:
    workflows: ["Deploy Tracker"]
    types:
      - completed

to update once docs are generated in publish.yml

@Jack-Keene Jack-Keene changed the title Test deploy to gh pages Host Javascript API docs (close #1255) Nov 27, 2023
@Jack-Keene Jack-Keene marked this pull request as ready for review November 27, 2023 13:32
@rlh1994
Copy link

rlh1994 commented Nov 27, 2023

Can you add a search at all? Feels hard to find anything atm

@Jack-Keene
Copy link
Contributor Author

@rlh1994 I'll need to apply for an API key from algolia, but yeah assuming we get approved it shouldn't be an issue

@matus-tomlein matus-tomlein self-requested a review November 27, 2023 14:11
Copy link
Contributor

@matus-tomlein matus-tomlein left a comment

Choose a reason for hiding this comment

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

Looks great, nice work!

api-docs/docusaurus.config.js Outdated Show resolved Hide resolved
api-docs/docs/index.md Show resolved Hide resolved
.github/workflows/docs.yml Outdated Show resolved Hide resolved
api-docs/README.md Outdated Show resolved Hide resolved
.github/workflows/docs.yml Outdated Show resolved Hide resolved
@Jack-Keene Jack-Keene changed the base branch from release/3.17.0 to release/3.18.0 November 27, 2023 17:11
Copy link
Contributor

@matus-tomlein matus-tomlein left a comment

Choose a reason for hiding this comment

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

LGTM! You might need to rebase on top of the release branch and resolve the remaining conflicts.

@Jack-Keene Jack-Keene force-pushed the issue/1255-host_js_docs branch from 14bc54d to 38c7bfa Compare November 28, 2023 10:55
@Jack-Keene Jack-Keene merged commit b814e59 into release/3.18.0 Nov 28, 2023
2 checks passed
@Jack-Keene Jack-Keene deleted the issue/1255-host_js_docs branch November 28, 2023 12:04
@greg-el greg-el mentioned this pull request Dec 4, 2023
greg-el pushed a commit that referenced this pull request Dec 4, 2023
PR #1256
* Add docs workflow
* Remove old docs folder
* Update publish workflow
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cla:yes [Auto generated] Snowplow Contributor License Agreement has been signed.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants