From e78bf8bc62724b95b3c1405a3663c0643177017e Mon Sep 17 00:00:00 2001 From: Anudeep Date: Thu, 28 Mar 2024 23:57:59 +0530 Subject: [PATCH] feat: docs env --- docs/.vitepress/config.ts | 2 +- docs/guides/component-testing.md | 2 +- docs/guides/contract-testing.md | 2 +- docs/guides/environment-variables.md | 4 ++-- docs/index.md | 2 +- docs/media/blogs.md | 1 + docs/media/videos.md | 1 + 7 files changed, 8 insertions(+), 6 deletions(-) diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts index 7a067085..adc82aae 100644 --- a/docs/.vitepress/config.ts +++ b/docs/.vitepress/config.ts @@ -298,7 +298,7 @@ const config = defineConfig({ }, footer: { message: 'Released under the MIT License.', - copyright: 'Copyright © 2023' + copyright: 'Copyright © 2024' }, }, markdown: { diff --git a/docs/guides/component-testing.md b/docs/guides/component-testing.md index cf04274f..c1557092 100644 --- a/docs/guides/component-testing.md +++ b/docs/guides/component-testing.md @@ -2,7 +2,7 @@ Component testing is defined as a software testing type, in which the testing is performed on each component (or service) separately without integrating with other components (or services). -These tests are all about testing the functionality of individual service. During this, your service will be trying to interact with external services. But instead of talking to real external services, they talk to mock servers and local databases. +These tests are all about testing the functionality of individual service. During this, your service will be trying to interact with external services. But instead of communicating with real external services, they interact with mock servers and local databases. ::: tip TIP [Docker](https://www.docker.com) is great place to test your applications in isolation. diff --git a/docs/guides/contract-testing.md b/docs/guides/contract-testing.md index d639678d..0468ea07 100644 --- a/docs/guides/contract-testing.md +++ b/docs/guides/contract-testing.md @@ -177,5 +177,5 @@ To access the backend API (swagger page), navigate to [http://localhost:8080/api - Compatibility Results ::: warning WARNING -Contract Testing is still in experimental phase. We are expecting it to be officially supported in the second quarter of **2022**. 🤞 +Contract Testing is still in beta phase. ::: \ No newline at end of file diff --git a/docs/guides/environment-variables.md b/docs/guides/environment-variables.md index 455fd7a8..85871718 100644 --- a/docs/guides/environment-variables.md +++ b/docs/guides/environment-variables.md @@ -1,6 +1,6 @@ # Environment Variables -PactumJS supports setting default values to configuration parameters via Environment variables. +PactumJS allows configurations to be defined through environment variables. ## List of Environment Variables @@ -27,7 +27,7 @@ export PACTUM_MOCK_PORT=9001 export PACTUM_REQUEST_BASE_URL=https://example.com ``` -Adding to .env file +Adding to `.env` file and read it through [dotenv](https://www.npmjs.com/package/dotenv) package. ```sh # contents in .env file diff --git a/docs/index.md b/docs/index.md index 6e1ff9bf..8eca7ea3 100644 --- a/docs/index.md +++ b/docs/index.md @@ -21,7 +21,7 @@ features: details: Rich set of features to test complex scenarios yet wrapped inside a lightweight npm package. - title: 🧪 Clear & Comprehensive details: Clear and simple API to write readable and maintainable component, contract and end-to-end integration tests. -footer: MIT Licensed | Copyright © 2023 +footer: MIT Licensed | Copyright © 2024 ---