awslabs/landing-zone-accelerator-on-aws

Typedocs for v1.7.0 are missing examples and remarks

Opened this issue · 1 comments

thomelliot commented

Describe the bug
Examples and remarks are missing from the latest/v1.7.0 version of typedocs

To Reproduce
Compare v1.6.4, with v1.7.0 version of ResolverConfig. The example block at the beginning as well as all remarks below each property are missing. Issue is present across all pages in the documentation.

Expected behavior
Documentation should be visible for v1.7.0.

Please complete the following information about the solution:

  • Version: [e.g. v1.7.0]

To get the version of the solution, you can look at the description of the created AWS CloudFormation stack used to install the LZA (AWSAccelerator-InstallerStack). For example, "(SO0199) Landing Zone Accelerator on AWS. Version 1.5.1.". If the description does not contain the version information, you can look at the Parameters of the stack for the RepositoryBranchName as that should contain the version number.

  • Region: N/A this is a GitHub pages documentation issue
  • Was the solution modified from the version published on this repository? N/A
  • If the answer to the previous question was yes, are the changes available on GitHub? N/A
  • Have you checked your service quotas for the services this solution uses? N/A
  • Were there any errors in the CloudWatch Logs? N/A

Screenshots
If applicable, add screenshots to help explain your problem (please DO NOT include sensitive information).

Example block v1.6.4
v164example
Example block v1.7.0
v170example
Remarks block v1.6.4
v164remarks
Remarks block v1.7.0
v170remarks

Additional context
Add any other context about the problem here.

erwaxler commented

Hey @thomelliot , thanks for raising this issue to the team. I believe this is a result of a schema migration between the v1.6 and v1.7 releases, I've created an internal issue to update and standardize our TypeDoc examples. Thank you for your support of the Landing Zone Accelerator!