iSharkFly-Docs
/
packer-cn
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

website: add comments to duo of plugin docs zip fns

This commit is contained in:
Zach Shilton 2021-03-20 21:45:40 -04:00
parent 15d467eaf1
commit 55012937a9
No known key found for this signature in database
GPG Key ID: 487BAB946192712E
2 changed files with 13 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
website/components/remote-plugin-docs/utils/parse-docs-zip.js
View File

@ -2,6 +2,12 @@ const path = require('path')
const AdmZip = require('adm-zip') const AdmZip = require('adm-zip')
const validatePluginDocsFiles = require('./validate-plugin-docs-files') const validatePluginDocsFiles = require('./validate-plugin-docs-files')
/*
NOTE: used for default `docs.zip` release assets
*/
// Given a response from fetching a docs.zip file, // Given a response from fetching a docs.zip file,
// which is a compressed "docs" folder, // which is a compressed "docs" folder,
// //

7
website/components/remote-plugin-docs/utils/parse-source-zip.js
View File

@ -2,6 +2,13 @@ const path = require('path')
const AdmZip = require('adm-zip') const AdmZip = require('adm-zip')
const validatePluginDocsFiles = require('./validate-plugin-docs-files') const validatePluginDocsFiles = require('./validate-plugin-docs-files')
/*
NOTE: used for fallback approach, where we parse from
the full release archive
*/
// Given a response from fetching a source .zip file, // Given a response from fetching a source .zip file,
// which contains a "docs" folder, // which contains a "docs" folder,
// //