Elgato_dark/fleet
1
0
Fork 0
mirror of https://github.com/fleetdm/fleet synced 2026-05-20 23:48:52 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 109
fleet/website/api/controllers/view-query-library.js

31 lines
544 B
JavaScript
Raw Normal View History

Absorb yaml queries into website, + stub /queries + /documentation (#812) * Upgrade to get rid of REPL schmutz * rename workflow to lessen ambiguity vs. markdown compilation of docs * ensure lockfile makes it to fleetdm.com prod * skip force git add of package-lock to avoid confusion for now. (reverts 4e7e23990c472e84f3f24391ef360a175f725609) * rename build script (because now it won't always be markdown source files) * update metadata to match prev commit * change key name in generated sailsrc for consistency * stub query library page * used named params so others can tell what's up with the forcing * expand comments * expand comments * intermediate commit- playing with inlining the guts from doctemplater * stub basic docpage shell and a little page to preview that on * Compile YAML and set up query library page * clean sailsrc * optimize build by running everything in parallel * Add note about the fact that we don't even need to clone anything since we've consolidated it all into one repo now. facepalm * un-parallelize one bit that fails in CI if it's parallelized (it'll go away soon anyway)
2021-05-20 08:22:42 +00:00
module.exports = {
friendlyName: 'View query library',
description: 'Display "Query library" page.',
exits: {
Obviate doc-templater dependency + dynamic sitemap.xml (#827) * trivial * Simplify build-static-content script and rip out the old markdown compilation for query library * improve error msg * trivial * move helper * bring in the skeleton * Compile handbook as well, and bring more stuff inline * instead of generating sitemap.xml file, could just serve it as a route * Serve sitemap.xml on the fly * add failsafe to prevent search engine accidents * add remaining hand-coded pages to sitemap * rearrange routes and get rid of commented-out ones * Update build-static-content.js * stub out the remaining pieces * Add assertion (Which actually helped catch a real duplicate query: get-mac-os-disk-free-space-percentage) * clean out inadvertently committed stuff in sailsrc * route and serve data for correct query by slug + fix error message re duplicate query slugs + added assertion for duplicate doc page slugs * yaml == dev dependency * remove doc-templater dependency, as promised * stub out handbook page * clarify comments & remove unnecessary skipAssets * Update build-static-content.js * res.badConfig() * add missing exit that I left out back in https://github.com/fleetdm/fleet/commit/ec95df6a4b8b0344fcbdb71f892d1185ec094f6e * remove unused file * update comments before commenting out and moving over to basic-documentation.less * move example styling of generated HTML over to docs/handbook * include both links * Fix sitemap.xml URLs in local dev by fixing baseUrl config for local development (since Fleet itself is on 1337). * followup to https://github.com/fleetdm/fleet/commit/d55c777590f4b1dac4b7500cce1bf8f70b652fd9 * Include query pages in sitemap.xml (+make urls generated for docs/handbook in build script slightly more real) -- but also don't serve sitemap * sails.config.builtStaticContent.allPages » sails.config.buildStaticContent.markdownPages (also remove unnecessary trailing slash trimming) * trivial * check config when serving sitemap + smarter error message for contributors * hook up GitHub link to edit the query * remove html ids * Update query-detail.ejs * somre more setup re https://github.com/fleetdm/fleet/issues/368#issuecomment-848566533
2021-05-26 08:24:38 +00:00
success: { viewTemplatePath: 'pages/query-library' },
badConfig: { responseType: 'badConfig' },
Absorb yaml queries into website, + stub /queries + /documentation (#812) * Upgrade to get rid of REPL schmutz * rename workflow to lessen ambiguity vs. markdown compilation of docs * ensure lockfile makes it to fleetdm.com prod * skip force git add of package-lock to avoid confusion for now. (reverts 4e7e23990c472e84f3f24391ef360a175f725609) * rename build script (because now it won't always be markdown source files) * update metadata to match prev commit * change key name in generated sailsrc for consistency * stub query library page * used named params so others can tell what's up with the forcing * expand comments * expand comments * intermediate commit- playing with inlining the guts from doctemplater * stub basic docpage shell and a little page to preview that on * Compile YAML and set up query library page * clean sailsrc * optimize build by running everything in parallel * Add note about the fact that we don't even need to clone anything since we've consolidated it all into one repo now. facepalm * un-parallelize one bit that fails in CI if it's parallelized (it'll go away soon anyway)
2021-05-20 08:22:42 +00:00
},
fn: async function () {
Obviate doc-templater dependency + dynamic sitemap.xml (#827) * trivial * Simplify build-static-content script and rip out the old markdown compilation for query library * improve error msg * trivial * move helper * bring in the skeleton * Compile handbook as well, and bring more stuff inline * instead of generating sitemap.xml file, could just serve it as a route * Serve sitemap.xml on the fly * add failsafe to prevent search engine accidents * add remaining hand-coded pages to sitemap * rearrange routes and get rid of commented-out ones * Update build-static-content.js * stub out the remaining pieces * Add assertion (Which actually helped catch a real duplicate query: get-mac-os-disk-free-space-percentage) * clean out inadvertently committed stuff in sailsrc * route and serve data for correct query by slug + fix error message re duplicate query slugs + added assertion for duplicate doc page slugs * yaml == dev dependency * remove doc-templater dependency, as promised * stub out handbook page * clarify comments & remove unnecessary skipAssets * Update build-static-content.js * res.badConfig() * add missing exit that I left out back in https://github.com/fleetdm/fleet/commit/ec95df6a4b8b0344fcbdb71f892d1185ec094f6e * remove unused file * update comments before commenting out and moving over to basic-documentation.less * move example styling of generated HTML over to docs/handbook * include both links * Fix sitemap.xml URLs in local dev by fixing baseUrl config for local development (since Fleet itself is on 1337). * followup to https://github.com/fleetdm/fleet/commit/d55c777590f4b1dac4b7500cce1bf8f70b652fd9 * Include query pages in sitemap.xml (+make urls generated for docs/handbook in build script slightly more real) -- but also don't serve sitemap * sails.config.builtStaticContent.allPages » sails.config.buildStaticContent.markdownPages (also remove unnecessary trailing slash trimming) * trivial * check config when serving sitemap + smarter error message for contributors * hook up GitHub link to edit the query * remove html ids * Update query-detail.ejs * somre more setup re https://github.com/fleetdm/fleet/issues/368#issuecomment-848566533
2021-05-26 08:24:38 +00:00
if (!_.isObject(sails.config.builtStaticContent) || !_.isArray(sails.config.builtStaticContent.queries)) {
throw {badConfig: 'builtStaticContent.queries'};
Absorb yaml queries into website, + stub /queries + /documentation (#812) * Upgrade to get rid of REPL schmutz * rename workflow to lessen ambiguity vs. markdown compilation of docs * ensure lockfile makes it to fleetdm.com prod * skip force git add of package-lock to avoid confusion for now. (reverts 4e7e23990c472e84f3f24391ef360a175f725609) * rename build script (because now it won't always be markdown source files) * update metadata to match prev commit * change key name in generated sailsrc for consistency * stub query library page * used named params so others can tell what's up with the forcing * expand comments * expand comments * intermediate commit- playing with inlining the guts from doctemplater * stub basic docpage shell and a little page to preview that on * Compile YAML and set up query library page * clean sailsrc * optimize build by running everything in parallel * Add note about the fact that we don't even need to clone anything since we've consolidated it all into one repo now. facepalm * un-parallelize one bit that fails in CI if it's parallelized (it'll go away soon anyway)
2021-05-20 08:22:42 +00:00
}
// Respond with view.
return {
queries: sails.config.builtStaticContent.queries
};
}
};
Reference in a new issue Copy permalink