Kapeli / Dash-User-Contributions

Dash repo of user contributed docsets
2k stars 851 forks source link

Replacing existing AWS_CloudFormation_Template_Reference #5219

Open tmclaugh opened 2 weeks ago

tmclaugh commented 2 weeks ago

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:

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 commented 2 weeks ago

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 commented 2 weeks ago

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 commented 2 weeks ago

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

Kapeli commented 2 weeks ago

Update the existing directory