From d80ae6ba0de9ac669130b036374c5d43cfc63b51 Mon Sep 17 00:00:00 2001 From: George Kalpakas Date: Fri, 10 May 2019 19:48:33 +0300 Subject: [PATCH] build(docs-infra): ensure hidden cli commands are excluded from `sitemap.xml` (#30395) Previously, the processor that excludes certain cli commands (`filterHiddenCommand`) was being run after the `createSitemap` processor, resulting in those commands to be present in `sitemap.xml`, while the actual pages where missing. This also resulted in 404s, when search engine crawlers tried to index the missing URLs. This commit fixes it by ensuring that the `filterHiddenCommand` processor is run before the `createSitemap` processor. PR Close #30395 --- .../cli-docs-package/processors/filterHiddenCommands.js | 2 +- .../cli-docs-package/processors/filterHiddenCommands.spec.js | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/aio/tools/transforms/cli-docs-package/processors/filterHiddenCommands.js b/aio/tools/transforms/cli-docs-package/processors/filterHiddenCommands.js index ebf3c6df58..e75e6e40ac 100644 --- a/aio/tools/transforms/cli-docs-package/processors/filterHiddenCommands.js +++ b/aio/tools/transforms/cli-docs-package/processors/filterHiddenCommands.js @@ -1,7 +1,7 @@ module.exports = function filterHiddenCommands() { return { $runAfter: ['files-read'], - $runBefore: ['processCliContainerDoc'], + $runBefore: ['processCliContainerDoc', 'createSitemap'], $process(docs) { return docs.filter(doc => doc.docType !== 'cli-command' || doc.hidden !== true); } diff --git a/aio/tools/transforms/cli-docs-package/processors/filterHiddenCommands.spec.js b/aio/tools/transforms/cli-docs-package/processors/filterHiddenCommands.spec.js index b3b570a3de..45703072d5 100644 --- a/aio/tools/transforms/cli-docs-package/processors/filterHiddenCommands.spec.js +++ b/aio/tools/transforms/cli-docs-package/processors/filterHiddenCommands.spec.js @@ -18,7 +18,7 @@ describe('filterHiddenCommands processor', () => { it('should run before the correct processor', () => { const processor = processorFactory(); - expect(processor.$runBefore).toEqual(['processCliContainerDoc']); + expect(processor.$runBefore).toEqual(['processCliContainerDoc', 'createSitemap']); }); it('should remove CLI command docs that are hidden', () => {