DOCS: every provider doc includes feature flags automatically#4173
DOCS: every provider doc includes feature flags automatically#4173chicks-net wants to merge 2 commits into
Conversation
|
This will need to get rebased, but I switched it to Draft since I want to wait to rebase until #3983 is merged. |
015004d to
382f21e
Compare
Signed-off-by: Christopher Hicks <chicks.net@gmail.com>
|
Rebased after #3983 landed. This is ready for review again. (My timing for when I originally landed this was really bad. 😢 ) @TomOnTime @cafferata I'm looking forward to your feedback. For instance, can you think of something better than "Feature Flags" for the heading? In my humble opinion this really helps providers without much documentation like AutoDNS look better. On my screen this page now requires a bit of scrolling where the existing version fits without scrolling. |
TomOnTime
left a comment
There was a problem hiding this comment.
The code all looks good. I'll let @cafferata comment on the format/style.
As far as "Feature Flags"... how about calling it "Feature Support"?
cafferata
left a comment
There was a problem hiding this comment.
The current implementation looks good and will work well. The feature flags section is a valuable addition to each provider page. I have a few smaller suggestions that could improve the experience.
| ## Feature Flags | ||
|
|
||
| <!-- provider-features-start --> | ||
| - Provider Type |
There was a problem hiding this comment.
"Provider Type" could link to the provider matrix so users can compare across providers. Same for the other category headings.
|
|
||
| <!-- provider-features-start --> | ||
| - Provider Type | ||
| - Official Support: ❌ |
There was a problem hiding this comment.
Could link to the official support section so users understand what "Official Support" means.
| - [Concurrency Verified](../advanced-features/concurrency-verified.md): ✅ | ||
| - [dual host](../advanced-features/dual-host.md): ❌ | ||
| - create-domains: ❌ | ||
| - get-zones: ✅ |
There was a problem hiding this comment.
Could link to the get-zones command docs. Same applies to create-domains.
| Done. 2 corrections. | ||
| ``` | ||
|
|
||
| ## Feature Flags |
There was a problem hiding this comment.
How would a user know what ❔ means? There is no legend included. The list is also quite long (21 features across 6 categories), and for most providers the majority is ❔.
A more compact approach: only show ✅ and ❌ items, grouped under "Supported" and "Not supported". That reduces the list to 5-10 items for most providers and removes visual noise. Users who want the full picture can still check the provider matrix.
Fixes #3584
Done
Meta
(Automated in
.just/gh-process.just.)