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(Get started rework): Revise the Insomnia allowlist page #227

Merged
merged 3 commits into from
Aug 2, 2024

Conversation

cloudjumpercat
Copy link

Summary

  • revised the existing allowlist page for clarity

Reason

DOCU-3909

Testing

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>
Copy link

vercel bot commented Jul 16, 2024

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

Name Status Preview Comments Updated (UTC)
insomnia-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jul 31, 2024 8:38pm


To fully utilize Insomnia, please ensure the following domains are whitelisted:
| Hostname | Description |
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@fabianrbz I added a table here and a note below like we have in our docs repo, but they aren't quite rendering correctly. I probably don't have to use the note format, I could change it to something else if it's too difficult to add that formatting in this repo. But I'd like to keep the table. Is the table formatting something you could add?

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@cloudjumpercat It's rendering an HTML table, the problem is that it doesn't have any styles applied,
I've pushed a commit to this branch that applies Bootstrap's default table styles to all the tables. Hopefully, that's enough (we can always tweak those).

Let's keep track of all the style differences.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@fabianrbz Thanks!

Let's keep track of all the style differences.

Where would be the best place to keep track of the differences?

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Jira?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@fabianrbz I started documenting the differences in the styling Jira ticket: https://konghq.atlassian.net/browse/DOCU-3897. The table looks good for this doc, so we can just leave the default styling for now in this PR and if you want to make any adjustments in another PR/the styling PR, that would work!

@@ -3,60 +3,29 @@ layout: article-detail
title: Allowlist for Insomnia
---

<!-- for docs rework: revise this page like we normally would -->
For enterprise users utilizing Insomnia, it's crucial to ensure that specific domains are allowlisted in your network. This step is essential to guarantee that all features of Insomnia, including updates, synchronization, documentation, and necessary backend services work without any hindrance in environments with restricted internet access.
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@filfreire I didn't edit this paragraph yet because I wanted to double check with you first: this doc applies to any users who have restricted internet access, right? Not just enterprise customers?

@CLAassistant
Copy link

CLAassistant commented Jul 17, 2024

CLA assistant check
All committers have signed the CLA.

@CLAassistant
Copy link

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you all sign our Contributor License Agreement before we can accept your contribution.
1 out of 2 committers have signed the CLA.

✅ cloudjumpercat
❌ fabianrbz
You have signed the CLA already but the status is still pending? Let us recheck it.

Copy link
Contributor

@lmilan lmilan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@@ -3,60 +3,29 @@ layout: article-detail
title: Allowlist for Insomnia
---

<!-- for docs rework: revise this page like we normally would -->
For enterprise users utilizing Insomnia, it's crucial to ensure that specific domains are allowlisted in your network. This step is essential to guarantee that all features of Insomnia, including updates, synchronization, documentation, and necessary backend services work without any hindrance in environments with restricted internet access.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't really see the value in this paragraph. I think it should just kind of introduce the table.


## Introduction
If you have issues after allowlisting Insomnia hostnames, contact your IT support or reach out to Insomnia's customer service at <support@insomnia.rest> or <https://support.konghq.com/support/s/>.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this shoudl go after the table.


Whitelisting these domains ensures uninterrupted access to all functionalities of Insomnia, including updates, documentation, and necessary backend services. Should you experience issues post-whitelisting, it's advisable to seek assistance from your IT support or reach out to Insomnia's customer service at <support@insomnia.rest> OR <https://support.konghq.com/support/s/>.
{:.note}
> **Individual Insomnia users:** If you’re an individual user, ask your IT department to allowlist these hostnames to enable full functionality of Insomnia in your workspace.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there another way to describe 'individual user'?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Guaris After making your other suggestions, I realized we didn't need this note because the doc implies that everyone needs to allowlist these.

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>
@cloudjumpercat cloudjumpercat merged commit 96d853a into docs/get-started-section Aug 2, 2024
3 checks passed
@cloudjumpercat cloudjumpercat deleted the docs/allowlist branch August 2, 2024 16:59
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.

None yet

5 participants