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

Rework Integrations Docs Organization #360

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

inconshreveable
Copy link
Contributor

This PR is a proposal for consideration. If we want to adopt it, there's a bunch of additional work to do before this can merge. This is just a sketch.

It refactors our Integrations documentation to do three things:

  1. Organize our integrations by how they integrate instead of strictly by vendor. image
  2. Merge about half of Using ngrok with . . . into Integrations. I didn't move the remainder of the items in Using ngrok with . . . because many of them are not exactly integrations, per se, although you could make an argument for some of them. I'm not sure where those will find a home eventually but I think that's a problem for later.
  3. Remove the 'nesting' of integration providers. Previously, for each vendor you would need to click into the vendor and then again to get to a guide. Now you only need to do that if an integration vendor has more than one guide. I didn't finish moving them all, but I did enough to give us an idea of what the change would feel like:
image

If we want to move forward, I'll create a complete TODO list of what needs to be done to complete the transition.

@vercel
Copy link

vercel bot commented Jul 10, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
ngrok-docs ❌ Failed (Inspect) Jul 10, 2023 3:01am

@inconshreveable inconshreveable changed the title Rework Integrations Documentation Rework Integrations Docs Organization Jul 10, 2023
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.

1 participant