sauce-docs icon indicating copy to clipboard operation
sauce-docs copied to clipboard

sc5: move CLI docs to secure connections section

Open Choraden opened this issue 1 year ago • 7 comments
trafficstars

Description

Currently there are two places where you can find SC5 docs.

  1. Secure connections section /secure-connections/sauce-connect-5/... it contains: overview, installation doc, configuration, etc..
  2. CLI /dev/cli/sauce-connect-5/... commands: sc, sc run, sc legacy...

This patch moves SC5 CLI docs to secure connections section. The SC5 CLI section will remain as a reference and point to new cli directory.

This patch is a foundation to auto generated SC5 CLI docs.

Motivation and Context

  • centralized information/unified structure: Users often look for all relevant documentation in one place. Having CLI docs next to other related docs reduces the need to navigate through different sections of the site, providing a smoother and more intuitive user experience.

  • consistent context/cross-referencing ease: Keeping related documents together helps maintain context for the user, as they can browse quickly through the sidebar.

  • discoverability: Users might not always know what they are looking for. By having CLI docs in the same location as other SC content, you increase the chances of users discovering useful commands and features they weren't initially aware of.

  • SEO benefits: From a web presence perspective, having a consolidated section with comprehensive coverage of a topic can improve search engine visibility.

Types of Changes

  • [ ] Bug fix (non-breaking change which fixes an issue)
  • [ ] New feature (non-breaking change which adds functionality)
  • [x] Breaking change (fix or feature that would cause existing functionality to change)
  • [ ] Documentation fix (typos, incorrect content, missing content, etc.)

Choraden avatar Mar 26 '24 13:03 Choraden

This totally makes sense but we also need redirects configured at this point.

mmatczuk avatar Mar 26 '24 13:03 mmatczuk

This totally makes sense but we also need redirects configured at this point.

sauce-docs/dev/cli/sauce-connect-5/ redirects to secure-connections...

Should've included that in pr comment.

Choraden avatar Mar 26 '24 13:03 Choraden

Deploy preview ready for 2701! https://docs.dev.saucelabs.net built from d94b0bdf259016fca01634150ffc3f6b216c2932

github-actions[bot] avatar Mar 26 '24 13:03 github-actions[bot]

Deploy preview ready for 2701! https://docs.dev.saucelabs.net built from 83a6ee042758a1b9489beb2009335a7ba0af83c4

github-actions[bot] avatar Apr 04 '24 19:04 github-actions[bot]

Deploy preview ready for 2701! https://docs.dev.saucelabs.net built from 8ff65f67c4aabc28457a5c8f7e33a82efc7fa0e6

github-actions[bot] avatar Apr 08 '24 11:04 github-actions[bot]

Deploy preview ready for 2701! https://docs.dev.saucelabs.net built from d92efbee7a3963a861a2416a4016fd256be4b32c

github-actions[bot] avatar Apr 08 '24 14:04 github-actions[bot]

Deploy preview ready for 2701! https://docs.dev.saucelabs.net built from be521e78f8e2e20128f8e8d1e6c8f573bd082a1a

github-actions[bot] avatar Apr 08 '24 14:04 github-actions[bot]