From e339789173e64f4eacca76492175edbd674e6334 Mon Sep 17 00:00:00 2001 From: zjpersc Date: Sat, 25 Feb 2023 00:10:13 -0600 Subject: [PATCH 1/8] Add global-agent to dependencies; Update Readme w/ instructions Signed-off-by: zjpersc --- packages/techdocs-cli/README.md | 7 +++++++ packages/techdocs-cli/package.json | 1 + 2 files changed, 8 insertions(+) diff --git a/packages/techdocs-cli/README.md b/packages/techdocs-cli/README.md index ae296d2c26..e6ba03e1d0 100644 --- a/packages/techdocs-cli/README.md +++ b/packages/techdocs-cli/README.md @@ -40,6 +40,13 @@ yarn start yarn techdocs-cli:dev [...options] ``` +### Connecting behind a proxy +```sh +# Prior to executing the techdocs-cli command +export GLOBAL_AGENT_HTTPS_PROXY=${HTTP_PROXY} +export GLOBAL_AGENT_NO_PROXY=${NO_PROXY} +``` + ### Using an example docs project For the purpose of local development, we have created an example documentation project. You are of course also free to create your own local test site - all it takes is a `docs/index.md` and an `mkdocs.yml` in a directory. diff --git a/packages/techdocs-cli/package.json b/packages/techdocs-cli/package.json index 0a3bbed06f..371ddf440f 100644 --- a/packages/techdocs-cli/package.json +++ b/packages/techdocs-cli/package.json @@ -69,6 +69,7 @@ "commander": "^9.1.0", "dockerode": "^3.3.1", "fs-extra": "^10.0.1", + "global-agent": "^3.0.0", "http-proxy": "^1.18.1", "react-dev-utils": "^12.0.0-next.60", "serve-handler": "^6.1.3", From 7b4991adb9f1b2bc86b4a3e490de22472c2d5398 Mon Sep 17 00:00:00 2001 From: zjpersc Date: Sat, 25 Feb 2023 00:37:06 -0600 Subject: [PATCH 2/8] Adding changeset Signed-off-by: zjpersc --- .changeset/short-panthers-float.md | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 .changeset/short-panthers-float.md diff --git a/.changeset/short-panthers-float.md b/.changeset/short-panthers-float.md new file mode 100644 index 0000000000..91eafe28aa --- /dev/null +++ b/.changeset/short-panthers-float.md @@ -0,0 +1,5 @@ +--- +'@techdocs/cli': patch +--- + +Adding global-agent to enable the ability to publish through a proxy From 8af3a93d07c213b1f2b432504491ea20d1455233 Mon Sep 17 00:00:00 2001 From: zjpersc Date: Sun, 26 Feb 2023 20:40:13 -0600 Subject: [PATCH 3/8] Revert "Adding changeset" This reverts commit b83d77e1bc7b608b0478d3de91c2080a9d153872. Signed-off-by: zjpersc --- .changeset/short-panthers-float.md | 5 ----- 1 file changed, 5 deletions(-) delete mode 100644 .changeset/short-panthers-float.md diff --git a/.changeset/short-panthers-float.md b/.changeset/short-panthers-float.md deleted file mode 100644 index 91eafe28aa..0000000000 --- a/.changeset/short-panthers-float.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'@techdocs/cli': patch ---- - -Adding global-agent to enable the ability to publish through a proxy From 1093f1b1cd62741029400aba24ec51b7d7121e55 Mon Sep 17 00:00:00 2001 From: zjpersc Date: Sun, 26 Feb 2023 20:40:21 -0600 Subject: [PATCH 4/8] Revert "Add global-agent to dependencies; Update Readme w/ instructions" This reverts commit 39f5a8389b8ff4afcb18fb19a0ca20d2552abc83. Signed-off-by: zjpersc --- packages/techdocs-cli/README.md | 7 ------- packages/techdocs-cli/package.json | 1 - 2 files changed, 8 deletions(-) diff --git a/packages/techdocs-cli/README.md b/packages/techdocs-cli/README.md index e6ba03e1d0..ae296d2c26 100644 --- a/packages/techdocs-cli/README.md +++ b/packages/techdocs-cli/README.md @@ -40,13 +40,6 @@ yarn start yarn techdocs-cli:dev [...options] ``` -### Connecting behind a proxy -```sh -# Prior to executing the techdocs-cli command -export GLOBAL_AGENT_HTTPS_PROXY=${HTTP_PROXY} -export GLOBAL_AGENT_NO_PROXY=${NO_PROXY} -``` - ### Using an example docs project For the purpose of local development, we have created an example documentation project. You are of course also free to create your own local test site - all it takes is a `docs/index.md` and an `mkdocs.yml` in a directory. diff --git a/packages/techdocs-cli/package.json b/packages/techdocs-cli/package.json index 371ddf440f..0a3bbed06f 100644 --- a/packages/techdocs-cli/package.json +++ b/packages/techdocs-cli/package.json @@ -69,7 +69,6 @@ "commander": "^9.1.0", "dockerode": "^3.3.1", "fs-extra": "^10.0.1", - "global-agent": "^3.0.0", "http-proxy": "^1.18.1", "react-dev-utils": "^12.0.0-next.60", "serve-handler": "^6.1.3", From b348420a804d69047c98aea9743292c9156e4e3e Mon Sep 17 00:00:00 2001 From: zjpersc Date: Sun, 26 Feb 2023 20:44:08 -0600 Subject: [PATCH 5/8] Adding global-agent to dependencies; updated README w/ instructions Signed-off-by: zjpersc --- .changeset/short-panthers-float.md | 5 +++++ packages/techdocs-cli/README.md | 7 +++++++ packages/techdocs-cli/package.json | 1 + 3 files changed, 13 insertions(+) create mode 100644 .changeset/short-panthers-float.md diff --git a/.changeset/short-panthers-float.md b/.changeset/short-panthers-float.md new file mode 100644 index 0000000000..41ec71a7aa --- /dev/null +++ b/.changeset/short-panthers-float.md @@ -0,0 +1,5 @@ +--- +'@techdocs/cli': patch +--- + +Adding global-agent to enable the ability to publish through a proxy \ No newline at end of file diff --git a/packages/techdocs-cli/README.md b/packages/techdocs-cli/README.md index ae296d2c26..e6ba03e1d0 100644 --- a/packages/techdocs-cli/README.md +++ b/packages/techdocs-cli/README.md @@ -40,6 +40,13 @@ yarn start yarn techdocs-cli:dev [...options] ``` +### Connecting behind a proxy +```sh +# Prior to executing the techdocs-cli command +export GLOBAL_AGENT_HTTPS_PROXY=${HTTP_PROXY} +export GLOBAL_AGENT_NO_PROXY=${NO_PROXY} +``` + ### Using an example docs project For the purpose of local development, we have created an example documentation project. You are of course also free to create your own local test site - all it takes is a `docs/index.md` and an `mkdocs.yml` in a directory. diff --git a/packages/techdocs-cli/package.json b/packages/techdocs-cli/package.json index 0a3bbed06f..371ddf440f 100644 --- a/packages/techdocs-cli/package.json +++ b/packages/techdocs-cli/package.json @@ -69,6 +69,7 @@ "commander": "^9.1.0", "dockerode": "^3.3.1", "fs-extra": "^10.0.1", + "global-agent": "^3.0.0", "http-proxy": "^1.18.1", "react-dev-utils": "^12.0.0-next.60", "serve-handler": "^6.1.3", From 9796fe16d731856b4e4d59bf66f7cafcafccdef1 Mon Sep 17 00:00:00 2001 From: zjpersc Date: Tue, 7 Mar 2023 14:31:34 -0600 Subject: [PATCH 6/8] Updating techdocs-cli dependency on global-agent@3.0.0 in yarn.lock Signed-off-by: zjpersc --- yarn.lock | 1 + 1 file changed, 1 insertion(+) diff --git a/yarn.lock b/yarn.lock index 6973779ac5..b335996073 100644 --- a/yarn.lock +++ b/yarn.lock @@ -13923,6 +13923,7 @@ __metadata: dockerode: ^3.3.1 find-process: ^1.4.5 fs-extra: ^10.0.1 + global-agent: ^3.0.0 http-proxy: ^1.18.1 nodemon: ^2.0.2 react-dev-utils: ^12.0.0-next.60 From 6620edc944c17302739b8717f8265d099075984b Mon Sep 17 00:00:00 2001 From: zjpersc Date: Tue, 7 Mar 2023 17:07:57 -0600 Subject: [PATCH 7/8] Fixing prettier errors Signed-off-by: zjpersc --- .changeset/short-panthers-float.md | 2 +- packages/techdocs-cli/README.md | 3 ++- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/.changeset/short-panthers-float.md b/.changeset/short-panthers-float.md index 41ec71a7aa..91eafe28aa 100644 --- a/.changeset/short-panthers-float.md +++ b/.changeset/short-panthers-float.md @@ -2,4 +2,4 @@ '@techdocs/cli': patch --- -Adding global-agent to enable the ability to publish through a proxy \ No newline at end of file +Adding global-agent to enable the ability to publish through a proxy diff --git a/packages/techdocs-cli/README.md b/packages/techdocs-cli/README.md index e6ba03e1d0..85c0075946 100644 --- a/packages/techdocs-cli/README.md +++ b/packages/techdocs-cli/README.md @@ -41,7 +41,8 @@ yarn techdocs-cli:dev [...options] ``` ### Connecting behind a proxy -```sh + +```sh # Prior to executing the techdocs-cli command export GLOBAL_AGENT_HTTPS_PROXY=${HTTP_PROXY} export GLOBAL_AGENT_NO_PROXY=${NO_PROXY} From edecccabe47b23c5c78118ee46def576afbb8e6d Mon Sep 17 00:00:00 2001 From: zjpersc Date: Fri, 10 Mar 2023 14:01:24 -0600 Subject: [PATCH 8/8] Updating the feature doc for techdocs-cli Signed-off-by: zjpersc --- docs/features/techdocs/cli.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/docs/features/techdocs/cli.md b/docs/features/techdocs/cli.md index b174896d6a..76589de5a8 100644 --- a/docs/features/techdocs/cli.md +++ b/docs/features/techdocs/cli.md @@ -200,6 +200,15 @@ Options: -h, --help display help for command ``` +#### Publishing from behind a proxy + +For users attempting to publish TechDocs content behind a proxy, the TechDocs CLI leverages `global-agent` to navigate the proxy to successfully connect to that location. To enable `global-agent`, the following variables need to be set prior to running the techdocs-cli command: + +```bash +export GLOBAL_AGENT_HTTPS_PROXY=${HTTP_PROXY} +export GLOBAL_AGENT_NO_PROXY=${NO_PROXY} +``` + ### Migrate content for case-insensitive access Prior to the beta version of TechDocs (`v[0.11.0]`), TechDocs were stored in