-
Notifications
You must be signed in to change notification settings - Fork 27
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'release-v5.0.2' into release
- Loading branch information
Showing
47 changed files
with
11,045 additions
and
1,970 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -97,9 +97,12 @@ jobs: | |
| - run: | ||
| name: Build library | ||
| command: npm --prefix ./glean run build | ||
| - run: | ||
| name: Install JavaScript documentation dependencies | ||
| command: npm --prefix ./documentation install | ||
| - run: | ||
| name: Build docs | ||
| command: npm --prefix ./glean run build:docs | ||
| command: npm --prefix ./documentation run build | ||
|
|
||
| browser-compat-smoke-tests: | ||
| docker: | ||
|
|
@@ -138,22 +141,22 @@ jobs: | |
| - "ea:d2:3c:e1:09:cf:1a:1d:85:d6:6e:1d:52:0a:58:41" | ||
| - run: | ||
| name: Install JavaScript dependencies | ||
| command: npm --prefix ./glean install | ||
| command: npm --prefix ./documentation install | ||
| - run: | ||
| name: Build documentation | ||
| command: npm --prefix ./glean run build:docs | ||
| command: npm --prefix ./documentation run build | ||
| - run: | ||
| name: Disable jekyll builds | ||
| command: touch glean/dist/docs/.nojekyll | ||
| command: touch documentation/dist/.nojekyll | ||
| - run: | ||
| name: Show contents | ||
| command: ls -R glean/dist/docs | ||
| command: ls -R documentation/dist | ||
| - run: | ||
| name: Setup SSH key and deploy docs to gh-pages branch | ||
| command: | | ||
| git config user.email "[email protected]" | ||
| git config user.name "dataops-ci-bot" | ||
| npm --prefix ./glean run publish:docs | ||
| npm --prefix ./documentation run publish:docs | ||
| publish: | ||
| docker: | ||
|
|
@@ -240,9 +243,10 @@ workflows: | |
| context: data-sre-gleanjs | ||
| filters: | ||
| branches: | ||
| ignore: /.*/ | ||
| tags: | ||
| only: /^v.*/ | ||
| only: | ||
| - main | ||
| - release | ||
| - /^release-.*/ | ||
| - publish: | ||
| context: data-sre-gleanjs | ||
| filters: | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -8,30 +8,26 @@ | |
|
|
||
| All documentation is available online: | ||
|
|
||
| ### [The Glean.js Docs](https://mozilla.github.io/glean.js/) | ||
|
|
||
| If you are using Glean.js in your project, this is the place to go. | ||
|
|
||
| ### [The Glean Book](https://mozilla.github.io/glean/) | ||
|
|
||
| If you are using Glean.js in your project, this is the place to go. | ||
| It contains user guides on getting started and other topics, as well as reference to Glean APIs. | ||
| The Glean Book contains general information on the Glean ecosystem and about the SDKs on other platforms, as well as reference to Glean APIs (which are common to all the platforms). | ||
|
|
||
| ### [Glean.js developer documentation](https://github.com/mozilla/glean.js/tree/main/docs) | ||
|
|
||
| If you want to contribute to the Glean.js code base this is the place to go. | ||
|
|
||
| ### [Glean.js internal reference](https://mozilla.github.io/glean.js/) | ||
|
|
||
| If you are looking for detailed documentation on the Glean APIs (internal or external) this is the place to go. | ||
|
|
||
| _This documentation is auto generated from the doc comments throughout the Glean.js code base and | ||
| the Glean book should be preferred over this documentation whenever possible._ | ||
|
|
||
| ## Contact | ||
|
|
||
| To contact us you can: | ||
|
|
||
| * Find us in the [#glean channel on chat.mozilla.org](https://chat.mozilla.org/#/room/#glean:mozilla.org). | ||
| * To report issues or request changes, file a bug in [Bugzilla in Data Platform & Tools :: Glean SDK](https://bugzilla.mozilla.org/enter_bug.cgi?assigned_to=nobody%40mozilla.org&bug_ignored=0&bug_severity=normal&bug_status=NEW&bug_type=defect&cf_fx_iteration=---&cf_fx_points=---&cf_status_firefox100=---&cf_status_firefox101=---&cf_status_firefox99=---&cf_status_firefox_esr91=---&cf_tracking_firefox100=---&cf_tracking_firefox101=---&cf_tracking_firefox99=---&cf_tracking_firefox_esr91=---&component=Glean%3A%20SDK&contenttypemethod=list&contenttypeselection=text%2Fplain&defined_groups=1&filed_via=standard_form&flag_type-4=X&flag_type-607=X&flag_type-721=X&flag_type-737=X&flag_type-799=X&flag_type-800=X&flag_type-803=X&flag_type-936=X&flag_type-947=X&form_name=enter_bug&maketemplate=Remember%20values%20as%20bookmarkable%20template&op_sys=Unspecified&priority=P3&product=Data%20Platform%20and%20Tools&rep_platform=Unspecified&status_whiteboard=%5Bglean-sdk%3Am%3F%5D%5Bglean-js%5D&target_milestone=---&version=unspecified). | ||
| * Send an email to *[email protected]*. | ||
| * The Glean SDKs team is: *:dexter*, *:janerik*, *:travis_*, *:chutten*. | ||
| * The Glean SDKs team is: *:dexter*, *:janerik*, *:travis_*, *:chutten*, *:brosa*. | ||
|
|
||
| ## Credits | ||
|
|
||
|
|
||
Oops, something went wrong.