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

build(docs-infra): ensure hidden cli commands are excluded from sitemap.xml (#30395)

Browse Source 
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
This commit is contained in:
George Kalpakas 2019-05-10 19:48:33 +03:00 committed by Alex Rickabaugh
parent 44cf981407
commit d80ae6ba0d
2 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
aio/tools/transforms/cli-docs-package/processors/filterHiddenCommands.js
View File

@ -1,7 +1,7 @@
module.exports = function filterHiddenCommands() { module.exports = function filterHiddenCommands() {
return { return {
$runAfter: ['files-read'], $runAfter: ['files-read'],
$runBefore: ['processCliContainerDoc'], $runBefore: ['processCliContainerDoc', 'createSitemap'],
$process(docs) { $process(docs) {
return docs.filter(doc => doc.docType !== 'cli-command' || doc.hidden !== true); return docs.filter(doc => doc.docType !== 'cli-command' || doc.hidden !== true);
} }

2
aio/tools/transforms/cli-docs-package/processors/filterHiddenCommands.spec.js
View File

@ -18,7 +18,7 @@ describe('filterHiddenCommands processor', () => {
it('should run before the correct processor', () => { it('should run before the correct processor', () => {
const processor = processorFactory(); const processor = processorFactory();
expect(processor.$runBefore).toEqual(['processCliContainerDoc']); expect(processor.$runBefore).toEqual(['processCliContainerDoc', 'createSitemap']);
}); });
it('should remove CLI command docs that are hidden', () => { it('should remove CLI command docs that are hidden', () => {