Add extension sample list page #7029
Conversation
|
✅ Preview (app) for commit 073e642 available at https://pr-7029-app-dot-dcc-staging.uc.r.appspot.com/. |
| @@ -0,0 +1,172 @@ | |||
| {% extends "layouts/base.njk" %} | |||
There was a problem hiding this comment.
It looks like the Fugu showcase has the .njk files in site/en/fugu-showcase/index.njk. Should we do similar?
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
@matthiasrohmer, any thoughts on this?
There was a problem hiding this comment.
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.
Co-authored-by: Oliver Dunk <oliver@oliverdunk.com>
|
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. |
|
@jpmedley It comes from the manifest |
|
@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 :) |
There was a problem hiding this comment.
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.
|
@matthiasrohmer, could you take another look? Thanks! |
| // The names of the samples matching the list will be hidden. | ||
| const IGNORED_SAMPLES = [ | ||
| 'sample.co2meter', // WebHID is not released yet. | ||
| ]; |
There was a problem hiding this comment.
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 🙂
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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.
| @@ -0,0 +1,172 @@ | |||
| {% extends "layouts/base.njk" %} | |||
There was a problem hiding this comment.
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.
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. |
|
Thanks for all your work on this, @daidr! This is now live at https://developer.chrome.com/docs/extensions/samples/ |
Changes proposed in this pull request:
Test step
npm installnpm run build-external. If theGITHUB_APP_IDandGITHUB_APP_KEYenvironment variables are not set, you can try copyingexternal/build/testdata/extension-samples.jsondirectly toexternal/build/data/extension-samples.json.npm run dev