Plan for migrating VS Code user documentation

I'll use this issue to chart out how to migrate the user docs to the monolith.

Goal: migrate user docs into the gitlab monolith repo, while maintaining duplication in a few key areas. Developer docs remain untouched by default.

Related to technical-writing#1146

Useful notes

• The Marketplace listing does not have to be the file currently known as README.md. This idea might or might not be pursued.
• Tomas' preferred setup includes 3 parts: Features Overview, Setup Instructions, Settings.
  • Stay in README: showcase of high-level functions, setup instructions, settings
    • At the bottom of the README: link out to GitLab docs for more detail
  • setup instructions should be shown in the marketplace
  • consider a way to keep the items that remain in the README synchronized with the info kept in the monolith

Page structure in gitlab

• index.md
  • custom_queries.md (added in gitlab!168441 (merged))
  • remote_urls.md (added in gitlab!168441 (merged))
  • ssl.md (added in gitlab!167361 (merged), truncated in !2001 (merged))
  • troubleshooting.md (added in gitlab!167361 (merged), truncated in !2001 (merged))

Page structure in gitlab-vscode-extension

• README
• docs/
  • assets/
  • developer/
  • user/
    • custom-queries.md (copied over in gitlab!168441 (merged), truncated in !2047 (merged))
    • known-issues.md (copied over in #580 (closed), truncated in !2003 (merged))
    • remote-fs-url-format.md (copied over in gitlab!168441 (merged), truncated in !2047 (merged))
    • ssl.md (truncated in !2001 (merged))
    • troubleshooting.md (truncated in !2001 (merged))

Subheading structure in README

Click to expand

# GitLab Workflow
## Minimum supported version
## Features
### Code Suggestions
#### Code Suggestions status icons
#### Set up Code Suggestions
#### Accepting code suggestions
#### Use Code Generation
### Browse issues, review MRs
### Information about your branch - pipelines, MR, closing issue
### Commands
## Setup
### Set token with environment variables
### Self-signed certificate authority // redacted in https://gitlab.com/gitlab-org/gitlab-vscode-extension/-/merge_requests/2063
## Extension settings
## Features in-depth
### Issue and Merge Request details and comments in VS Code
#### Merge Request Reviews
### Sidebar: details
### View the job output
### Security findings
### Pipeline actions
### Status bar: details
### Search
### Create snippet   // https://gitlab.com/gitlab-org/gitlab/-/merge_requests/169195
### Insert snippet   // https://gitlab.com/gitlab-org/gitlab/-/merge_requests/169195
### Create and apply snippet patch   // https://gitlab.com/gitlab-org/gitlab/-/merge_requests/169195
### Compare with default branch
### Open active file
### Validate GitLab CI/CD Configuration
### Show merged GitLab CI/CD configuration
### CI/CD variable autocompletion
### Clone GitLab projects
### Browse a repository without cloning // Redacted in https://gitlab.com/gitlab-org/gitlab-vscode-extension/-/merge_requests/2063
## Account management
### How the account and project are selected
## Roadmap
## Contribution

Structure of existing page (doc/editor_extensions/visual_studio_code/index.md) in gitlab repo:

# GitLab Workflow extension for VS Code
## Code Suggestions features
## Set up the GitLab Workflow extension
## Configure extension settings
### Customize keyboard shortcuts
## Configure more languages for Code Suggestions
## Integrate with GitLab
## Troubleshooting
## Related topics

## Resources

- [Googledoc](https://docs.google.com/document/d/12xiROXfxsX4RbgB-c9OI8a94oiCRf1xfDB2o2-SSnHk/edit) with notes from the TW / EE meeting.