Introduce SC5 Guides section (#3170)

budziam · web-flow · commit 26ff278bc6f8 · 2025-05-12T12:42:25.000+02:00
* Move readiness checks under guides

* Reorganize guides section

* Move SC5 API server under guides

* Move SC5 ci-cd-integration under guides

* Move SC5 configuration under guides

* Move SC5 overview under guides

* Move SC5 proxies under guides

* Move SC5 tunnel-pool under guides

* Move SC5 tunnels under guides

* Move logging and monitoring under guides

* Move SC5 traffic inspection under guides

* Remove SC5 overview from sidebar, it's going to be replaced with quickstart
diff --git a/docs/basics/acct-team-mgmt/managing-service-accounts.md b/docs/basics/acct-team-mgmt/managing-service-accounts.md
@@ -141,4 +141,4 @@ Jobs run by service accounts are displayed on the [Automated Test Results page](
 
 ### Using Sauce Connect Proxy with a Service Account
 
-If you plan to run tests through a [Sauce Connect Proxy tunnel](/secure-connections/), be mindful of tunnel sharing options. Service accounts cannot create or manage tunnels, so you must use a tunnel that has been shared with the service account’s assigned team. For detailed configuration instructions, refer to the [shared tunnels section](/secure-connections/sauce-connect-5/operation/overview/#shared-tunnels).
+If you plan to run tests through a [Sauce Connect Proxy tunnel](/secure-connections/), be mindful of tunnel sharing options. Service accounts cannot create or manage tunnels, so you must use a tunnel that has been shared with the service account’s assigned team. For detailed configuration instructions, refer to the [shared tunnels section](/secure-connections/sauce-connect-5/guides/overview/#shared-tunnels).
diff --git a/docs/basics/acct-team-mgmt/sauce-connect-proxy-tunnels.md b/docs/basics/acct-team-mgmt/sauce-connect-proxy-tunnels.md
@@ -6,7 +6,7 @@ sidebar_label: Sharing Sauce Connect Proxy Tunnels
 
 You can share Sauce Connect Proxy tunnels based on the hierarchical structure of your [user roles](/basics/acct-team-mgmt/managing-user-info/#user-roles). You can also verify which tunnels are available on the **Tunnels** page in Sauce Labs.
 
-For instructions on running a job using a shared tunnel, refer to the [shared tunnels guide](/secure-connections/sauce-connect-5/operation/overview/#shared-tunnels).
+For instructions on running a job using a shared tunnel, refer to the [shared tunnels guide](/secure-connections/sauce-connect-5/guides/overview/#shared-tunnels).
 
 | Role Creating Tunnel | Sharing Options (live testing or test automation)                                         | Use Tunnels (live testing or test automation)              | Stop options (from tunnels page)                  |
 | -------------------- | ----------------------------------------------------------------------------------------- | ---------------------------------------------------------- | ------------------------------------------------- |
diff --git a/docs/dev/cli/sauce-connect-5.md b/docs/dev/cli/sauce-connect-5.md
@@ -82,4 +82,4 @@ Use "sc <command> --help" for more information about a given command.
 ## Additional Resources
 
 - [Sauce Connect Proxy Basic Setup](/secure-connections/sauce-connect-5/installation/).
-- [Sauce Connect Proxy Environment Variables](/secure-connections/sauce-connect-5/operation/configuration/#environment-variables).
+- [Sauce Connect Proxy Environment Variables](/secure-connections/sauce-connect-5/guides/configuration/#environment-variables).
diff --git a/docs/secure-connections.md b/docs/secure-connections.md
@@ -29,7 +29,7 @@ See our [Sauce Connect Proxy Security Overview](https://saucelabs.com/resources/
 </div>
     <div className="box box3 card">
       <div className="container">
-      <h3><a href="/secure-connections/sauce-connect-5/operation/overview">Setup and Configuration</a></h3>
+      <h3><a href="/secure-connections/sauce-connect-5/guides/overview">Setup and Configuration</a></h3>
       <p>Learn how to launch a basic Sauce Connect Proxy tunnel configuration. Once you’re connected, use our code samples to run your first test.</p>
       </div>
     </div>
@@ -41,7 +41,7 @@ See our [Sauce Connect Proxy Security Overview](https://saucelabs.com/resources/
     </div>
     <div className="box box5 card">
       <div className="container">
-      <h3><a href="/secure-connections/sauce-connect-5/operation/ci-cd-integration">CI/CD Integration</a></h3>
+      <h3><a href="/secure-connections/sauce-connect-5/guides/ci-cd-integration">CI/CD Integration</a></h3>
       <p>Streamline your Sauce Connect Proxy automated functional testing by integrating your preferred build provider with Sauce Labs.</p>
       </div>
     </div>
@@ -59,7 +59,7 @@ See our [Sauce Connect Proxy Security Overview](https://saucelabs.com/resources/
     </div>
     <div className="box box8 card">
       <div className="container">
-      <h3><a href="/secure-connections/sauce-connect-5/operation/tunnel-pool/">Tunnel Pool Setup</a></h3>
+      <h3><a href="/secure-connections/sauce-connect-5/guides/tunnel-pool/">Tunnel Pool Setup</a></h3>
       <p>Set up a high volume of tests to run parallel through multiple Sauce Connect Proxy tunnels to save time.</p>
       </div>
     </div>
diff --git a/docs/secure-connections/sauce-connect-5/faq.md b/docs/secure-connections/sauce-connect-5/faq.md
@@ -24,7 +24,7 @@ Port 443 is the typical default port for HTTPS traffic. Sauce Connect will use p
 
 You can use the [`-x / --proxy`](/dev/cli/sauce-connect-5/run/#proxy) command-line option (or `SAUCE_PROXY` environment variable) to specify the `hostname:port` of the proxy for all Sauce Connect Proxy traffic to the site(s) under test. In some companies you MUST pass traffic through a proxy to reach the internet.
 
-See also [Sauce Connect Proxy Setup with Additional Proxies](/secure-connections/sauce-connect-5/operation/proxies).
+See also [Sauce Connect Proxy Setup with Additional Proxies](/secure-connections/sauce-connect-5/guides/proxies).
 
 ## How can I share a Sauce Connect tunnel between multiple accounts?
 
@@ -53,13 +53,13 @@ Entering this code -- `(www.)?google-analytics.com,(www.)?googletagmanager.com,(
 
 You can access `localhost` through Sauce Connect on Virtual Desktop Browser tests. However, you cannot proxy `localhost` or 127.0.0.1 connections on any Mobile tests, whether they are Emulators, Simulators, or Real Devices.
 
-When using Sauce Connect Proxy, local websites running on commonly used ports are available to test at `localhost` or 127.0.0.1 URLs. The exception is when testing on Real or Virtual Mobile Devices. Real and Virtual Mobile tests require changes to the `/etc/hosts` file where Sauce Connect Proxy is hosted. For more information, see [Testing Mobile Devices Against localhost](/secure-connections/sauce-connect-5/operation/configuration/#sc5localhost).
+When using Sauce Connect Proxy, local websites running on commonly used ports are available to test at `localhost` or 127.0.0.1 URLs. The exception is when testing on Real or Virtual Mobile Devices. Real and Virtual Mobile tests require changes to the `/etc/hosts` file where Sauce Connect Proxy is hosted. For more information, see [Testing Mobile Devices Against localhost](/secure-connections/sauce-connect-5/guides/configuration/#sc5localhost).
 
 For all platforms, tests may perform better when using a locally defined domain name (which can be set in your [`hosts` file](http://en.wikipedia.org/wiki/Hosts_file)) rather than `localhost`. Using a locally defined domain name also allows access to apps on any port. If you are using a parent proxy with Sauce Connect, you may need the [`--proxy-localhost` flag](/dev/cli/sauce-connect-5/run/#proxy-localhost).
 
 ## How can I improve tunnel performance?
 
-See [Improving Sauce Connect Proxy Performance](/secure-connections/sauce-connect-5/operation/tunnels/#sc5perf).
+See [Improving Sauce Connect Proxy Performance](/secure-connections/sauce-connect-5/guides/tunnels/#sc5perf).
 
 ## What are the supported ports on localhost?
 
diff --git a/docs/secure-connections/sauce-connect-5/guides/api-server.md b/docs/secure-connections/sauce-connect-5/guides/api-server.md
diff --git a/docs/secure-connections/sauce-connect-5/guides/ci-cd-integration.md b/docs/secure-connections/sauce-connect-5/guides/ci-cd-integration.md
diff --git a/docs/secure-connections/sauce-connect-5/guides/configuration.md b/docs/secure-connections/sauce-connect-5/guides/configuration.md
diff --git a/docs/secure-connections/sauce-connect-5/guides/inspecting.md b/docs/secure-connections/sauce-connect-5/guides/inspecting.md
diff --git a/docs/secure-connections/sauce-connect-5/guides/logging.md b/docs/secure-connections/sauce-connect-5/guides/logging.md
diff --git a/docs/secure-connections/sauce-connect-5/guides/monitoring.md b/docs/secure-connections/sauce-connect-5/guides/monitoring.md
@@ -26,7 +26,7 @@ You can manage and monitor all Sauce Connect Proxy tunnel activity from the Sauc
 ## Grafana Dashboard
 
 [Prometheus](https://prometheus.io/) can be used to monitor Sauce Connect Proxy.
-The `/metrics` endpoint is available on [the local API server](/secure-connections/sauce-connect-5/operation/api-server).
+The `/metrics` endpoint is available on [the local API server](/secure-connections/sauce-connect-5/guides/api-server).
 Note that the API server must be enabled with the `--api-address` option, and by default it's disabled.
 
 Grafana dashboard using these metrics is available at [Grafana Dashboards](https://grafana.com/grafana/dashboards/20232-sauce-connect/).
diff --git a/docs/secure-connections/sauce-connect-5/guides/overview.md b/docs/secure-connections/sauce-connect-5/guides/overview.md
@@ -17,16 +17,16 @@ Sauce Connect Proxy operations and administration involve everything required to
 ## Installation and Configuration
 
 - See the [installation instructions](/secure-connections/sauce-connect-5/installation/)
-- See the [configuration guide](/secure-connections/sauce-connect-5/operation/configuration/)
+- See the [configuration guide](/secure-connections/sauce-connect-5/guides/configuration/)
 
 ## Administration
 
 We recommend using a single Sauce Connect Proxy tunnel or tunnel pool for each test suite or build, and tearing it down at the end of your test. Your test automation framework should launch Sauce Connect Proxy before the test suite is triggered and shut it down when the suite finishes.
 
 ### Security Considerations
 
-We recommend using a [config file](/secure-connections/sauce-connect-5/operation/configuration/#config-file)
-or [setting environment variables](/secure-connections/sauce-connect-5/operation/configuration/#environment-variables)
+We recommend using a [config file](/secure-connections/sauce-connect-5/guides/configuration/#config-file)
+or [setting environment variables](/secure-connections/sauce-connect-5/guides/configuration/#environment-variables)
 to hide sensitive information like your password ([--access-key](/dev/cli/sauce-connect-5/run/#access-key))
 and proxy credentials. This way, they won't be visible in the list of running
 processes.
@@ -100,7 +100,7 @@ sc.exe run --username <your user> --access-key <your access key> --region <us-we
 
 ### Monitoring Tunnels
 
-See the [monitoring overview](/secure-connections/sauce-connect-5/monitoring)
+See the [monitoring overview](/secure-connections/sauce-connect-5/guides/monitoring)
 
 ### Service Management Tools
 
diff --git a/docs/secure-connections/sauce-connect-5/guides/proxies.md b/docs/secure-connections/sauce-connect-5/guides/proxies.md
diff --git a/docs/secure-connections/sauce-connect-5/guides/readiness-checks.md b/docs/secure-connections/sauce-connect-5/guides/readiness-checks.md
@@ -91,7 +91,7 @@ to wait for the sc container to be healthy before starting the test container.
 
 ### Using sc readiness endpoint
 
-Sauce Connect provides a local [API server](/secure-connections/sauce-connect-5/operation/api-server) that contains readiness and liveness endpoints. 
+Sauce Connect provides a local [API server](/secure-connections/sauce-connect-5/guides/api-server) that contains readiness and liveness endpoints. 
 The readiness endpoint `/readyz` returns a 200 response code when Sauce Connect Proxy is ready, and 503 otherwise.
 
 To use the API server, you need to start Sauce Connect with the `--api-address` option or set the `SC_API_ADDRESS` environment variable.
diff --git a/docs/secure-connections/sauce-connect-5/guides/tunnel-pool.md b/docs/secure-connections/sauce-connect-5/guides/tunnel-pool.md
@@ -97,7 +97,7 @@ Tunnel pools use a round-robin algorithm to distribute test traffic evenly. If a
 
 * Visit the [Sauce Labs Tunnels Dashboard](https://app.saucelabs.com/tunnels) for live tunnel status.
 * Regularly check for inactive or crashed tunnels and restart them as needed.
-* See [Monitoring Tunnels](/secure-connections/sauce-connect-5/monitoring/) for more information.
+* See [Monitoring Tunnels](/secure-connections/sauce-connect-5/guides/monitoring/) for more information.
 
 ## Summary
 
diff --git a/docs/secure-connections/sauce-connect-5/guides/tunnels.md b/docs/secure-connections/sauce-connect-5/guides/tunnels.md
@@ -46,7 +46,7 @@ It can also be used to simulate non-loading of scripts, styles, or other resourc
 - Use wildcards to include subdomains by prefixing domain name with a dot `.`
   - Example: `.mydomain.com` will include `sub.mydomain.com` and `sub1.mydomain.com` but not `sub.myotherdomain.com`
 - See [`Formatting domains for CLI`](/dev/cli/sauce-connect-5/run/#formatting-domains)
-- Configuring domains in [YAML config file](/secure-connections/sauce-connect-5/operation/configuration/#config-file)
+- Configuring domains in [YAML config file](/secure-connections/sauce-connect-5/guides/configuration/#config-file)
   ```yaml
   ---
   # this will include all subdomains of example.com as well as dev.httpbin.org
diff --git a/docs/secure-connections/sauce-connect-5/installation/docker.md b/docs/secure-connections/sauce-connect-5/installation/docker.md
@@ -196,11 +196,11 @@ To access logs:
 
 The docker container has a built-in health check that can be used to determine if the tunnel is ready to accept jobs.
 You should see the container status as `healthy` in `docker ps` when the tunnel is ready.
-See [Sauce Connect Proxy Readiness Checks](/secure-connections/sauce-connect-5/operation/readiness-checks) for more information.
+See [Sauce Connect Proxy Readiness Checks](/secure-connections/sauce-connect-5/guides/readiness-checks) for more information.
 
 ## Additional Resources
 
-- [Sauce Connect Proxy Readiness Checks](/secure-connections/sauce-connect-5/operation/readiness-checks)
+- [Sauce Connect Proxy Readiness Checks](/secure-connections/sauce-connect-5/guides/readiness-checks)
 - [Use host networking in Docker](https://docs.docker.com/network/host/)
 - [Connect from a container to a service on the macOS host](https://docs.docker.com/desktop/mac/networking/#use-cases-and-workarounds)
 - [Docker Compose File](https://docs.docker.com/compose/compose-file/compose-file-v3/)
diff --git a/docs/secure-connections/sauce-connect-5/migrating.md b/docs/secure-connections/sauce-connect-5/migrating.md
@@ -104,22 +104,22 @@ The following flags have changed or been removed with Sauce Connect 5. In additi
 
 ### Removed Flags
 
-| Version 4.x | Version 5.x |
-| ----------- | ----------- |
-| `--autodetect` | removed |
-| `--doctor` | removed |
-| `--experimental` | removed |
-| `--extra-info` | removed |
-| `--log-stats` | removed |
-| `--max-logsize` | removed |
-| `--no-autodetect` | removed |
-| `--ocsp` | removed |
-| `--output-format` | removed |
-| `--pidfile` | removed |
-| `--readyfile` | see [Readiness Checks](/secure-connections/sauce-connect-5/operation/readiness-checks/) |
-| `--se-port` | removed |
-| `--tunnel-cainfo` | removed |
-| `--vm-version` | removed |
+| Version 4.x | Version 5.x                                                                          |
+| ----------- |--------------------------------------------------------------------------------------|
+| `--autodetect` | removed                                                                              |
+| `--doctor` | removed                                                                              |
+| `--experimental` | removed                                                                              |
+| `--extra-info` | removed                                                                              |
+| `--log-stats` | removed                                                                              |
+| `--max-logsize` | removed                                                                              |
+| `--no-autodetect` | removed                                                                              |
+| `--ocsp` | removed                                                                              |
+| `--output-format` | removed                                                                              |
+| `--pidfile` | removed                                                                              |
+| `--readyfile` | see [Readiness Checks](/secure-connections/sauce-connect-5/guides/readiness-checks/) |
+| `--se-port` | removed                                                                              |
+| `--tunnel-cainfo` | removed                                                                              |
+| `--vm-version` | removed                                                                              |
 
 ## New Behavior in Sauce Connect 5
 
@@ -167,7 +167,7 @@ You can also prefix the option with a `-` character to remove it from the list,
 
 ### Readiness Checks
 
-SC5 has been designed to integrate with Kubernetes and other container management systems. The `readyfile` and `status-address` options have been replaced by the `api-address` option. See [Readiness Checks](https://docs.saucelabs.com/secure-connections/sauce-connect-5/operation/readiness-checks/) for more details.
+SC5 has been designed to integrate with Kubernetes and other container management systems. The `readyfile` and `status-address` options have been replaced by the `api-address` option. See [Readiness Checks](https://docs.saucelabs.com/secure-connections/sauce-connect-5/guides/readiness-checks/) for more details.
 
 ### PID Files
 
diff --git a/docs/secure-connections/sauce-connect-5/quickstart.md b/docs/secure-connections/sauce-connect-5/quickstart.md
@@ -19,7 +19,7 @@ An [`sc legacy`](/dev/cli/sauce-connect-5/legacy/) command is introduced to help
 
 - A Sauce Labs account ([Log in](https://accounts.saucelabs.com/am/XUI/#login/) or sign up for a [free trial license](https://saucelabs.com/sign-up)).
 - If you haven't already, make sure you can access the website or mobile app that you'll be testing from the Sauce Connect Proxy host.
-- Check to see if you have any [proxies](/secure-connections/sauce-connect-5/operation/proxies/) that are required to access the public Internet.
+- Check to see if you have any [proxies](/secure-connections/sauce-connect-5/guides/proxies/) that are required to access the public Internet.
 
 ## Installing Sauce Connect Proxy
 
@@ -36,7 +36,7 @@ See the [installation instructions](/secure-connections/sauce-connect-5/installa
    This snippet contains your authentication credentials (username and access key), selects a Sauce Labs Data Center, and applies a name to your tunnel. Optionally, you can rename your tunnel by replacing the value after the <code>--tunnel-name</code> flag.
    </details>
 5. Paste the snippet into your terminal and run it. This will launch the tunnel.
-6. Follow the steps in the [setup instructions](/secure-connections/sauce-connect-5/operation/overview/#running-sauce-connect-proxy) to start Sauce Connect Proxy 5 using the username and the access key obtained in the previous step.
+6. Follow the steps in the [setup instructions](/secure-connections/sauce-connect-5/guides/overview/#running-sauce-connect-proxy) to start Sauce Connect Proxy 5 using the username and the access key obtained in the previous step.
 
 ## Verify Connection
 
@@ -111,7 +111,7 @@ Alternatively, you can go to the **Tunnel Proxies** page and click one of the **
 ## More Information
 
 - [Sauce Connect Proxy Overview](/secure-connections/sauce-connect-5/)
-- [Sauce Connect Proxy Configuration](/secure-connections/sauce-connect-5/operation/configuration)
+- [Sauce Connect Proxy Configuration](/secure-connections/sauce-connect-5/guides/configuration)
 - [Sauce Connect Proxy 5 CLI Reference](/dev/cli/sauce-connect-5/)
 - [Uploading and Managing Mobile Apps in Sauce Labs](/mobile-apps/app-storage)
 - [Live Testing Web Apps](/web-apps/live-testing/live-cross-browser-testing/)
diff --git a/sidebars.js b/sidebars.js
@@ -1024,22 +1024,21 @@ module.exports = {
                                 'secure-connections/sauce-connect-5/installation/kubernetes',
                             ],
                         },
-                        'secure-connections/sauce-connect-5/logging',
-                        'secure-connections/sauce-connect-5/monitoring',
-                        'secure-connections/sauce-connect-5/inspecting',
                         'secure-connections/sauce-connect-5/system-requirements',
                         {
                             type: 'category',
-                            label: 'Setup and Configuration',
+                            label: 'Guides',
                             collapsed: true,
                             items: [
-                                'secure-connections/sauce-connect-5/operation/overview',
-                                'secure-connections/sauce-connect-5/operation/configuration',
-                                'secure-connections/sauce-connect-5/operation/proxies',
-                                'secure-connections/sauce-connect-5/operation/api-server',
-                                'secure-connections/sauce-connect-5/operation/tunnel-pool',
-                                'secure-connections/sauce-connect-5/operation/ci-cd-integration',
-                                'secure-connections/sauce-connect-5/operation/readiness-checks',
+                                'secure-connections/sauce-connect-5/guides/configuration',
+                                'secure-connections/sauce-connect-5/guides/api-server',
+                                'secure-connections/sauce-connect-5/guides/readiness-checks',
+                                'secure-connections/sauce-connect-5/guides/logging',
+                                'secure-connections/sauce-connect-5/guides/monitoring',
+                                'secure-connections/sauce-connect-5/guides/proxies',
+                                'secure-connections/sauce-connect-5/guides/inspecting',
+                                'secure-connections/sauce-connect-5/guides/ci-cd-integration',
+                                'secure-connections/sauce-connect-5/guides/tunnel-pool',
                             ],
                         },
                         {

Original file line number	Diff line number	Diff line change
`@@ -141,4 +141,4 @@ Jobs run by service accounts are displayed on the [Automated Test Results page](`
`141`	`141`
`142`	`142`	`### Using Sauce Connect Proxy with a Service Account`
`143`	`143`
`144`		`-If you plan to run tests through a [Sauce Connect Proxy tunnel](/secure-connections/), be mindful of tunnel sharing options. Service accounts cannot create or manage tunnels, so you must use a tunnel that has been shared with the service account’s assigned team. For detailed configuration instructions, refer to the [shared tunnels section](/secure-connections/sauce-connect-5/operation/overview/#shared-tunnels).`
	`144`	`+If you plan to run tests through a [Sauce Connect Proxy tunnel](/secure-connections/), be mindful of tunnel sharing options. Service accounts cannot create or manage tunnels, so you must use a tunnel that has been shared with the service account’s assigned team. For detailed configuration instructions, refer to the [shared tunnels section](/secure-connections/sauce-connect-5/guides/overview/#shared-tunnels).`