diff --git a/documentation/develop.mdx b/documentation/develop.mdx index c6c2589d..bab42635 100644 --- a/documentation/develop.mdx +++ b/documentation/develop.mdx @@ -35,7 +35,7 @@ Please note we have a [code of conduct](/support/code-of-conduct), please follow 3. Increase the version numbers in any examples files and the README.md to the new version that this Pull Request would represent. The versioning scheme we use is [SemVer](https://semver.org). 4. You may merge the Pull Request once you have the sign-off of two other developers, or if you - do not have permission to do that, you may request the second reviewer merge it for you. + do not have permission to do that, you may request the second reviewer to merge it for you. ## **Developing** @@ -81,7 +81,7 @@ We use GitHub issues to track public bugs. Report a bug by [opening a new issue] - Steps to reproduce - Be specific! - Give a sample code if you can. -- What you expected would happen +- What did you expect would happen - What happens - Notes (possibly including why you think this might be happening, or stuff you tried that didn't work) @@ -92,7 +92,7 @@ People love thorough bug reports. I'm not even kidding. I'm again borrowing these from [Facebook's Guidelines](https://reactjs.org/docs/how-to-contribute.html) - 2 spaces for indentation rather than tabs -- You can try using Eslint code extensions in vs code or something similar. +- You can try using Eslint code extensions in VS Code or something similar. ## Recommended VS Code extensions diff --git a/documentation/features/authorization.mdx b/documentation/features/authorization.mdx index 528ac743..9b009e32 100644 --- a/documentation/features/authorization.mdx +++ b/documentation/features/authorization.mdx @@ -100,7 +100,7 @@ When using OAuth 2.0 with Hoppscotch Cloud, the **callback URL** is fixed to `ht ## Digest -Digest Auth is a way to verify your identity without transmitting plain text passwords. Instead of sending your credentials directly as plain-text, it uses a challenge-response system to keep your information safe. When you attempt to access a restricted resource, the server responds with a `401 Unauthorized` status and a `WWW-Authenticate` header. This header contains essential information, including a unique challenge that you will use to generate a valid response. +Digest Auth is a way to verify your identity without transmitting plain-text passwords. Instead of sending your credentials directly as plain-text, it uses a challenge-response system to keep your information safe. When you attempt to access a restricted resource, the server responds with a `401 Unauthorized` status and a `WWW-Authenticate` header. This header contains essential information, including a unique challenge that you will use to generate a valid response. To configure Digest Auth in Hoppscotch, start by entering your **Username** and **Password**. For added security, you can also provide optional parameters like Realm and Nonce from the `WWW-Authenticate` header. Choose the appropriate **Algorithm** for hashing and define the **Quality of Protection (QoP)** to further secure your requests. You can also specify parameters such as **Nonce Count**, **Client Nonce**, and **Opaque** to further bolster the authentication process. @@ -121,4 +121,4 @@ When managing multiple requests within a collection, setting identical authoriza - Right-click on a collection or a subfolder within a collection to open its **properties**. - Specify the authorization that all nested requests or folders should adhere to. -- If a subfolder should inherit the properties of a parent collection, specify the authorization as `inherit`. \ No newline at end of file +- If a subfolder should inherit the properties of a parent collection, specify the authorization as `inherit`. diff --git a/documentation/features/interceptor.mdx b/documentation/features/interceptor.mdx index 2d95ebef..92043b39 100644 --- a/documentation/features/interceptor.mdx +++ b/documentation/features/interceptor.mdx @@ -47,7 +47,7 @@ You can access APIs blocked by `Cross-Origin Resource Sharing (CORS)` restrictio Once connected, all API requests made through the Hoppscotch web app will be routed through Hoppscotch agent, effectively eliminating CORS-related issues. - Recommended interceptor for most users as it is compaitble with all platforms. + Recommended interceptor for most users as it is compatible with all platforms. ## Proxy @@ -237,4 +237,4 @@ You can access APIs blocked by `Cross-Origin Resource Sharing (CORS)` restrictio ### Origins The origin list defines the URLs that the extension can connect to. If you're using hoppscotch.io, then you do not need to add any other origins. However, if you are using a self-hosted instance, you should add the domain of your self-hosted instance as an active origin. - \ No newline at end of file + diff --git a/documentation/features/pat.mdx b/documentation/features/pat.mdx index 8a50f3f5..642d64df 100644 --- a/documentation/features/pat.mdx +++ b/documentation/features/pat.mdx @@ -11,7 +11,7 @@ allowing you to smoothly link your Hoppscotch API client, on Hoppscotch cloud or Follow these steps to create a new token, manage its settings. Personal access tokens cannot be used to access data in your personal workspace. -1. Login into the Hoppscotch API client using your credentials. +1. Login to the Hoppscotch API client using your credentials. 2. Once logged in, navigate to your profile settings by clicking on your profile icon, located in the top right corner of the screen. @@ -35,4 +35,4 @@ Follow these steps to create a new token, manage its settings. Personal access t In Self-Hosted Enterprise settings, users with Admin privileges have additional capabilities for managing Personal Access Tokens (PATs). 1. Admin can **oversee and manage** tokens generated by all users within the enterprise environment. -2. An Admin also possesses the **authority to delete** tokens under their purview. This capability ensures compliance with security protocols and allows for the removal of tokens that are no longer necessary or have expired. \ No newline at end of file +2. An Admin also possesses the **authority to delete** tokens under their purview. This capability ensures compliance with security protocols and allows for the removal of tokens that are no longer necessary or have expired. diff --git a/documentation/features/spotlight.mdx b/documentation/features/spotlight.mdx index 4b573127..29b9237a 100644 --- a/documentation/features/spotlight.mdx +++ b/documentation/features/spotlight.mdx @@ -10,7 +10,7 @@ Spotlight is an innovative feature introduced in Hoppscotch, designed to enhance ## Activation -To activate the Spotlight search functionality, you can employ the following key combinations based on their operating systems: +To activate the Spotlight search functionality, you can employ the following key combinations based on your operating system: * On macOS: Press `Cmd` + `K` * On Windows or Linux: Press `Ctrl` + `K` @@ -24,7 +24,7 @@ Upon triggering the Spotlight search, a search field will be displayed, allowing Spotlight not only offers dynamic suggestions but also facilitates their navigation and selection. The presented suggestions are ranked by relevance, enabling you to easily identify your desired options. Navigation can be achieved through: * Arrow keys: Use the arrow keys to move through the suggestions. -* Enter key: Press the enter key to select the highlighted suggestion. +* Enter key: Press the Enter key to select the highlighted suggestion. Alternatively, you can achieve the same functionality using the mouse or trackpad. diff --git a/documentation/features/workspaces.mdx b/documentation/features/workspaces.mdx index 69610585..3ba5e142 100644 --- a/documentation/features/workspaces.mdx +++ b/documentation/features/workspaces.mdx @@ -18,7 +18,7 @@ Creating a workspace makes you the owner of the workspace. You can invite other ## Invite users to a workspace -To invite users to a workspace, click on the "**Invite**" button and enter the email address of the user you want to invite. You can invite multiple users at once by adding the email addresses in the input field entries. +To invite users to a workspace, click on the "**Invite**" button and enter the email address of the user you want to invite. You can invite multiple users at once by adding the email addresses in the input field. ## Switch between workspaces diff --git a/documentation/getting-started/rest/organizing-requests.mdx b/documentation/getting-started/rest/organizing-requests.mdx index 8c6e6478..1928fdbb 100644 --- a/documentation/getting-started/rest/organizing-requests.mdx +++ b/documentation/getting-started/rest/organizing-requests.mdx @@ -4,7 +4,7 @@ title: Organizing requests description: Organize your requests categorically for future reference or collaboration with your team using collections. --- -It is always a best practice to organize your requests when you test multiple API endpoints. You can organize your requests categorically for future reference or collaboration with your team using collections. +It is always best practice to organize your requests when you test multiple API endpoints. You can organize your requests categorically for future reference or collaboration with your team using collections. You can create a new collection on Hoppscotch by clicking the collections icon on the sidebar and clicking the "**+ New**" button. diff --git a/documentation/getting-started/rest/response-handling.mdx b/documentation/getting-started/rest/response-handling.mdx index 1dc12c0d..c0a4ef81 100644 --- a/documentation/getting-started/rest/response-handling.mdx +++ b/documentation/getting-started/rest/response-handling.mdx @@ -13,7 +13,7 @@ Hoppscotch uplifts this experience by providing an intuitive interface for analy Depending on the content type of the response, Hoppscotch automatically presents the data in the appropriate format: - **JSON:** Formats the response in a structured JSON format for easy readability. -- **HTML:** Renders the response as HTML for visual representation and structure content as a web page. +- **HTML:** Renders the response as HTML for visual representation and structures content as a web page. - **XML:** Shows the response in XML format for compatibility with XML-based APIs. - **Image:** Displays image responses directly in the interface. @@ -112,4 +112,4 @@ To copy the entire response to the clipboard, simply click the **"Copy"** button ## **Generate Data Schema** -Using the **"More"** menu, you can generate a structured representation of the response data tailored to specific programming languages. You can **download the file** or **copy the response** in languages like TypeScript, C#, Go, and others, making it simpler for you to incorporate API responses into your applications. \ No newline at end of file +Using the **"More"** menu, you can generate a structured representation of the response data tailored to specific programming languages. You can **download the file** or **copy the response** in languages like TypeScript, C#, Go, and others, making it simpler for you to incorporate API responses into your applications. diff --git a/documentation/getting-started/troubleshooting.mdx b/documentation/getting-started/troubleshooting.mdx index 9aef5c77..d50549b0 100644 --- a/documentation/getting-started/troubleshooting.mdx +++ b/documentation/getting-started/troubleshooting.mdx @@ -8,7 +8,7 @@ If you're facing issues with Hoppscotch, you can try the following steps to reso ## Connectivity -If Hoppscotch fails to send your request, it could be because you may be experiencing connectivity issues. Check your connection by attempting to open a page in your web browser. +If Hoppscotch fails to send your request, it could be because you are experiencing connectivity issues. Check your connection by attempting to open a page in your web browser. ## Firewalls @@ -26,7 +26,7 @@ It could also be possible that Hoppscotch might be making invalid requests to yo CORS or Cross-Origin Resource Sharing is a security mechanism built into modern web browsers. It may cause the following error when testing API endpoints or some other API endpoints with Hoppscotch. -This is because the API not sending the proper API headers (`Access-Control-Allow-Origin`) and can be solved in two ways. +This is because the API is not sending the proper API headers (`Access-Control-Allow-Origin`) and can be solved in two ways. 1. Ask whoever manages the API to add CORS support. 2. Use Middleware like [ProxyScotch](https://github.com/hoppscotch/proxyscotch) for hosted APIs & the [Hoppscotch Browser Extension](https://github.com/hoppscotch/hoppscotch-extension) for locally served APIs, and enable it in the "**Interceptor**" section of "**Settings**". diff --git a/documentation/self-host/community-edition/install-and-build.mdx b/documentation/self-host/community-edition/install-and-build.mdx index 3b88b1d8..66cd7049 100644 --- a/documentation/self-host/community-edition/install-and-build.mdx +++ b/documentation/self-host/community-edition/install-and-build.mdx @@ -35,7 +35,7 @@ SESSION_SECRET=anothersecretcode123 # Note: Some auth providers may not support http requests ALLOW_SECURE_COOKIES=true -# Sensitive Data Encryption Key while storing in Database (32 character) +# Sensitive Data Encryption Key while storing in Database (32 characters) DATA_ENCRYPTION_KEY=******************************** # Hoppscotch App Domain Config @@ -75,7 +75,7 @@ MAILER_USE_CUSTOM_CONFIGS=false MAILER_ADDRESS_FROM= MAILER_SMTP_URL=smtps://user@domain.com:pass@smtp.domain.com # used if custom mailer configs is false -# The following are used if custom mailer configs is true +# The following are used if custom mailer configs are true MAILER_SMTP_HOST=smtp.domain.com MAILER_SMTP_PORT=587 MAILER_SMTP_SECURE=true diff --git a/documentation/self-host/community-edition/telemetry.mdx b/documentation/self-host/community-edition/telemetry.mdx index 2f4a4759..bcc0f844 100644 --- a/documentation/self-host/community-edition/telemetry.mdx +++ b/documentation/self-host/community-edition/telemetry.mdx @@ -45,4 +45,4 @@ The instance usage ping is sent once a week to indicate that the instance is ope # Turning off data sharing -You can turn off your data sharing preferences from your Hoppscotch admin dashboard and heading over to the Data Sharing section in the settings page \ No newline at end of file +You can turn off your data sharing preferences from your Hoppscotch admin dashboard and head over to the Data Sharing section in the settings page diff --git a/documentation/self-host/enterprise-edition/activity-logs.mdx b/documentation/self-host/enterprise-edition/activity-logs.mdx index 9906bd32..5f1371b0 100644 --- a/documentation/self-host/enterprise-edition/activity-logs.mdx +++ b/documentation/self-host/enterprise-edition/activity-logs.mdx @@ -36,7 +36,7 @@ Activity Logs track the following actions within the workspace: | **Action** | **Logged Activity Example** | | ---------------------------------- | ------------------------------------------------------- | -| Creating a new workspace | `Created` new workspace `Statging` | +| Creating a new workspace | `Created` new workspace `Staging` | | Renaming a Workspace | `Renamed` workspace from `Staging` to `Production` | | Adding a user to the workspace | John Doe was `added` to the workspace as `Viewer` | | Updating a user's role in workspace| John Doe's role was `updated` from `Viewer` to `Editor` | @@ -67,4 +67,4 @@ Each log entry provides detailed information about the recorded action, includin - **Timestamp:** The exact time when the action occurred. - **Action Summary:** A summary of changes made in the operation. -- **User Information:** The name of the user who performed the action. \ No newline at end of file +- **User Information:** The name of the user who performed the action. diff --git a/documentation/self-host/enterprise-edition/admin-dashboard.mdx b/documentation/self-host/enterprise-edition/admin-dashboard.mdx index 4d35ac5f..d737f5a3 100644 --- a/documentation/self-host/enterprise-edition/admin-dashboard.mdx +++ b/documentation/self-host/enterprise-edition/admin-dashboard.mdx @@ -156,7 +156,7 @@ In the **Server Settings** section, you have the ability to both view and edit t Configure your SMTP settings for seamless email integration. 4. **Configure SAML Settings:** - Configure your SAML settings for your SAML based Single sign on. + Configure your SAML settings for your SAML based Single Sign-On. 5. **Configure OIDC Settings:** Configure your OIDC Settings for Single Sign-On based authentication. @@ -214,4 +214,4 @@ If you need to perform a hard reset of the server configurations, execute the fo docker exec -it psql -d hoppscotch -c "TRUNCATE \"InfraConfig\";" ``` -You can replace `` with the actual ID of your Docker container. \ No newline at end of file +You can replace `` with the actual ID of your Docker container. diff --git a/documentation/self-host/enterprise-edition/install-and-build.mdx b/documentation/self-host/enterprise-edition/install-and-build.mdx index 458cf68b..449e30da 100644 --- a/documentation/self-host/enterprise-edition/install-and-build.mdx +++ b/documentation/self-host/enterprise-edition/install-and-build.mdx @@ -52,7 +52,7 @@ SESSION_SECRET=anothersecretcode123 # Note: Some auth providers may not support http requests ALLOW_SECURE_COOKIES=true -# Sensitive Data Encryption Key while storing in Database (32 character) +# Sensitive Data Encryption Key while storing in Database (32 characters) DATA_ENCRYPTION_KEY=******************************** # Hoppscotch App Domain Config @@ -122,9 +122,9 @@ OIDC_SCOPE=openid profile email MAILER_SMTP_ENABLE=true MAILER_USE_CUSTOM_CONFIGS=false MAILER_ADDRESS_FROM= -MAILER_SMTP_URL=smtps://user@domain.com:pass@smtp.domain.com # used if custom mailer configs is false +MAILER_SMTP_URL=smtps://user@domain.com:pass@smtp.domain.com # used if custom mailer configs are false -# The following are used if custom mailer configs is true +# The following are used if custom mailer configs are true MAILER_SMTP_HOST=smtp.domain.com MAILER_SMTP_PORT=587 MAILER_SMTP_SECURE=true diff --git a/guides/articles/self-host-hoppscotch-on-your-own-servers.mdx b/guides/articles/self-host-hoppscotch-on-your-own-servers.mdx index 0cbae329..bcef486b 100644 --- a/guides/articles/self-host-hoppscotch-on-your-own-servers.mdx +++ b/guides/articles/self-host-hoppscotch-on-your-own-servers.mdx @@ -47,7 +47,7 @@ SESSION_SECRET=anothersecretcode123 # Note: Some auth providers may not support http requests and may stop working when set to false. ALLOW_SECURE_COOKIES=true -# Sensitive Data Encryption Key while storing in Database (32 character) +# Sensitive Data Encryption Key while storing in Database (32 characters) DATA_ENCRYPTION_KEY=******************************** # Hoppscotch App Domain Config @@ -79,7 +79,7 @@ MAILER_SMTP_ENABLE=true MAILER_USE_CUSTOM_CONFIGS=false MAILER_ADDRESS_FROM= MAILER_SMTP_URL=smtps://user@domain.com:pass@smtp.domain.com # used if custom mailer configs is false -# The following are used if custom mailer configs is true +# The following are used if custom mailer configs are true MAILER_SMTP_HOST=smtp.domain.com MAILER_SMTP_PORT=587 MAILER_SMTP_SECURE=true