search

Kong / insomnia-docs

This repository houses all Insomnia documentation.
https://docs.insomnia.rest
35 stars 68 forks source link

docs(get started): Revise Install Insomnia doc #226

Closed cloudjumpercat closed 3 months ago

cloudjumpercat commented 3 months ago

Summary

Revised the existing Install Insomnia doc for wording and formatting

Reason

DOCU-3899

Testing

vercel[bot] commented 3 months ago

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

Name Status Preview Updated (UTC)
insomnia-docs ✅ Ready (Inspect) Visit Preview Jul 11, 2024 7:25pm
cloudjumpercat commented 3 months ago

@lena-larionova If you have time, could you look over the visual design of this Insomnia Install page? I'm not sure what to do, but it feels like there might be some easier ways to make this a more visual install page, like https://docs.konghq.com/gateway/latest/install/.

lena-larionova commented 3 months ago

If you have time, could you look over the visual design of this Insomnia Install page? I'm not sure what to do, but it feels like there might be some easier ways to make this a more visual install page, like https://docs.konghq.com/gateway/latest/install/.

Hmm. That Gateway page has a bunch of custom CSS that we'd have to add to the Insomnia docs to make it work. Can you break down what you think the matrix of installation options would look like? So far, I can see:

Are there differences between free and Enterprise install packages, or is it just a matter of applying a license to a free version?

cloudjumpercat commented 3 months ago

That Gateway page has a bunch of custom CSS that we'd have to add to the Insomnia docs to make it work.

Yeah, I wasn't sure if we wanted to get that complicated. I wasn't sure if there was a way we could reuse existing CSS in Insomnia. Ex. Their download page has a nice button to download the installer, but the website is a separate repo (looks like it's in react), so I'm not sure if we could reuse that.

Hmm. That Gateway page has a bunch of custom CSS that we'd have to add to the Insomnia docs to make it work. Can you break down what you think the matrix of installation options would look like? So far, I can see:

  • MacOS:

    • Package
    • Homebrew
  • Windows

  • Linux:

    • Ubuntu/Debian via apt
    • Snap

@lena-larionova Yep, that's what I understood of the installation matrix as well.

Are there differences between free and Enterprise install packages, or is it just a matter of applying a license to a free version?

I think it's just a matter of applying a license, @filfreire can you confirm if this is correct?

filfreire commented 3 months ago

@cloudjumpercat correct. For the downloaded/installed app, there's no difference. The license is applied by on the accounts website (https://app.insomnia.rest)

lena-larionova commented 3 months ago

Let's leave your page as is without trying to overdesign it, because the Insomnia site already has its own pretty download page. We don't have that for Gateway, so it has to lean on docs - that's why that page exists.