mirror of
https://github.com/fleetdm/fleet
synced 2026-05-22 16:39:01 +00:00
048fcd13ed
Related to: https://github.com/fleetdm/confidential/issues/10737 Changes: - Added `docs/scripts.yml`, a YAML file that contains a list of scripts - Added `docs/mdm-commands.yml`, a YAML file that contains Windows and Apple MDM commands - Added `/mdm-commands`, a page that contains a list of MDM commands for Windows and Apple commands - Added `/scripts`, a page that contains a list of scripts - Updated the `<docs-nav-and-search>` component to have a link to the controls library, and reordered the lists. - Updated the build static content script to add the scripts and mdm commands from scripts.yml and mdm-commands.yml to the website's `builtStaticContent` configuration. - Updated the layout of the os-settings page to match the latest wireframes
134 lines
9.5 KiB
JavaScript
Vendored
134 lines
9.5 KiB
JavaScript
Vendored
module.exports = {
|
||
|
||
|
||
friendlyName: 'Download sitemap',
|
||
|
||
|
||
description: 'Download sitemap file (returning a stream).',
|
||
|
||
|
||
extendedDescription: `Notes:
|
||
• Sitemap building inspired by https://github.com/sailshq/sailsjs.com/blob/b53c6e6a90c9afdf89e5cae00b9c9dd3f391b0e7/api/controllers/documentation/refresh.js#L112-L180 and https://github.com/sailshq/sailsjs.com/blob/b53c6e6a90c9afdf89e5cae00b9c9dd3f391b0e7/api/helpers/get-pages-for-sitemap.js
|
||
• Why escape XML? See http://stackoverflow.com/questions/3431280/validation-problem-entityref-expecting-what-should-i-do and https://github.com/sailshq/sailsjs.com/blob/b53c6e6a90c9afdf89e5cae00b9c9dd3f391b0e7/api/controllers/documentation/refresh.js#L161-L172
|
||
`,
|
||
|
||
|
||
exits: {
|
||
success: { outputFriendlyName: 'Sitemap (XML)', outputType: 'string' },
|
||
badConfig: { responseType: 'badConfig' },
|
||
},
|
||
|
||
|
||
fn: async function ({}) {
|
||
|
||
if (sails.config.environment === 'staging') {
|
||
// This explicit check for staging allows for the sitemap to still be developed/tested locally,
|
||
// and for the real thing to be served in production, while explicitly preventing the "whoops,
|
||
// i deployed staging and search engine crawlers got fixated on the wrong sitemap" dilemma.
|
||
throw new Error('Since this is the staging environment, prevented sitemap.xml from being served to avoid search engine accidents.');
|
||
}
|
||
|
||
if (!_.isObject(sails.config.builtStaticContent)) {
|
||
throw {badConfig: 'builtStaticContent'};
|
||
} else if (!_.isArray(sails.config.builtStaticContent.queries)) {
|
||
throw {badConfig: 'builtStaticContent.queries'};
|
||
} else if (!_.isArray(sails.config.builtStaticContent.markdownPages)) {
|
||
throw {badConfig: 'builtStaticContent.markdownPages'};
|
||
} else if (!_.isArray(sails.config.builtStaticContent.policies)) {
|
||
throw {badConfig: 'builtStaticContent.policies'};
|
||
} else if (!_.isArray(sails.config.builtStaticContent.appLibrary)) {
|
||
throw {badConfig: 'builtStaticContent.appLibrary'};
|
||
}
|
||
|
||
// Start with sitemap.xml preamble + the root relative URLs of other webpages that aren't being generated from markdown
|
||
let sitemapXml = '<?xml version="1.0" encoding="UTF-8"?><urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">';
|
||
// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
|
||
// ╦ ╦╔═╗╔╗╔╔╦╗ ╔═╗╔═╗╔╦╗╔═╗╔╦╗ ╔═╗╔═╗╔═╗╔═╗╔═╗
|
||
// ╠═╣╠═╣║║║ ║║───║ ║ ║ ║║║╣ ║║ ╠═╝╠═╣║ ╦║╣ ╚═╗
|
||
// ╩ ╩╩ ╩╝╚╝═╩╝ ╚═╝╚═╝═╩╝╚═╝═╩╝ ╩ ╩ ╩╚═╝╚═╝╚═╝
|
||
let HAND_CODED_HTML_PAGES = [
|
||
'/',//« home page
|
||
'/pricing',
|
||
'/contact',
|
||
'/support',
|
||
'/integrations',
|
||
'/logos',// « brand usage guidelines
|
||
'/articles',// « overview page (individual article pages are dynamic)
|
||
'/releases',// « article category page
|
||
'/success-stories',// « article category page
|
||
'/securing',// « article category page
|
||
'/engineering',// « article category page
|
||
'/guides',// « article category page
|
||
'/announcements',// « article category page
|
||
'/deploy',// « article category page
|
||
'/podcasts',// « article category page
|
||
// Product category pages:
|
||
'/orchestration',
|
||
'/device-management',
|
||
'/software-management',
|
||
'/meetups',
|
||
// Other stuff:
|
||
// > Note: /handbook overview page is already included amongst the markdown pages
|
||
// > Note: Same for /docs
|
||
'/transparency',// « default transparency link, pointed at by Fleet Desktop
|
||
'/queries',// « overview page (all subpages are dynamic)
|
||
'/policies',// « overview page (all subpages are dynamic)
|
||
'/tables',// « overview page (all subpages are dynamic)
|
||
'/software-catalog',// « overview page (all subpages are dynamic)
|
||
'/reports/state-of-device-management',// « 2021 research
|
||
'/mdm-commands',// « overview page (all subpages are dynamic)
|
||
'/scripts',// « overview page (all subpages are dynamic)
|
||
'/os-settings',
|
||
// FUTURE: Do something smarter to get hand-coded HTML pages from routes.js, like how rebuild-cloud-sdk works, to avoid this manual duplication.
|
||
// See also https://github.com/sailshq/sailsjs.com/blob/b53c6e6a90c9afdf89e5cae00b9c9dd3f391b0e7/api/helpers/get-pages-for-sitemap.js#L27
|
||
];
|
||
for (let url of HAND_CODED_HTML_PAGES) {
|
||
let trimmedRootRelativeUrl = _.trimRight(url,'/');// « really only necessary for home page; run on everything as a failsafe against accidental dupes due to trailing slashes in the list above
|
||
sitemapXml += `<url><loc>${_.escape(sails.config.custom.baseUrl+trimmedRootRelativeUrl)}</loc></url>`;
|
||
}//∞
|
||
// ╔╦╗╦ ╦╔╗╔╔═╗╔╦╗╦╔═╗ ╔═╗╔═╗╦═╗ ╔═╗ ╦ ╦╔═╗╦═╗╦ ╦ ╔═╗╔═╗╔═╗╔═╗╔═╗
|
||
// ║║╚╦╝║║║╠═╣║║║║║ ╠═╝║╣ ╠╦╝───║═╬╗║ ║║╣ ╠╦╝╚╦╝ ╠═╝╠═╣║ ╦║╣ ╚═╗
|
||
// ═╩╝ ╩ ╝╚╝╩ ╩╩ ╩╩╚═╝ ╩ ╚═╝╩╚═ ╚═╝╚╚═╝╚═╝╩╚═ ╩ ╩ ╩ ╩╚═╝╚═╝╚═╝
|
||
let vitals = _.where(sails.config.builtStaticContent.queries, {kind: 'built-in'});
|
||
let queries = _.where(sails.config.builtStaticContent.queries, {kind: 'query'});
|
||
let policies = _.where(sails.config.builtStaticContent.policies, {kind: 'policy'});
|
||
for (let query of queries) {
|
||
sitemapXml +=`<url><loc>${_.escape(sails.config.custom.baseUrl+`/queries/${query.slug}`)}</loc></url>`;// note we omit lastmod for some sitemap entries. This is ok, to mix w/ other entries that do have lastmod. Why? See https://docs.google.com/document/d/1SbpSlyZVXWXVA_xRTaYbgs3750jn252oXyMFLEQxMeU/edit
|
||
}//∞
|
||
for (let query of vitals) {
|
||
sitemapXml +=`<url><loc>${_.escape(sails.config.custom.baseUrl+`/vitals/${query.slug}`)}</loc></url>`;// note we omit lastmod for some sitemap entries. This is ok, to mix w/ other entries that do have lastmod. Why? See https://docs.google.com/document/d/1SbpSlyZVXWXVA_xRTaYbgs3750jn252oXyMFLEQxMeU/edit
|
||
}//∞
|
||
for (let query of policies) {
|
||
sitemapXml +=`<url><loc>${_.escape(sails.config.custom.baseUrl+`/policies/${query.slug}`)}</loc></url>`;// note we omit lastmod for some sitemap entries. This is ok, to mix w/ other entries that do have lastmod. Why? See https://docs.google.com/document/d/1SbpSlyZVXWXVA_xRTaYbgs3750jn252oXyMFLEQxMeU/edit
|
||
}//∞
|
||
// ╔╦╗╦ ╦╔╗╔╔═╗╔╦╗╦╔═╗ ╔═╗╔═╗╔═╗╔═╗╔═╗ ╔═╗╦═╗╔═╗╔╦╗ ╔╦╗╔═╗╦═╗╦╔═╔╦╗╔═╗╦ ╦╔╗╔
|
||
// ║║╚╦╝║║║╠═╣║║║║║ ╠═╝╠═╣║ ╦║╣ ╚═╗ ╠╣ ╠╦╝║ ║║║║ ║║║╠═╣╠╦╝╠╩╗ ║║║ ║║║║║║║
|
||
// ═╩╝ ╩ ╝╚╝╩ ╩╩ ╩╩╚═╝ ╩ ╩ ╩╚═╝╚═╝╚═╝ ╚ ╩╚═╚═╝╩ ╩ ╩ ╩╩ ╩╩╚═╩ ╩═╩╝╚═╝╚╩╝╝╚╝
|
||
// (includes data table documentation pages; i.e. `/tables/*`)
|
||
for (let pageInfo of sails.config.builtStaticContent.markdownPages) {
|
||
sitemapXml +=`<url><loc>${_.escape(sails.config.custom.baseUrl+pageInfo.url)}</loc><lastmod>${_.escape(new Date(pageInfo.lastModifiedAt).toJSON())}</lastmod></url>`;
|
||
}//∞
|
||
// ╔═╗╔╦╗╦ ╦╔═╗╦═╗ ╔╦╗╦ ╦╔╗╔╔═╗╔╦╗╦╔═╗ ╔═╗╔═╗╔═╗╔═╗╔═╗
|
||
// ║ ║ ║ ╠═╣║╣ ╠╦╝ ║║╚╦╝║║║╠═╣║║║║║ ╠═╝╠═╣║ ╦║╣ ╚═╗
|
||
// ╚═╝ ╩ ╩ ╩╚═╝╩╚═ ═╩╝ ╩ ╝╚╝╩ ╩╩ ╩╩╚═╝ ╩ ╩ ╩╚═╝╚═╝╚═╝
|
||
for (let appPage of sails.config.builtStaticContent.appLibrary) {
|
||
sitemapXml +=`<url><loc>${_.escape(sails.config.custom.baseUrl+`/software-catalog/${appPage.identifier}`)}</loc></url>`;// note we omit lastmod for some sitemap entries. This is ok, to mix w/ other entries that do have lastmod. Why? See https://docs.google.com/document/d/1SbpSlyZVXWXVA_xRTaYbgs3750jn252oXyMFLEQxMeU/edit
|
||
}//∞
|
||
for (let script of sails.config.builtStaticContent.scripts) {
|
||
sitemapXml +=`<url><loc>${_.escape(sails.config.custom.baseUrl+`/scripts/${script.slug}`)}</loc></url>`;// note we omit lastmod for some sitemap entries. This is ok, to mix w/ other entries that do have lastmod. Why? See https://docs.google.com/document/d/1SbpSlyZVXWXVA_xRTaYbgs3750jn252oXyMFLEQxMeU/edit
|
||
}//∞
|
||
for (let command of sails.config.builtStaticContent.mdmCommands) {
|
||
sitemapXml +=`<url><loc>${_.escape(sails.config.custom.baseUrl+`/mdm-commands/${command.slug}`)}</loc></url>`;// note we omit lastmod for some sitemap entries. This is ok, to mix w/ other entries that do have lastmod. Why? See https://docs.google.com/document/d/1SbpSlyZVXWXVA_xRTaYbgs3750jn252oXyMFLEQxMeU/edit
|
||
}//∞
|
||
// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
|
||
sitemapXml += '</urlset>';
|
||
|
||
// Set MIME type for content-type response header.
|
||
this.res.type('text/xml');
|
||
|
||
// Respond with XML.
|
||
return sitemapXml;
|
||
}
|
||
|
||
|
||
};
|