docs(get started): Revise Install Insomnia doc #226
Conversation
Signed-off-by: Diana <[email protected]>
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
| @@ -3,13 +3,11 @@ layout: article-detail | |||
| title: Install Insomnia | |||
| --- | |||
|
|
|||
| <!-- for rework: revise this page like we normally would --> | |||
|
|
|||
| Insomnia is available on macOS, Windows, and Linux. If you haven't already downloaded Insomnia, visit the [Download Page](https://insomnia.rest/download). | |||
|
|
|||
| <nav> | |||
| <div class="nav nav-tabs" id="nav-tab" role="tablist"> | |||
There was a problem hiding this comment.
For reviewers: I think tabs is still the way to go here rather than sections for each (like https://learning.postman.com/docs/getting-started/installation/installation-and-updates) or a table of options (like https://docs.konghq.com/gateway/3.7.x/install/). I decided to not do the table of options because I don't think the install is different for EE or OSS and because all the install instructions can live on one page instead of separate pages.
| <a href="https://insomnia.rest/download">Download</a> and double-click the disk image. When prompted, drag Insomnia to your <b>Applications</b> folder. This ensures future updates can be installed correctly. | ||
| <br/><br/> | ||
| macOS users can also install Insomnia using <a href="https://brew.sh/">Brew Cask</a> via the Insomnia package: | ||
| <a href="https://insomnia.rest/download">Download Insomnia on macOS</a> or use <a href="https://brew.sh/">Homebrew</a>: |
There was a problem hiding this comment.
For reviewers: Is there an easy way to reuse the "Download Insomnia for macOS" from the website here? I think the hyperlink is okay, just trying to think of visual designs that will make this content seem more professional?
|
@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/. |
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? |
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.
@lena-larionova Yep, that's what I understood of the installation matrix as well.
I think it's just a matter of applying a license, @filfreire can you confirm if this is correct? |
|
@cloudjumpercat correct. For the downloaded/installed app, there's no difference. The license is applied by on the accounts website (https://app.insomnia.rest) |
|
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. |
Summary
Revised the existing Install Insomnia doc for wording and formatting
Reason
DOCU-3899
Testing