sc5: move CLI docs to secure connections section #2701
Conversation
|
This totally makes sense but we also need redirects configured at this point. |
Should've included that in pr comment. |
|
Deploy preview ready for 2701! |
docs/dev/cli.md
Outdated
| @@ -17,7 +17,7 @@ hide_table_of_contents: true | |||
| <div> | |||
| <div className="box boxwidetop card"> | |||
| <div className="container"> | |||
| <a href="/dev/cli/sauce-connect-5/run"><h3>Sauce Connect Proxy 5 CLI </h3></a> | |||
| <a href="/secure-connections/sauce-connect-5/cli/run"><h3>Sauce Connect Proxy 5 CLI </h3></a> | |||
There was a problem hiding this comment.
it's not the right place for the question but why?
why do you need to move CLI docs from /dev/cli/ ??
My problem with this is that other CLI tools are in /dev/cli/ and sauce connect shouldn't be special (unless there is some serious reason for that).
There was a problem hiding this comment.
Having cli with all the other docs has several advantages. As a user I would like to have everything at one place, that I can quickly find at the sidebar. At this moment SC5 docs and SC5 CLI come across as a separate documents. They lack connection IMO.
Generally, I would like to achieve a sidebar similar to what we have here: https://forwarder-proxy.io.
The reference to SC5 CLI will stay at /dev/cli/, so this would satisfy our convention.
|
Deploy preview ready for 2701! |
Choraden
changed the title
|
Deploy preview ready for 2701! |
|
Deploy preview ready for 2701! |
This patch is a foundation to auto generated SC5 CLI docs. This moves all sc5 docs to one place. It has several advantages: - 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. The SC5 CLI section will remain and point to new cli directory.
|
Deploy preview ready for 2701! |
Description
Currently there are two places where you can find SC5 docs.
/secure-connections/sauce-connect-5/...it contains: overview, installation doc, configuration, etc..
/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