From 223f40246415507eaeff19adbb764eece2c955a1 Mon Sep 17 00:00:00 2001 From: Diana <75819066+cloudjumpercat@users.noreply.github.com> Date: Mon, 8 Jul 2024 16:09:55 -0500 Subject: [PATCH 1/8] Create placeholder Get Started section, create placeholder pages for new docs, move existing docs to the correct spot Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com> --- docs/_data/main-nav.yaml | 47 ++++++++++++++----- .../get-started/collections/create.md | 8 ++++ .../collections/pre-request-script.md | 8 ++++ .../collections}/send-your-first-request.md | 1 + .../documents/generate-collection.md | 8 ++++ .../documents/pre-request-script.md | 8 ++++ docs/insomnia/get-started/documents/spec.md | 8 ++++ docs/insomnia/get-started/documents/test.md | 8 ++++ .../{get-started.md => get-started/index.md} | 16 +++++++ docs/insomnia/{ => get-started}/install.md | 2 + .../mock-server/allowlist.md} | 8 ++-- .../mock-server}/import-export-data.md | 4 +- .../{ => get-started/mock-server}/proxy.md | 4 +- 13 files changed, 113 insertions(+), 17 deletions(-) create mode 100644 docs/insomnia/get-started/collections/create.md create mode 100644 docs/insomnia/get-started/collections/pre-request-script.md rename docs/insomnia/{ => get-started/collections}/send-your-first-request.md (91%) create mode 100644 docs/insomnia/get-started/documents/generate-collection.md create mode 100644 docs/insomnia/get-started/documents/pre-request-script.md create mode 100644 docs/insomnia/get-started/documents/spec.md create mode 100644 docs/insomnia/get-started/documents/test.md rename docs/insomnia/{get-started.md => get-started/index.md} (80%) rename docs/insomnia/{ => get-started}/install.md (98%) rename docs/insomnia/{enterprise-ip-whitelist-guide.md => get-started/mock-server/allowlist.md} (94%) rename docs/insomnia/{ => get-started/mock-server}/import-export-data.md (96%) rename docs/insomnia/{ => get-started/mock-server}/proxy.md (88%) diff --git a/docs/_data/main-nav.yaml b/docs/_data/main-nav.yaml index 888233b..29ab99d 100644 --- a/docs/_data/main-nav.yaml +++ b/docs/_data/main-nav.yaml @@ -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 + items: + - 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 + items: + - 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 + items: + - 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: @@ -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 @@ -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 diff --git a/docs/insomnia/get-started/collections/create.md b/docs/insomnia/get-started/collections/create.md new file mode 100644 index 0000000..01acea5 --- /dev/null +++ b/docs/insomnia/get-started/collections/create.md @@ -0,0 +1,8 @@ +--- +layout: article-detail +title: Create your first Collection +category: "Get Started" +category-url: get-started +--- + + \ No newline at end of file diff --git a/docs/insomnia/get-started/collections/pre-request-script.md b/docs/insomnia/get-started/collections/pre-request-script.md new file mode 100644 index 0000000..8f2d5d6 --- /dev/null +++ b/docs/insomnia/get-started/collections/pre-request-script.md @@ -0,0 +1,8 @@ +--- +layout: article-detail +title: Add a pre-request script +category: "Get Started" +category-url: get-started +--- + + \ No newline at end of file diff --git a/docs/insomnia/send-your-first-request.md b/docs/insomnia/get-started/collections/send-your-first-request.md similarity index 91% rename from docs/insomnia/send-your-first-request.md rename to docs/insomnia/get-started/collections/send-your-first-request.md index 24512f6..f36efd1 100644 --- a/docs/insomnia/send-your-first-request.md +++ b/docs/insomnia/get-started/collections/send-your-first-request.md @@ -4,6 +4,7 @@ title: Send Your First Request category: "Get Started" category-url: get-started --- + 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. diff --git a/docs/insomnia/get-started/documents/generate-collection.md b/docs/insomnia/get-started/documents/generate-collection.md new file mode 100644 index 0000000..4e9d9e5 --- /dev/null +++ b/docs/insomnia/get-started/documents/generate-collection.md @@ -0,0 +1,8 @@ +--- +layout: article-detail +title: Generate a Collection +category: "Get Started" +category-url: get-started +--- + + \ No newline at end of file diff --git a/docs/insomnia/get-started/documents/pre-request-script.md b/docs/insomnia/get-started/documents/pre-request-script.md new file mode 100644 index 0000000..b9b997b --- /dev/null +++ b/docs/insomnia/get-started/documents/pre-request-script.md @@ -0,0 +1,8 @@ +--- +layout: article-detail +title: Add a pre-request script +category: "Get Started" +category-url: get-started +--- + + \ No newline at end of file diff --git a/docs/insomnia/get-started/documents/spec.md b/docs/insomnia/get-started/documents/spec.md new file mode 100644 index 0000000..609f734 --- /dev/null +++ b/docs/insomnia/get-started/documents/spec.md @@ -0,0 +1,8 @@ +--- +layout: article-detail +title: Import an OpenAPI Spec +category: "Get Started" +category-url: get-started +--- + + \ No newline at end of file diff --git a/docs/insomnia/get-started/documents/test.md b/docs/insomnia/get-started/documents/test.md new file mode 100644 index 0000000..62c4448 --- /dev/null +++ b/docs/insomnia/get-started/documents/test.md @@ -0,0 +1,8 @@ +--- +layout: article-detail +title: Write your first test +category: "Get Started" +category-url: get-started +--- + + \ No newline at end of file diff --git a/docs/insomnia/get-started.md b/docs/insomnia/get-started/index.md similarity index 80% rename from docs/insomnia/get-started.md rename to docs/insomnia/get-started/index.md index f91e725..74048cc 100644 --- a/docs/insomnia/get-started.md +++ b/docs/insomnia/get-started/index.md @@ -5,6 +5,22 @@ category: "Get Started" category-url: get-started --- + + 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) diff --git a/docs/insomnia/install.md b/docs/insomnia/get-started/install.md similarity index 98% rename from docs/insomnia/install.md rename to docs/insomnia/get-started/install.md index e1a1169..7178d66 100644 --- a/docs/insomnia/install.md +++ b/docs/insomnia/get-started/install.md @@ -5,6 +5,8 @@ category: "Get Started" category-url: get-started --- + + Insomnia is available on macOS, Windows, and Linux. If you haven't already downloaded Insomnia, visit the [Download Page](https://insomnia.rest/download).