Skip to content

docs: migrate CLI section to v4 consolidated reference #439

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Ethan-Arrowood wants to merge 1 commit into
base: major-version-reorg
Choose a base branch
from
Open

docs: migrate CLI section to v4 consolidated reference #439

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
282 changes: 282 additions & 0 deletions migration-context/link-placeholders/cli-link-placeholders.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,282 @@
# Link Placeholders for CLI Section

This document tracks all link placeholders in the CLI section that need to be resolved once other sections are migrated.

## reference_versioned_docs/version-v4/cli/overview.md

- Line 30: `[CLI Authentication](TODO:reference_versioned_docs/version-v4/cli/authentication.md "CLI authentication details")`
- Context: Linking to CLI authentication details
- Target: CLI authentication page (within CLI section)
- **Status**: RESOLVED (file created in this migration)

- Line 45: `[CLI Commands](TODO:reference_versioned_docs/version-v4/cli/commands.md "Detailed CLI command reference")`
- Context: Linking to detailed CLI commands
- Target: CLI commands page (within CLI section)
- **Status**: RESOLVED (file created in this migration)

- Line 60: `[Operations API](TODO:reference_versioned_docs/version-v4/operations-api/overview.md "Operations API overview")`
- Context: Linking to Operations API overview
- Target: Operations API section overview page
- **Status**: PENDING (will be created in Operations API section migration)

- Line 100: `[Operations API Commands](TODO:reference_versioned_docs/version-v4/cli/operations-api-commands.md "Operations API CLI commands reference")`
- Context: Linking to operations API commands via CLI
- Target: Operations API commands page (within CLI section)
- **Status**: RESOLVED (file created in this migration)

- Line 126: `[Configuration](TODO:reference_versioned_docs/version-v4/configuration/overview.md "Configuration overview")`
- Context: Linking to configuration options
- Target: Configuration section overview
- **Status**: PENDING (will be created in Configuration section migration)

- Line 144: `[Operations API](TODO:reference_versioned_docs/version-v4/operations-api/overview.md "Operations API")`
- Context: Linking to full operations API reference
- Target: Operations API section overview page
- **Status**: PENDING (will be created in Operations API section migration)

## reference_versioned_docs/version-v4/cli/commands.md

- Line 9: `[Operations API Commands](TODO:reference_versioned_docs/version-v4/cli/operations-api-commands.md "Operations API CLI commands")`
- Context: Referring users to operations API commands documentation
- Target: Operations API commands page (within CLI section)
- **Status**: RESOLVED (file created in this migration)

- Line 52: `[Configuration](TODO:reference_versioned_docs/version-v4/configuration/overview.md "Configuration overview")`
- Context: Linking to configuration parameters
- Target: Configuration section overview
- **Status**: PENDING (will be created in Configuration section migration)

- Line 125: `[Database Compaction](TODO:reference_versioned_docs/version-v4/database/compaction.md "Database compaction reference")`
- Context: Linking to database compaction details
- Target: Database section compaction page
- **Status**: PENDING (will be created in Database section migration)

- Line 146: `[CLI Overview - Remote Operations](TODO:reference_versioned_docs/version-v4/cli/overview.md#remote-operations "Remote operations documentation")`
- Context: Linking to remote operations section in overview
- Target: CLI overview page, remote operations section
- **Status**: RESOLVED (file created in this migration)

- Line 151: `[CLI Overview](TODO:reference_versioned_docs/version-v4/cli/overview.md "CLI overview")`
- Context: Linking back to CLI overview
- Target: CLI overview page (within CLI section)
- **Status**: RESOLVED (file created in this migration)

- Line 152: `[Operations API Commands](TODO:reference_versioned_docs/version-v4/cli/operations-api-commands.md "Operations API commands")`
- Context: Linking to operations API commands
- Target: Operations API commands page (within CLI section)
- **Status**: RESOLVED (file created in this migration)

- Line 153: `[CLI Authentication](TODO:reference_versioned_docs/version-v4/cli/authentication.md "CLI authentication")`
- Context: Linking to authentication mechanisms
- Target: CLI authentication page (within CLI section)
- **Status**: RESOLVED (file created in this migration)

- Line 154: `[Configuration](TODO:reference_versioned_docs/version-v4/configuration/overview.md "Configuration")`
- Context: Linking to configuration parameters
- Target: Configuration section overview
- **Status**: PENDING (will be created in Configuration section migration)

- Line 155: `[Database Compaction](TODO:reference_versioned_docs/version-v4/database/compaction.md "Compaction")`
- Context: Linking to compaction details
- Target: Database section compaction page
- **Status**: PENDING (will be created in Database section migration)

## reference_versioned_docs/version-v4/cli/operations-api-commands.md

- Line 12: `[Operations API](TODO:reference_versioned_docs/version-v4/operations-api/overview.md "Operations API overview")`
- Context: Introduction paragraph
- Target: Operations API section overview page
- **Status**: PENDING (will be created in Operations API section migration)

- Lines 38-109: 72 operations table entries with category links
- `[Database](TODO:../operations-api/database.md)` (9 operations)
- `[Data](TODO:../operations-api/data.md)` (9 operations)
- `[Security](TODO:../operations-api/security.md)` (17 operations)
- `[Clustering](TODO:../operations-api/clustering.md)` (4 operations)
- `[Components](TODO:../operations-api/components.md)` (9 operations)
- `[Configuration](TODO:../operations-api/configuration.md)` (2 operations)
- `[Authentication](TODO:../operations-api/authentication.md)` (2 operations)
- `[System](TODO:../operations-api/system.md)` (3 operations)
- `[Licensing](TODO:../operations-api/licensing.md)` (4 operations)
- `[Jobs](TODO:../operations-api/jobs.md)` (2 operations)
- `[Logging](TODO:../operations-api/logging.md)` (4 operations)
- `[Maintenance](TODO:../operations-api/maintenance.md)` (2 operations)
- `[Status](TODO:../operations-api/status.md)` (3 operations)
- Context: Operations table linking to operation category documentation
- Target: Operations API section category pages
- **Status**: PENDING (will be created in Operations API section migration)

- Line 118: `[Operations API documentation](TODO:reference_versioned_docs/version-v4/operations-api/operations.md "Complete operations list")`
- Context: After Command Aliases section
- Target: Operations API section operations page
- **Status**: PENDING (will be created in Operations API section migration)

- Line 150: `[Database Reference](TODO:reference_versioned_docs/version-v4/database/overview.md "Database reference documentation")`
- Context: Tip callout in Database Operations examples
- Target: Database section overview
- **Status**: PENDING (will be created in Database section migration)

- Line 168: `[REST Reference](TODO:reference_versioned_docs/version-v4/rest/overview.md "REST API reference")`
- Context: Tip callout in Data Operations examples
- Target: REST section overview
- **Status**: PENDING (will be created in REST section migration)

- Line 168: `[GraphQL Querying](TODO:reference_versioned_docs/version-v4/graphql-querying/overview.md "GraphQL querying reference")`
- Context: Tip callout in Data Operations examples
- Target: GraphQL Querying section overview
- **Status**: PENDING (will be created in GraphQL Querying section migration)

- Line 186: `[Configuration Reference](TODO:reference_versioned_docs/version-v4/configuration/overview.md "Configuration reference")`
- Context: Tip callout in Configuration Operations examples
- Target: Configuration section overview
- **Status**: PENDING (will be created in Configuration section migration)

- Line 204: `[Components Reference](TODO:reference_versioned_docs/version-v4/components/overview.md "Components reference")`
- Context: Tip callout in Component Operations examples
- Target: Components section overview
- **Status**: PENDING (will be created in Components section migration)

- Line 222: `[Security Reference](TODO:reference_versioned_docs/version-v4/security/overview.md "Security reference")`
- Context: Tip callout in User and Role Operations examples
- Target: Security section overview
- **Status**: PENDING (will be created in Security section migration)

- Line 227: `[CLI Overview - Remote Operations](./overview.md#remote-operations)`
- Context: Remote Operations section
- Target: CLI overview page, remote operations anchor
- **Status**: RESOLVED (file created in this migration)

- Line 245: `[Applications](TODO:reference_versioned_docs/version-v4/applications/overview.md "Applications reference")`
- Context: Remote Component Deployment section
- Target: Applications section (or Components section)
- **Status**: PENDING (will be created in future section migration)

- Line 246: `[Deploying Harper Applications](TODO:learn_link "Deploying applications guide")`
- Context: Remote Component Deployment section
- Target: Learn guide on deploying applications
- **Status**: PENDING (external learn link)

- Line 372: `[Operations API](TODO:reference_versioned_docs/version-v4/operations-api/overview.md "Operations API")`
- Context: Limitations section
- Target: Operations API section overview page
- **Status**: PENDING (will be created in Operations API section migration)

- Line 376: `[CLI Overview](./overview.md)`
- Context: See Also section
- Target: CLI overview page (within CLI section)
- **Status**: RESOLVED (file created in this migration)

- Line 377: `[CLI Commands](./commands.md)`
- Context: See Also section
- Target: CLI commands page (within CLI section)
- **Status**: RESOLVED (file created in this migration)

- Line 378: `[Operations API Overview](TODO:reference_versioned_docs/version-v4/operations-api/overview.md "Operations API overview")`
- Context: See Also section
- Target: Operations API section overview page
- **Status**: PENDING (will be created in Operations API section migration)

- Line 379: `[Operations API Reference](TODO:reference_versioned_docs/version-v4/operations-api/operations.md "Operations reference")`
- Context: See Also section
- Target: Operations API section operations page
- **Status**: PENDING (will be created in Operations API section migration)

- Line 380: `[CLI Authentication](./authentication.md)`
- Context: See Also section
- Target: CLI authentication page (within CLI section)
- **Status**: RESOLVED (file created in this migration)

## reference_versioned_docs/version-v4/cli/authentication.md

- Line 196: `[Users and Roles](TODO:reference_versioned_docs/version-v4/security/users-and-roles.md "Users and roles documentation")`
- Context: Linking to user management and permissions (Security Best Practices section)
- Target: Security section users and roles page
- **Status**: PENDING (will be created in Security section migration)

- Line 204: `[Logging](TODO:reference_versioned_docs/version-v4/logging/overview.md "Logging documentation")`
- Context: Linking to audit logging information (Security Best Practices section)
- Target: Logging section overview
- **Status**: PENDING (will be created in Logging section migration)

- Line 256: `[CLI Overview](./overview.md)`
- Context: See Also section
- Target: CLI overview page (within CLI section)
- **Status**: RESOLVED (file created in this migration)

- Line 257: `[CLI Commands](./commands.md)`
- Context: See Also section
- Target: CLI commands page (within CLI section)
- **Status**: RESOLVED (file created in this migration)

- Line 258: `[Operations API Commands](./operations-api-commands.md)`
- Context: See Also section
- Target: Operations API commands page (within CLI section)
- **Status**: RESOLVED (file created in this migration)

- Line 259: `[Security Overview](TODO:reference_versioned_docs/version-v4/security/overview.md "Security overview")`
- Context: See Also section
- Target: Security section overview page
- **Status**: PENDING (will be created in Security section migration)

- Line 260: `[Users and Roles](TODO:reference_versioned_docs/version-v4/security/users-and-roles.md "Users and roles")`
- Context: See Also section
- Target: Security section users and roles page
- **Status**: PENDING (will be created in Security section migration)

## Summary

### Resolved Links (Within CLI Section)
- 12 links to pages within the CLI section (all resolved in this migration)
- All internal CLI section links now use relative paths (e.g., `./overview.md`)

### Pending Links (Cross-Section References)
These will be resolved in future section migrations:

**Operations API Section** (~82 links):
- `reference_versioned_docs/version-v4/operations-api/overview.md` (5 occurrences)
- `reference_versioned_docs/version-v4/operations-api/operations.md` (2 occurrences)
- Operations table category pages (72 links):
- `../operations-api/database.md`
- `../operations-api/data.md`
- `../operations-api/security.md`
- `../operations-api/clustering.md`
- `../operations-api/components.md`
- `../operations-api/configuration.md`
- `../operations-api/authentication.md`
- `../operations-api/system.md`
- `../operations-api/licensing.md`
- `../operations-api/jobs.md`
- `../operations-api/logging.md`
- `../operations-api/maintenance.md`
- `../operations-api/status.md`

**Configuration Section** (5 links):
- `reference_versioned_docs/version-v4/configuration/overview.md`

**Database Section** (3 links):
- `reference_versioned_docs/version-v4/database/compaction.md` (2 occurrences)
- `reference_versioned_docs/version-v4/database/overview.md` (1 occurrence)

**Security Section** (4 links):
- `reference_versioned_docs/version-v4/security/overview.md` (2 occurrences)
- `reference_versioned_docs/version-v4/security/users-and-roles.md` (2 occurrences)

**Logging Section** (1 link):
- `reference_versioned_docs/version-v4/logging/overview.md`

**Components Section** (1 link):
- `reference_versioned_docs/version-v4/components/overview.md`

**REST Section** (1 link):
- `reference_versioned_docs/version-v4/rest/overview.md`

**GraphQL Querying Section** (1 link):
- `reference_versioned_docs/version-v4/graphql-querying/overview.md`

**Applications Section** (1 link):
- `reference_versioned_docs/version-v4/applications/overview.md`

**Learn Guides** (1 link):
- Deploying Harper Applications guide (external learn link)

**Total Pending Links**: ~96
Loading
Loading