Add extension sample list page by daidr · Pull Request #7029 · GoogleChrome/developer.chrome.com

daidr · 2023-08-10T02:21:18Z

Changes proposed in this pull request:

Add a new page listing all extension samples.

Test step

Run npm install
Run npm run build-external. If the GITHUB_APP_ID and GITHUB_APP_KEY environment variables are not set, you can try copying external/build/testdata/extension-samples.json directly to external/build/data/extension-samples.json.
Run npm run dev
The new page can be found here: http://localhost:8080/docs/extensions/samples/

chrome-devrel-infra · 2023-08-10T02:23:10Z

✅ Preview (app) for commit 073e642 available at https://pr-7029-app-dot-dcc-staging.uc.r.appspot.com/.

oliverdunk

Wow, this is almost ready! Left a few comments. Could you also add some steps to the description on how to test (I needed to copy files from the testdata folder to data) and also a screenshot of what this looks like?

oliverdunk · 2023-08-10T08:44:21Z

@@ -0,0 +1,172 @@
+{% extends "layouts/base.njk" %}


It looks like the Fugu showcase has the .njk files in site/en/fugu-showcase/index.njk. Should we do similar?

I have placed it in the layout because there is no specific language content in the njk template (localization-related content has been moved to the i18n file). Here it functions similarly to site/en/docs/extensions/index.md, which contains the English title and description.

@matthiasrohmer, any thoughts on this?

I can follow the train of thought, but following the fugu-showcase example here would be good. So, putting the contents of this file directly in site/en/docs/extensions/samples/index.md(and renaming it to njk`) - it's unlikely we'll have localized versions of this page (which is when the extraction would make sense) and it's more intuitive to do changes for new starters as they would find the code they expect inside the page rather than having to further search for the used template.

Done. 7a20eba

Co-authored-by: Oliver Dunk <oliver@oliverdunk.com>

jpmedley · 2023-08-10T16:53:21Z

Guys,

This looks great. I can't wait to see it up.

Where are the sample descriptions drawn from (specifically)? They're inconsistent and sometimes missing. If we can't fix that before this is deployed. We need to do it asap.

AmySteam · 2023-08-10T21:28:14Z

@jpmedley It comes from the manifest "description" key

oliverdunk · 2023-08-11T09:11:44Z

@sebastianbenz / @matthiasrohmer - I've done an initial review here and it's looking good to me! Would love your thoughts when you're able to :)

matthiasrohmer

Thanks for your work! Had a look, but didn't spot anything major.

As a heads-up: for this to be mergeable the test data needs to be manually put into the Cloud Storage bucket and then the checks need to kicked off. This ensures everything is in place for the build pipeline.

oliverdunk · 2023-08-16T10:55:55Z

@matthiasrohmer, could you take another look? Thanks!

matthiasrohmer

Looks good to me once the lint errors are fixed. 🙂

matthiasrohmer · 2023-08-16T15:59:17Z

+// The names of the samples matching the list will be hidden.
+const IGNORED_SAMPLES = [
+  'sample.co2meter', // WebHID is not released yet.
+];


I am not particularly a fan of this, as this would require a change in this repo once the sample is ready to be released and constructs like this are often hard to debug ("Why does xyz not show up?"), but just take this as a note, no need to change 🙂

That thought ocurred to me, but I wasn't going to say anything since I'm not an engineer. Also, how else would we get this information?

Maybe it's possible to add a metadata in the sample (e.g. a field in the extension-samples.json file) that tells this script whether this sample should be ignored or not. This way you edit "sample is hidden" field at the same time when you edit the sample instead of a separate repo.

matthiasrohmer · 2023-08-16T16:02:36Z

@@ -0,0 +1,172 @@
+{% extends "layouts/base.njk" %}


I can follow the train of thought, but following the fugu-showcase example here would be good. So, putting the contents of this file directly in site/en/docs/extensions/samples/index.md(and renaming it to njk`) - it's unlikely we'll have localized versions of this page (which is when the extraction would make sense) and it's more intuitive to do changes for new starters as they would find the code they expect inside the page rather than having to further search for the used template.

daidr · 2023-08-17T02:57:29Z

Looks good to me once the lint errors are fixed. 🙂

I am a little confused because according to the logs, there seems to be a lint error in a dependency within the node_modules. However, this should not happen under normal circumstances, and I have not made any changes to the relevant code.

EDIT: I think it might be because I used some code from the gulp-tasks directory in an external script. The JavaScript files in the gulp-tasks directory are not being checked for syntax, but the ones in the external directory are. However, this error is still quite puzzling to me, and I'm not sure if I can solve it.

matthiasrohmer · 2023-08-17T16:11:38Z

Thanks for all your work on this, @daidr! This is now live at https://developer.chrome.com/docs/extensions/samples/

daidr added 23 commits August 10, 2023 10:13

Add new sass file

101897e

Update toc

e0acbdb

Update rollup config

0556a8b

Add testdata for extension-samples

9911759

Add extension samples external data flow

235e864

Init extension samples external data builder

6ae5469

Add extension samples list i18n file

07d0742

Init extension samples list style

999919a

Add samples page layout

d5cf149

Update page layout

78b8e0a

Update layout

27f6540

Add permission filter

b81d8ed

Update layout

4b25c7f

Update filter

7d23598

Update code

1edb4d4

Add adm-zip

b681f91

Update package-lock.json

e5a40ea

Add external build script

e0f0464

Update style

ef1a747

Update i18n

9ed19b4

Add type definitions

44ea5bc

Add used api pills

4a0cbfc

Update style

682f0ab

oliverdunk self-requested a review August 10, 2023 08:32

oliverdunk self-assigned this Aug 10, 2023

oliverdunk added the extensions Issues related to extensions documentation. label Aug 10, 2023

oliverdunk suggested changes Aug 10, 2023

View reviewed changes

daidr and others added 2 commits August 10, 2023 17:29

Update site/_includes/partials/sample-item.njk

5430e91

Co-authored-by: Oliver Dunk <oliver@oliverdunk.com>

Sort artifacts by date

d2ed65d

daidr added 7 commits August 10, 2023 18:10

Remove read more button

547447c

Add newline

ec8a530

Update margins

0e939cc

Change function name

e9b0915

Update type definitions

6c5595d

Update hero card style

3b55a3b

Remove IIFE

d35808d

oliverdunk requested review from matthiasrohmer and sebastianbenz August 11, 2023 09:11

matthiasrohmer reviewed Aug 11, 2023

View reviewed changes

Comment thread package.json Outdated

Comment thread site/_includes/layouts/extension-samples.njk Outdated

Comment thread site/_includes/partials/sample-item.njk

Comment thread site/_includes/partials/sample-item.njk Outdated

Comment thread site/_js/extension-samples.js Outdated

daidr added 5 commits August 12, 2023 10:38

Update locale

4efd884

Remove unnecessary style tag

4492444

Pin deps versions

94b8497

Rename sample-item template

c9c630e

Remove nested loop

adeba5d

oliverdunk requested a review from matthiasrohmer August 16, 2023 10:55

Add IGNORED_SAMPLES to hide specified samples

4480490

matthiasrohmer reviewed Aug 16, 2023

View reviewed changes

Update file structure

7a20eba

matthiasrohmer mentioned this pull request Aug 17, 2023

Update TypeScript and typedoc and fix related errors #7102

Merged

Merge branch 'main' into daidr/samples-list

073e642

matthiasrohmer merged commit 81016fa into GoogleChrome:main Aug 17, 2023

matthiasrohmer mentioned this pull request Aug 17, 2023

Remove cloud-secrets util #7106

Open

Uh oh!

Conversation

daidr commented Aug 10, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Test step

Uh oh!

chrome-devrel-infra Bot commented Aug 10, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

oliverdunk left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

daidr Aug 10, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jpmedley commented Aug 10, 2023

Uh oh!

AmySteam commented Aug 10, 2023

Uh oh!

oliverdunk commented Aug 11, 2023

Uh oh!

matthiasrohmer left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

oliverdunk commented Aug 16, 2023

Uh oh!

matthiasrohmer left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

daidr commented Aug 17, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

matthiasrohmer commented Aug 17, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

daidr commented Aug 10, 2023 •

edited

Loading

chrome-devrel-infra Bot commented Aug 10, 2023 •

edited

Loading

daidr Aug 10, 2023 •

edited

Loading

daidr commented Aug 17, 2023 •

edited

Loading