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

docs(Insomnia docs rework): Get Started section sidebar styling and placeholder pages #222

Draft
wants to merge 8 commits into
base: main
Choose a base branch
from
Draft
62 changes: 36 additions & 26 deletions docs/Gemfile.lock
Original file line number Diff line number Diff line change
@@ -1,38 +1,43 @@
GEM
remote: https://rubygems.org/
specs:
addressable (2.8.0)
public_suffix (>= 2.0.2, < 5.0)
addressable (2.8.7)
public_suffix (>= 2.0.2, < 7.0)
bigdecimal (3.1.8)
colorator (1.1.0)
concurrent-ruby (1.1.10)
concurrent-ruby (1.3.3)
em-websocket (0.5.3)
eventmachine (>= 0.12.9)
http_parser.rb (~> 0)
eventmachine (1.2.7)
ffi (1.15.5)
ffi (1.17.0-arm64-darwin)
forwardable-extended (2.6.0)
google-protobuf (4.27.2-arm64-darwin)
bigdecimal
rake (>= 13)
http_parser.rb (0.8.0)
i18n (1.10.0)
i18n (1.14.5)
concurrent-ruby (~> 1.0)
jekyll (4.2.2)
jekyll (4.3.3)
addressable (~> 2.4)
colorator (~> 1.0)
em-websocket (~> 0.5)
i18n (~> 1.0)
jekyll-sass-converter (~> 2.0)
jekyll-sass-converter (>= 2.0, < 4.0)
jekyll-watch (~> 2.0)
kramdown (~> 2.3)
kramdown (~> 2.3, >= 2.3.1)
kramdown-parser-gfm (~> 1.0)
liquid (~> 4.0)
mercenary (~> 0.4.0)
mercenary (>= 0.3.6, < 0.5)
pathutil (~> 0.9)
rouge (~> 3.0)
rouge (>= 3.0, < 5.0)
safe_yaml (~> 1.0)
terminal-table (~> 2.0)
terminal-table (>= 1.8, < 4.0)
webrick (~> 1.7)
jekyll-feed (0.16.0)
jekyll (>= 3.7, < 5.0)
jekyll-sass-converter (2.2.0)
sassc (> 2.0.1, < 3.0)
jekyll-sass-converter (3.0.0)
sass-embedded (~> 1.54)
jekyll-seo-tag (2.8.0)
jekyll (>= 3.8, < 5.0)
jekyll-watch (2.2.1)
Expand All @@ -41,8 +46,8 @@ GEM
rexml
kramdown-parser-gfm (1.1.0)
kramdown (~> 2.0)
liquid (4.0.3)
listen (3.7.1)
liquid (4.0.4)
listen (3.9.0)
rb-fsevent (~> 0.10, >= 0.10.3)
rb-inotify (~> 0.9, >= 0.9.10)
mercenary (0.4.0)
Expand All @@ -52,25 +57,30 @@ GEM
jekyll-seo-tag (~> 2.1)
pathutil (0.16.2)
forwardable-extended (~> 2.6)
public_suffix (4.0.7)
rb-fsevent (0.11.1)
rb-inotify (0.10.1)
public_suffix (6.0.0)
rake (13.2.1)
rb-fsevent (0.11.2)
rb-inotify (0.11.1)
ffi (~> 1.0)
rexml (3.2.5)
rouge (3.28.0)
rexml (3.3.1)
strscan
rouge (4.3.0)
safe_yaml (1.0.5)
sassc (2.4.0)
ffi (~> 1.9)
terminal-table (2.0.0)
unicode-display_width (~> 1.1, >= 1.1.1)
unicode-display_width (1.8.0)
sass-embedded (1.77.5-arm64-darwin)
google-protobuf (>= 3.25, < 5.0)
strscan (3.1.0)
terminal-table (3.0.2)
unicode-display_width (>= 1.1.1, < 3)
unicode-display_width (2.5.0)
webrick (1.8.1)

PLATFORMS
arm64-darwin-23
universal-darwin-20
universal-darwin-21

DEPENDENCIES
jekyll (~> 4.2.0)
jekyll (~> 4.3.0)
jekyll-feed (~> 0.12)
minima (~> 2.5)
tzinfo (~> 1.2)
Expand Down
47 changes: 35 additions & 12 deletions docs/_data/main-nav.yaml
Original file line number Diff line number Diff line change
@@ -1,19 +1,40 @@
toc:
- title: Get Started, Design Debug and Test
- title: Get Started
collapse-id: get-started
items:
- title: Introduction to Insomnia
url: /insomnia/get-started
- title: Install Insomnia
url: /insomnia/install
- title: Send Your First Request
url: /insomnia/send-your-first-request
- title: Import and Export Data
url: /insomnia/import-export-data
- title: Environment Variables
url: /insomnia/environment-variables
- title: Global Environments
url: /insomnia/global-environments
url: /insomnia/get-started/install
- title: Collections
collapse-id: collections
subfolderitems:
- title: Create your first Collection
url: /insomnia/get-started/collections/create
- title: Send your first request
url: /insomnia/get-started/collections/send-your-first-request
- title: Add a pre-request script
url: /insomnia/get-started/collections/pre-request-script
- title: Documents
collapse-id: documents
subfolderitems:
- title: Import an OpenAPI Spec
url: /insomnia/get-started/documents/spec
- title: Generate a Collection
url: /insomnia/get-started/documents/generate-collection
- title: Add a pre-request script
url: /insomnia/get-started/documents/pre-request-script
- title: Write your first test
url: /insomnia/get-started/documents/test
- title: Mock server
collapse-id: mock-server
subfolderitems:
- title: Import data from another API client
url: /insomnia/get-started/mock-server/import-export-data
- title: Allowlist for Insomnia
url: /insomnia/get-started/mock-server/allowlist
- title: Configure a proxy server
url: /insomnia/get-started/mock-server/proxy
- title: Insomnia Accounts
collapse-id: insomnia-accounts
items:
Expand All @@ -39,8 +60,6 @@ toc:
url: /insomnia/enterprise-configure-okta-saml
- title: Integrating Insomnia Enterprise with Microsoft Azure/Entra ID SAML 2.0
url: /insomnia/enterprise-configure-azure-saml
- title: Insomnia Whitelisting Guide for Enterprise Users
url: /insomnia/enterprise-ip-whitelist-guide
- title: Transfer enterprise organizations and license
url: /insomnia/transfer-ownership-organization
- title: Insomnia Subscription Plans
Expand Down Expand Up @@ -70,6 +89,10 @@ toc:
url: /insomnia/chaining-requests
- title: Post CSV Data
url: /insomnia/post-csv-data
- title: Environment Variables
url: /insomnia/environment-variables
- title: Global Environments
url: /insomnia/global-environments
- title: SOAP Requests
url: /insomnia/soap-requests
- title: gRPC
Expand Down
19 changes: 15 additions & 4 deletions docs/_includes/sidebar-nav.html
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,22 @@
{% for entry in item.items %}
{% assign currentEntry = entry.url | append: '/' %}
<li class="doc-link ps-3 pb-1 text-start {% if currentEntry == page.url %} list-active {% endif %}">
<a href="{{ entry.url }}">
{{ entry.title }}
</a>
{% if entry.url %}
<a href="{{ entry.url }}">
{{ entry.title }}
</a>
{% endif %}
{% if entry.subfolderitems.size > 0 %}
<div class="collapse {% for subentry in entry.subfolderitems %}{% if page.url contains entry.url %} show {% break %}{% endif %}{% endfor %}">
{% if entry.collapse-id %}
<button class="border-0 align-items-center text-start ps-0 bg-white" data-bs-toggle="collapse" data-bs-target="#{{ entry.collapse-id }}-collapse" aria-expanded="true">
<span>
{{ entry.title }}
</span>
</button>
{% endif %}

{% assign show = entry.subfolderitems | find_exp: 'sub_entry', 'page.url contains sub_entry.url' %}
<div class="collapse {% if show %} show {% endif %}" {% if entry.collapse-id %} id="{{ entry.collapse-id }}-collapse" {% endif %}>
<ul class="list-unstyled">
{% for subentry in entry.subfolderitems %}
{% assign currentSubEntry = subentry.url | append: '/' %}
Expand Down
4 changes: 4 additions & 0 deletions docs/assets/css/styles.scss
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,10 @@ body {
}
}

table {
@extend .table;
}

// logo and icon styling
#inso-logo {
padding-left: 20px;
Expand Down
62 changes: 0 additions & 62 deletions docs/insomnia/enterprise-ip-whitelist-guide.md

This file was deleted.

6 changes: 6 additions & 0 deletions docs/insomnia/get-started/collections/create.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
layout: article-detail
title: Create your first Collection
---

<!-- for rework: needs to include info about how to create collections, what they do, why you'd use them. Should also include a short, easy tutorial where users can try out collections, for example, see https://learning.postman.com/docs/getting-started/first-steps/creating-the-first-collection/ -->
6 changes: 6 additions & 0 deletions docs/insomnia/get-started/collections/pre-request-script.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
layout: article-detail
title: Add a pre-request script
---

<!-- for rework: needs to include info about pre-request scripts for **collections**, what they do, why you'd use them. Should also include a short, easy tutorial where users can try out their first pre-request script, for example, see https://learning.postman.com/docs/tests-and-scripts/write-scripts/pre-request-scripts/#scripting-before-your-request-runs (it should be a simple example, we can explain more examples and use cases and features in a different topic)-->
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
---
layout: article-detail
title: Send Your First Request
category: "Get Started"
category-url: get-started
---
<!-- for rework: needs to include info about requests, what they do, why you'd use them. Should also include a short, easy tutorial where users can try out their first request, for example, see https://learning.postman.com/docs/getting-started/first-steps/sending-the-first-request/ -->

Insomnia is an API client that enables you to send API requests outside of your terminal, and without writing any code. This means you don't have to write any finicky cURL requests or backend code to quickly retrieve information, push content to a database, and do anything else a given API enables you to do.

Expand Down
6 changes: 6 additions & 0 deletions docs/insomnia/get-started/documents/generate-collection.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
layout: article-detail
title: Generate a Collection
---

<!-- for docs rework: Page should be very basic - how to generate a collection and set the required environment variables. You can sort of mimic the style of https://learning.postman.com/docs/getting-started/first-steps/creating-the-first-collection/, but for generating a collection instead of creating one -->
6 changes: 6 additions & 0 deletions docs/insomnia/get-started/documents/pre-request-script.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
layout: article-detail
title: Add a pre-request script
---

<!-- for rework: needs to include info about pre-request scripts for **documents**, what they do, why you'd use them. Should also include a short, easy tutorial where users can try out their first pre-request script, for example, see https://learning.postman.com/docs/tests-and-scripts/write-scripts/pre-request-scripts/#scripting-before-your-request-runs (it should be a simple example, we can explain more examples and use cases and features in a different topic)-->
6 changes: 6 additions & 0 deletions docs/insomnia/get-started/documents/spec.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
layout: article-detail
title: Import an OpenAPI Spec
---

<!-- for rework: this page should contain a very easy, short example of how to import a spec into Insomnia. We should also provide some information in the introduction paragraph about what a spec is and why you'd want to use one or need one. You can use this doc as an example: https://learning.postman.com/docs/integrations/available-integrations/working-with-openAPI -->
6 changes: 6 additions & 0 deletions docs/insomnia/get-started/documents/test.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
layout: article-detail
title: Write your first test
---

<!-- for docs rework: should contain information about tests, why you'd want them, what they do, etc. You can use https://learning.postman.com/docs/getting-started/first-steps/write-your-first-test/ for an example of a short, easy tutorial -->
Original file line number Diff line number Diff line change
@@ -1,10 +1,24 @@
---
layout: article-detail
title: Introduction to Insomnia
category: "Get Started"
category-url: get-started
---

<!--For rework: This page should contain info about Insomnia for those new to it. Tour of the UI and what things are called like Postman's (https://learning.postman.com/docs/getting-started/basics/navigating-postman/). Add a table of features with links to the docs about them (similar to https://docs.konghq.com/gateway/3.7.x/#features).


Proposed outline:

## Introduction to Insomnia

## Navigating Insomnia

add UI screenshot here with boxes around items and a table that references the box numbers and explains what the part of the UI is called and what it does

## Features

| Feature | Free | Enterprise |
| Name of first feature | No | Yes | -->

Insomnia is an open source desktop application that takes the pain out of interacting with and designing, debugging, and testing APIs. Insomnia combines an easy-to-use interface with advanced functionality like authentication helpers, code generation, and environment variables.

![Insomnia client example screenshot](/assets/images/entry-page.png)
Expand Down
Loading