retype
retype copied to clipboard
Errors in build that aren't actually errors
I am receiving the following warnings in my build; however, these warnings are not correct. For example, in the first warning relating to #annualized-loss-expectancy-ale
not existing as an anchor, if I go to the page generating the warning (in this case, acronyms.md
) and select the hyperlink to the anchor, it works perfectly fine.
12:52:17.584 | Executing user command: retype build
-- | --
12:52:19.159 | INPUT: /opt/buildhome/repo
12:52:19.160 | OUTPUT: /opt/buildhome/repo/.retype
12:52:22.944 | WARNING: [reference/acronyms.md:19] Page anchor "/reference/glossary/#annualized-loss-expectancy-ale" was not found.
12:52:22.944 | WARNING: [reference/acronyms.md:31] Page anchor "/reference/glossary/#agreed-upon-procedures-aup" was not found.
12:52:22.944 | WARNING: [reference/acronyms.md:33] Page anchor "/reference/glossary/#business-continuity-bc" was not found.
12:52:22.944 | WARNING: [reference/acronyms.md:34] Page anchor "/reference/glossary/#business-continuity-management-bcm" was not found.
12:52:22.944 | WARNING: [reference/acronyms.md:35] Page anchor "/reference/glossary/#business-continuity-plan-bcp" was not found.
12:52:22.945 | WARNING: [reference/acronyms.md:40] Page anchor "/reference/glossary/#compliance-as-a-service-compaas-caas" was not found.
12:52:22.945 | WARNING: [reference/acronyms.md:42] Page anchor "/reference/glossary/#consensus-assessments-initiative-questionnaire-caiq" was not found.
12:52:22.945 | WARNING: [reference/acronyms.md:43] Page anchor "/reference/glossary/#cloud-application-management-for-platforms-camp" was not found.
12:52:22.945 | WARNING: [reference/acronyms.md:45] Page anchor "/reference/glossary/#cloud-access-security-broker-casb" was not found.
12:52:22.945 | WARNING: [reference/acronyms.md:46] Page anchor "/reference/glossary/#cost-benefit-analysis-cba" was not found.
12:52:22.945 | WARNING: [reference/acronyms.md:49] Page anchor "/reference/glossary/#cloud-controls-matrix-ccm" was not found.
12:52:22.945 | WARNING: [reference/acronyms.md:53] Page anchor "/reference/glossary/#configuration-item-ci" was not found.
12:52:22.946 | WARNING: [reference/acronyms.md:55] Page anchor "/reference/glossary/#critical-infrastructure-plan-cip" was not found.
12:52:22.946 | WARNING: [reference/acronyms.md:57] Page anchor "/reference/glossary/#capability-maturity-model-cmm" was not found.
12:52:22.946 | WARNING: [reference/acronyms.md:60] Page anchor "/reference/glossary/#compliance-as-a-service-compaas-caas" was not found.
12:52:22.947 | WARNING: [reference/acronyms.md:65] Page anchor "/reference/glossary/#cloud-standards-customer-council-cscc" was not found.
12:52:22.947 | WARNING: [reference/acronyms.md:67] Page anchor "/reference/glossary/#cloud-service-provider-csp" was not found.
12:52:22.947 | WARNING: [reference/acronyms.md:70] Page anchor "/reference/glossary/#database-activity-monitoring-dam" was not found.
12:52:22.947 | WARNING: [reference/acronyms.md:82] Page anchor "/reference/glossary/#disaster-recovery-dr" was not found.
12:52:22.947 | WARNING: [reference/acronyms.md:84] Page anchor "/reference/glossary/#disaster-recovery-plan-drp" was not found.
12:52:22.947 | WARNING: [reference/acronyms.md:86] Page anchor "/reference/glossary/#data-science-as-a-service-dsaas" was not found.
12:52:22.947 | WARNING: [reference/acronyms.md:91] Page anchor "/reference/glossary/#european-economic-area-eea" was not found.
12:52:22.948 | WARNING: [reference/acronyms.md:97] Page anchor "/reference/glossary/#enterprise-risk-management-erm" was not found.
12:52:22.948 | WARNING: [reference/acronyms.md:101] Page anchor "/reference/glossary/#file-activity-monitoring-fam" was not found.
12:52:22.948 | WARNING: [reference/acronyms.md:109] Page anchor "/reference/glossary/#fault-tolerance-ft" was not found.
12:52:22.948 | WARNING: [reference/acronyms.md:111] Page anchor "/reference/glossary/#generally-accepted-accounting-principles-gaap" was not found.
12:52:22.948 | WARNING: [reference/acronyms.md:114] Page anchor "/reference/glossary/#high-availability-ha" was not found.
12:52:22.948 | WARNING: [reference/acronyms.md:117] Page anchor "/reference/glossary/#hardware-security-module-hsm" was not found.
12:52:22.948 | WARNING: [reference/acronyms.md:120] Page anchor "/reference/glossary/#infrastructure-as-code-iac" was not found.
12:52:22.948 | WARNING: [reference/acronyms.md:130] Page anchor "/reference/glossary/#internal-security-assessor-isa" was not found.
12:52:22.949 | WARNING: [reference/acronyms.md:137] Page anchor "/reference/glossary/#information-technology-service-management-itsm" was not found.
12:52:22.949 | WARNING: [reference/acronyms.md:140] Page anchor "/reference/glossary/#letter-of-intent-loi" was not found.
12:52:22.949 | WARNING: [reference/acronyms.md:141] Page anchor "/reference/glossary/#maximum-allowable-downtime-mad" was not found.
12:52:22.949 | WARNING: [reference/acronyms.md:142] Page anchor "/reference/glossary/#microsoft-deployment-toolkit-mtd" was not found.
12:52:22.949 | WARNING: [reference/acronyms.md:144] Page anchor "/reference/glossary/#memorandum-of-agreement-moa" was not found.
12:52:22.949 | WARNING: [reference/acronyms.md:145] Page anchor "/reference/glossary/#memorandum-of-understanding-mou" was not found.
12:52:22.949 | WARNING: [reference/acronyms.md:146] Page anchor "/reference/glossary/#maximum-tolerable-downtime-mtd" was not found.
12:52:22.949 | WARNING: [reference/acronyms.md:147] Page anchor "/reference/glossary/#managed-service-provider-msp" was not found.
12:52:22.949 | WARNING: [reference/acronyms.md:151] Page anchor "/reference/glossary/#networking-as-a-service-naas" was not found.
12:52:22.949 | WARNING: [reference/acronyms.md:176] Page anchor "/reference/glossary/#qualified-security-assessor-qsa" was not found.
12:52:22.950 | WARNING: [reference/acronyms.md:181] Page anchor "/reference/glossary/#report-of-compliance-roc" was not found.
12:52:22.950 | WARNING: [reference/acronyms.md:182] Page anchor "/reference/glossary/#return-on-investment-roi" was not found.
12:52:22.950 | WARNING: [reference/acronyms.md:183] Page anchor "/reference/glossary/#recovery-point-objective-rpo" was not found.
12:52:22.950 | WARNING: [reference/acronyms.md:184] Page anchor "/reference/glossary/#recovery-service-level-rsl" was not found.
12:52:22.950 | WARNING: [reference/acronyms.md:185] Page anchor "/reference/glossary/#reduced-sign-on-rso" was not found.
12:52:22.951 | WARNING: [reference/acronyms.md:186] Page anchor "/reference/glossary/#recovery-time-objective-rto" was not found.
12:52:22.951 | WARNING: [reference/acronyms.md:190] Page anchor "/reference/glossary/#sensitive-authentication-data-sad" was not found.
12:52:22.951 | WARNING: [reference/acronyms.md:192] Page anchor "/reference/glossary/#self-assessment-questionnaire-saq" was not found.
12:52:22.951 | WARNING: [reference/acronyms.md:197] Page anchor "/reference/glossary/#source-code-analysis-sca" was not found.
12:52:22.952 | WARNING: [reference/acronyms.md:198] Page anchor "/reference/glossary/#system-for-cross-domain-identity-management-scim" was not found.
12:52:22.952 | WARNING: [reference/acronyms.md:206] Page anchor "/reference/glossary/#service-oriented-architecture-soa" was not found.
12:52:22.952 | WARNING: [reference/acronyms.md:211] Page anchor "/reference/glossary/#service-provisioning-markup-language-spml" was not found.
12:52:22.952 | WARNING: [reference/acronyms.md:220] Page anchor "/reference/glossary/#trusted-platform-module-tpm" was not found.
12:52:22.952 | WARNING: [reference/acronyms.md:221] Page anchor "/reference/glossary/#underpinning-contract-uc" was not found.
12:52:22.952 | WARNING: [reference/acronyms.md:226] Page anchor "/reference/glossary/#web-application-firewall-waf" was not found.
12:52:22.952 | WARNING: [reference/acronyms.md:228] Page anchor "/reference/glossary/#write-once-read-many-worm" was not found.
12:52:22.952 | WARNING: [reference/acronyms.md:229] Page anchor "/reference/glossary/#work-recovery-time-wrt" was not found.
12:52:22.953 | WARNING: [reference/glossary.md:695] Page anchor "/reference/glossary/#maximum-allowable-downtime-mad" was not found.
12:52:22.953 | WARNING: [reference/glossary.md:700] Page anchor "/reference/glossary/#memorandum-of-understanding-mou" was not found.
12:52:22.953 | WARNING: [reference/glossary.md:895] Page anchor "/reference/glossary/#trust-zones" was not found.
12:52:22.953 | WARNING: [concepts/contracts.md:21] Page anchor "/concepts/contracts/#memorandum-of-understanding-mou" was not found.
12:52:22.953 | WARNING: [concepts/business/bcdr.md:69] Page anchor "/concepts/business/bcdr/#maximum-allowable-downtime-mad" was not found.
12:52:25.853 | Please use --verbose for more details
12:52:25.853 |
12:52:25.863 | Retype finished in 5.3 seconds!
12:52:25.864 | 150 pages built
12:52:25.864 | 0 errors
12:52:25.865 | 62 warnings
12:52:25.865 |
12:52:25.922 | Finished
Maybe you are missing the .md
file extension on the link within the acronyms.md
file? So the link should /reference/glossary.md#annualized-loss-expectancy-ale
not /reference/glossary/#annualized-loss-expectancy-ale
?
That's just a guess.
If adding the .md
removes the warnings, please let me know and we can investigate supporting that scenario within the parser. I kinda would have expected it to work, so I'll do some testing anyways.
Just updated the acronyms.md page for a few of the terms, but the same error occurred, just with the updated names:
13:37:42.806 | WARNING: [reference/acronyms.md:19] Page anchor "/reference/glossary.md#annualized-loss-expectancy-ale" was not found.
-- | --
13:37:42.807 | WARNING: [reference/acronyms.md:31] Page anchor "/reference/glossary.md#agreed-upon-procedures-aup" was not found.
13:37:42.807 | WARNING: [reference/acronyms.md:33] Page anchor "/reference/glossary/#business-continuity-bc" was not found.
13:37:42.807 | WARNING: [reference/acronyms.md:34] Page anchor "/reference/glossary/#business-continuity-management-bcm" was not found.
In either case, the links still function properly.
I was able to isolate the issue. Currently, Retype will not resolve links to Panel title (#anchors).
Use the following chunk from /concepts/contracts.md
as an example.
=== Memorandum of Agreement (MOA)
*See [Memorandum of Understanding (MOU)](/concepts/contracts/#memorandum-of-understanding-mou)
=== Memorandum of Understanding (MOU)
A *nonbinding* agreement between two or more parties outlining the terms and details of an understanding, including each parties' requirements and responsibilities.
===
The link [Memorandum of Understanding (MOU)](/concepts/contracts/#memorandum-of-understanding-mou)
is technically correct but currently Retype does not resolve that link to the === Memorandum of Understanding (MOU)
Panel title.
If === Memorandum of Understanding (MOU)
was a Heading, Retype would resolve the link.
Soooo, this is a feature that is missing from the Retype link resolution engine. Maybe it could be considered a bug, although I would consider this functionality that Retype was just not designed to perform.
Unfortunately, for now, I do have a good suggestion on how to disable, work-around, or have Retype somehow ignore throwing those WARNING
messages. I will keep this in mind and post an update if we think of anything.
I will log this issue and we will try our best to add the functionality within the next release of Retype.
See also
- #659
This enhancement has been made and will be included in the upcoming v3.6.0 release. Retype will now properly resolve Panel anchors.
Hope this helps.