Skip to content

DOCS: Fix various issues in Provider Table#3608

Closed
chicks-net wants to merge 6 commits intoStackExchange:mainfrom
chicks-net:chicks/docs-providers-table-tweaks
Closed

DOCS: Fix various issues in Provider Table#3608
chicks-net wants to merge 6 commits intoStackExchange:mainfrom
chicks-net:chicks/docs-providers-table-tweaks

Conversation

@chicks-net
Copy link
Copy Markdown
Collaborator

@chicks-net chicks-net commented Jun 7, 2025

Context

Fixes #3607

Done

  • Add two docs references to SUMMARY.md

Verify

  • The new references show up in the sidebar on the preview site.

other parts are still in process of debugging

@chicks-net
Copy link
Copy Markdown
Collaborator Author

@cafferata the preview does not look better after adding the references in this PR.

Is there any way to see the SUMMARY.md in the preview?

@chicks-net
Copy link
Copy Markdown
Collaborator Author

another preview and it still doesn't work.

The new files are showing up and working from the side bar, so I think the additions to the SUMMARY.md are ok.

@cafferata
Copy link
Copy Markdown
Collaborator

@chicks-net, the SUMMARY.md file effectively represents the menu in the preview. That’s the best place to confirm whether the new items have been added correctly. In this case, you can see the two new menu entries are included. There’s no need for a separate preview of SUMMARY.md itself.

As for the links: there is no need to convert the relative URLs into absolute ones. They work correctly within the intended context.

Example links:

Let me know if anything looks off.

@chicks-net
Copy link
Copy Markdown
Collaborator Author

Let me know if anything looks off.

I eventually worked out that that the SUMMARY.md becomes the menu and it seems to define the structure regardless of the file layout of the source Markdown files. A little weird, but I think I get it.

The "it still doesn't work" that I was trying to refer to is in the Providers table. Those still shows up as links to github for me. For instance, the latest revision looks like this:

Screenshot 2025-06-08 at 8 23 13 AM

I've tried with the .md extension and without the middle directory specified and all of them end up pointing to github from the table on the Providers page.

So, its cool that I've added these wayward files into the site. That's definite progress. But fixing the providers table is the bug that has been actually bothering people. And that's not fixed. Do we have to go through one publish cycle with these references in the SUMMARY.md before the references in other places, like the provider features table, are able to pick it up as a local link?

@chicks-net
Copy link
Copy Markdown
Collaborator Author

try one more time with the extension

this preview is a little closer.

Screenshot 2025-06-08 at 5 42 38 PM

I have more ideas....

@chicks-net
Copy link
Copy Markdown
Collaborator Author

what if the advanced-features directory exists

this preview fixed the biggest difference I could see versus the other links in the table. I moved the dual-host.md into the advanced-features directory that had never existed before.

Screenshot 2025-06-08 at 5 49 24 PM

This also broke the dual-host.md page when you click on it in the preview. 😞 Let me try another angle.

@chicks-net
Copy link
Copy Markdown
Collaborator Author

chicks-net commented Jun 8, 2025

placeholder directory with index.md in it

This preview still is linking to github:

Screenshot 2025-06-08 at 5 59 36 PM

But

  • the dual-host page is back to working.
  • the /advanced-features/index is not found. I thought about adding a reference for it in SUMMARY.md, but this wasn't needed to get other directory structure to work. provider/index.md is the only one I see referenced in SUMMARY.md.

I've reread the GitBook documentation and it does not help me figure this out. I'm going to see if I can come up with another approach to this. I'm open to ideas. 💡

@tlimoncelli
Copy link
Copy Markdown
Contributor

I just noticed that AZURE_DNS isn't listed on the DNSSEC table. Is that because providers.CanAutoDNSSEC isn't included at all in providers/azuredns/azureDnsProvider.go ?

@chicks-net
Copy link
Copy Markdown
Collaborator Author

chicks-net commented Jun 9, 2025

I just noticed that AZURE_DNS isn't listed on the DNSSEC table. Is that because providers.CanAutoDNSSEC isn't included at all in providers/azuredns/azureDnsProvider.go ?

This is very likely due to all of the fields being questions marks for that provider in that table, so it was intentionally skipped. https://github.com/StackExchange/dnscontrol/blob/main/build/generate/featureMatrix.go#L60

If you'd prefer to have those included to reduce confusion, that's easy to fix. But the tables get longer and noisier.

@tlimoncelli
Copy link
Copy Markdown
Contributor

If you'd prefer to have those included to reduce confusion, that's easy to fix. But the tables get longer and noisier.

I think the right solution is to update Cloudflare to correctly list what it does, so that it appears in the table. I'll take care of that next time I do some updates.

Tom

@cafferata
Copy link
Copy Markdown
Collaborator

Hi @chicks-net,

Thanks a lot for your initial attempt to fix the missing Concurrency Verified and Dual Host pages in the GitBook structure.

I've just submitted a follow-up PR that restructures the Markdown files to align with the generated GitBook URLs, so these pages are now correctly linked and visible:
👉 #3613

Let me know if you have any feedback or spot anything off. Appreciate your groundwork on this!

@chicks-net
Copy link
Copy Markdown
Collaborator Author

Hi @chicks-net,

Thanks a lot for your initial attempt to fix the missing Concurrency Verified and Dual Host pages in the GitBook structure.

Thank you for figuring it out. I was out of ideas.

I've just submitted a follow-up PR that restructures the Markdown files to align with the generated GitBook URLs, so these pages are now correctly linked and visible: 👉 #3613

The live site fixes the issues that I had noticed. Thank you.

Let me know if you have any feedback or spot anything off. Appreciate your groundwork on this!

I'll work on the second part of #3607 now that #3613 is merged.

@chicks-net chicks-net closed this Jun 11, 2025
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

Successfully merging this pull request may close these issues.

DOCS: cleanup provider table

3 participants