Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Replacing existing AWS_CloudFormation_Template_Reference #5219

Open
tmclaugh opened this issue Nov 4, 2024 · 4 comments
Open

Replacing existing AWS_CloudFormation_Template_Reference #5219

tmclaugh opened this issue Nov 4, 2024 · 4 comments

Comments

@tmclaugh
Copy link

tmclaugh commented Nov 4, 2024

Hi, the existing AWS CFN docset has grown out of date. I attempted to update it but the generation script was written for a much older version of node which lead me to do a complete rewrite. I've gotten permission from the original docset author to replace his. in pdhodgkinson/AWSCloudFormationTemplateReference-dash-docset#22

Besides updating the documentation I've also:

  • Added section anchors in pages
  • Used the AWS site CSS for a native look at feel
  • Added syntax highlighting
  • Can now browse by both AWS CFN resources (AWS::Service::Resource) or AWS service names

Because this is a large rewrite by a new person how should I handle adding it? I also made a change to the DocSetPlatformFamily so it was much shorter.

My latest release can be found here.

https://github.com/ServerlessOpsIO/dash-docset-aws-cloudformation/releases/tag/20241104.01

@tmclaugh
Copy link
Author

tmclaugh commented Nov 4, 2024

I also have one issue. in this dropdown I'm not sure where the smaller lighter text is from and why sometimes it just says "AWS". How do I fix this?

Screenshot 2024-11-04 at 3 40 12 PM

@Kapeli
Copy link
Owner

Kapeli commented Nov 5, 2024

Because this is a large rewrite by a new person how should I handle adding it?

You can submit a pull request that includes the update.

I also have one issue. in this dropdown I'm not sure where the smaller lighter text is from and why sometimes it just says "AWS". How do I fix this?

That text is taken from the file name of the docs page by default. You can disable it by adding this in Info.plist: <key>DashDocSetDeclaredInStyle</key><string>originalName</string>.

You can customize it for each entry by adding this anywhere in the path of the entry (in docSet.dsidx): <dash_entry_menuDescription=#percent_encoded_value#>

@tmclaugh
Copy link
Author

tmclaugh commented Nov 5, 2024

Hi, but am I replacing the existing docset directory with a new one or using the existing directory?

@Kapeli
Copy link
Owner

Kapeli commented Nov 5, 2024

Update the existing directory

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants