awslabs / landing-zone-accelerator-on-aws

Deploy a multi-account cloud foundation to support highly-regulated workloads and complex compliance requirements.
https://aws.amazon.com/solutions/implementations/landing-zone-accelerator-on-aws/
Apache License 2.0
536 stars 425 forks source link

Links in Typedocs not working #394

Open MarkRoss-Eviden opened 8 months ago

MarkRoss-Eviden commented 8 months ago

Describe the bug Typedocs links aren't working and have numerous links to resources that give 404 error

To Reproduce Navigate to Typedocs, e.g. v1.5.2 Choose one of the embedded links, e.g. BackupConfig.

Note - this seems to happen to all the links I've tried for the resources.

Expected behavior Expect the embedded links to open another webpage with detail of the specific resource

Please complete the following information about the solution:

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.

Screenshots image

image

image

Additional context Seems the issue is a missing part of URL, if I add to the URL manually 'latest/typedocs/v1.5.0/' I can get to a page, e.g.: - image

bhkhatri221 commented 7 months ago

Hello @MarkRoss-Eviden, thank you for filing an issue with the Landing Zone Accelerator team! We are aware of the issue, and currently working on it. This will be fixed during our next release.

We will keep this issue open for tracking purposes and keep you aware of any status updates going forward. Thank you for supporting Landing Zone Accelerator!

vforvarun commented 3 months ago

Typedocs is still not working in v1.7.0. Do we have an ETA on when this will be fixed?

bhkhatri221 commented 3 months ago

Hello @vforvarun , Thank you for reaching out to the Landing Zone Accelerator team! Please use the GitHub Pages website link available through developing.md file. From the dropdown menu, select for desired LZA version (next to Landing Zone Accelerator on AWS), as shown in the following diagram. In the navigation panel, navigate to Services, Features, and Configuration References under the User Guide. Let me know if it works for you.

Regarding the issue with v1.5.X, we are still working on resolving the fix. We will keep this issue open for tracking purposes and keep you aware of any status updates going forward.

Screenshot 2024-06-17 at 5 46 29 PM