From 8c9a8400173aaf8813ae8f11b12f14ab44de2c9f Mon Sep 17 00:00:00 2001 From: Mike Solomon Date: Mon, 27 Jan 2025 08:58:34 -0800 Subject: [PATCH] Update cli how-to titles/desc --- .../moderne-cli/cli-reference.md | 5 +++++ docs/user-documentation/moderne-cli/faq.md | 5 +++++ .../moderne-cli/how-to-guides/afterburner.md | 5 +++++ .../how-to-guides/air-gapped-cli-install.md | 5 +++++ .../moderne-cli/how-to-guides/build-steps.md | 5 +++++ .../moderne-cli/how-to-guides/cli-upgrade.md | 7 ++++++- .../moderne-cli/how-to-guides/clone-and-sync.md | 5 +++++ .../execute-user-supplied-commands.md | 5 +++++ .../how-to-guides/jdk-selection-and-config.md | 5 +++++ .../moderne-cli/how-to-guides/layer-config-cli.md | 5 +++++ .../how-to-guides/on-prem-scm-config.md | 5 +++++ .../moderne-cli/how-to-guides/parallelism.md | 5 +++++ .../moderne-cli/how-to-guides/ssh-key.md | 5 +++++ sidebars.ts | 14 ++++++++------ 14 files changed, 74 insertions(+), 7 deletions(-) diff --git a/docs/user-documentation/moderne-cli/cli-reference.md b/docs/user-documentation/moderne-cli/cli-reference.md index 8c47316c..3acc570c 100644 --- a/docs/user-documentation/moderne-cli/cli-reference.md +++ b/docs/user-documentation/moderne-cli/cli-reference.md @@ -1,3 +1,8 @@ +--- +sidebar_label: Reference manual +description: Auto-generated documentation for all Moderne CLI commands. +--- + # Moderne CLI reference ## Table of contents diff --git a/docs/user-documentation/moderne-cli/faq.md b/docs/user-documentation/moderne-cli/faq.md index 0728be6a..ab4de2b3 100644 --- a/docs/user-documentation/moderne-cli/faq.md +++ b/docs/user-documentation/moderne-cli/faq.md @@ -1,3 +1,8 @@ +--- +sidebar_label: FAQ +description: A list of frequently asked questions about the Moderne CLI. +--- + # FAQ ## Invalid entry compressed size exception diff --git a/docs/user-documentation/moderne-cli/how-to-guides/afterburner.md b/docs/user-documentation/moderne-cli/how-to-guides/afterburner.md index b11518d2..d9e946fc 100644 --- a/docs/user-documentation/moderne-cli/how-to-guides/afterburner.md +++ b/docs/user-documentation/moderne-cli/how-to-guides/afterburner.md @@ -1,3 +1,8 @@ +--- +sidebar_label: Improve recipe run times +description: How to improve recipe run times with mod afterburner. +--- + # How to improve recipe run times with mod afterburner By default, every time you run a recipe against an LST, the full LST much be parsed and checked – even if no changes have been made against it. This results in recipes taking a decent amount of time to execute – regardless of how many times you've run recipes against the same LST or how complex those recipes are. diff --git a/docs/user-documentation/moderne-cli/how-to-guides/air-gapped-cli-install.md b/docs/user-documentation/moderne-cli/how-to-guides/air-gapped-cli-install.md index 8abdeecb..bfb3a8ee 100644 --- a/docs/user-documentation/moderne-cli/how-to-guides/air-gapped-cli-install.md +++ b/docs/user-documentation/moderne-cli/how-to-guides/air-gapped-cli-install.md @@ -1,3 +1,8 @@ +--- +sidebar_label: Air-gapped environments +description: How to install and configure the Moderne CLI in an air-gapped environment. +--- + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; diff --git a/docs/user-documentation/moderne-cli/how-to-guides/build-steps.md b/docs/user-documentation/moderne-cli/how-to-guides/build-steps.md index 570befd9..d527f433 100644 --- a/docs/user-documentation/moderne-cli/how-to-guides/build-steps.md +++ b/docs/user-documentation/moderne-cli/how-to-guides/build-steps.md @@ -1,3 +1,8 @@ +--- +sidebar_label: Configuring build steps +description: Explains what build steps are and the various ways you can configure them. +--- + # Configuring build steps ## Out-of-the-box behavior without explicit configuration diff --git a/docs/user-documentation/moderne-cli/how-to-guides/cli-upgrade.md b/docs/user-documentation/moderne-cli/how-to-guides/cli-upgrade.md index af301c2a..04990057 100644 --- a/docs/user-documentation/moderne-cli/how-to-guides/cli-upgrade.md +++ b/docs/user-documentation/moderne-cli/how-to-guides/cli-upgrade.md @@ -1,4 +1,9 @@ -# How to update to the latest version of Moderne CLI +--- +sidebar_label: Updating the CLI +description: How to update to the latest version of the Moderne CLI. +--- + +# How to update to the latest version of the Moderne CLI To update the CLI to a newer version, you will need to download the latest version and delete your old version. diff --git a/docs/user-documentation/moderne-cli/how-to-guides/clone-and-sync.md b/docs/user-documentation/moderne-cli/how-to-guides/clone-and-sync.md index 8197c307..a9e244ce 100644 --- a/docs/user-documentation/moderne-cli/how-to-guides/clone-and-sync.md +++ b/docs/user-documentation/moderne-cli/how-to-guides/clone-and-sync.md @@ -1,3 +1,8 @@ +--- +sidebar_label: Synchronizing organizations +description: How to clone and synchronize organizations with the Moderne CLI. +--- + # How to clone and synchronize organizations If you've configured organizations in Moderne, you may find it useful to use the CLI to clone or synchronize them to your local machine. diff --git a/docs/user-documentation/moderne-cli/how-to-guides/execute-user-supplied-commands.md b/docs/user-documentation/moderne-cli/how-to-guides/execute-user-supplied-commands.md index e36594d3..af8a9c37 100644 --- a/docs/user-documentation/moderne-cli/how-to-guides/execute-user-supplied-commands.md +++ b/docs/user-documentation/moderne-cli/how-to-guides/execute-user-supplied-commands.md @@ -1,3 +1,8 @@ +--- +sidebar_label: Executing commands on many repositories +description: How to execute user-supplied commands on a list of repositories. +--- + # How to execute user-supplied commands on a list of repositories The Moderne CLI allows users to execute arbitrary commands on a list of repositories using the **mod exec** command. For example, the following CLI command will execute **git status** on each repository it finds under the current directory: diff --git a/docs/user-documentation/moderne-cli/how-to-guides/jdk-selection-and-config.md b/docs/user-documentation/moderne-cli/how-to-guides/jdk-selection-and-config.md index 89843980..211c35e0 100644 --- a/docs/user-documentation/moderne-cli/how-to-guides/jdk-selection-and-config.md +++ b/docs/user-documentation/moderne-cli/how-to-guides/jdk-selection-and-config.md @@ -1,3 +1,8 @@ +--- +sidebar_label: JDK configuration +description: How to configure the JDK in the Moderne CLI. +--- + # JDK configuration in the Moderne CLI By default, the Moderne CLI will try and detect what version of Java applies to a specific project and where the JDK is for said version. It will then pick the most optimal one when it goes to build each project. diff --git a/docs/user-documentation/moderne-cli/how-to-guides/layer-config-cli.md b/docs/user-documentation/moderne-cli/how-to-guides/layer-config-cli.md index 5a198cf8..147cae19 100644 --- a/docs/user-documentation/moderne-cli/how-to-guides/layer-config-cli.md +++ b/docs/user-documentation/moderne-cli/how-to-guides/layer-config-cli.md @@ -1,3 +1,8 @@ +--- +sidebar_label: Layered configuration +description: How to set global or project-specific build arguments in the Moderne CLI. +--- + # Layered configuration in the Moderne CLI One big challenge that comes with building [LSTs](../../../administrator-documentation/moderne-platform/references/lossless-semantic-trees.md) for many repositories on many machines is configuration. What arguments do you need to build each repository? Are there Maven specific ones? Gradle specific ones? Do they change depending on the group of projects? How do you share these configurations with new people on the team? diff --git a/docs/user-documentation/moderne-cli/how-to-guides/on-prem-scm-config.md b/docs/user-documentation/moderne-cli/how-to-guides/on-prem-scm-config.md index 2b25d783..a31d5774 100644 --- a/docs/user-documentation/moderne-cli/how-to-guides/on-prem-scm-config.md +++ b/docs/user-documentation/moderne-cli/how-to-guides/on-prem-scm-config.md @@ -1,3 +1,8 @@ +--- +sidebar_label: On-prem SCM configuration +description: On-prem source code management (SCM) server configuration. +--- + # On-prem source code management (SCM) server configuration In order for Moderne to correctly map repository clone URLs to the right origin and path you will need to configure the base URL(s) for your SCM server. For SaaS SCM services like GitHub, GitLab, Bitbucket (cloud) and AzureDevOps – no extra configuration is required. For on-prem SCM servers, though, you will need to provide Moderne with additional information. Specifically the type, base URL, and any alternate URLs that are used to access the server. diff --git a/docs/user-documentation/moderne-cli/how-to-guides/parallelism.md b/docs/user-documentation/moderne-cli/how-to-guides/parallelism.md index a8fec906..35bce267 100644 --- a/docs/user-documentation/moderne-cli/how-to-guides/parallelism.md +++ b/docs/user-documentation/moderne-cli/how-to-guides/parallelism.md @@ -1,3 +1,8 @@ +--- +sidebar_label: Speed up the CLI with parallelism +description: How to speed up the Moderne CLI with parallelism. +--- + # How to speed up the Moderne CLI with parallelism Depending on the number of repositories you have, it can take a long time to clone the repositories or run recipes against them. diff --git a/docs/user-documentation/moderne-cli/how-to-guides/ssh-key.md b/docs/user-documentation/moderne-cli/how-to-guides/ssh-key.md index 0b709c85..4f5f10ad 100644 --- a/docs/user-documentation/moderne-cli/how-to-guides/ssh-key.md +++ b/docs/user-documentation/moderne-cli/how-to-guides/ssh-key.md @@ -1,3 +1,8 @@ +--- +sidebar_label: SSH keys with passphrases +description: How to use SSH keys with passphrases. +--- + # SSH keys with passphrases If you need to enter an SSH passphrase when you clone repositories, please follow the below instructions so that the Moderne CLI will work correctly for you. diff --git a/sidebars.ts b/sidebars.ts index 24ee257e..1553821e 100644 --- a/sidebars.ts +++ b/sidebars.ts @@ -122,17 +122,19 @@ const sidebars: SidebarsConfig = { keywords: ['guides'], }, items: [ - 'user-documentation/moderne-cli/how-to-guides/layer-config-cli', - 'user-documentation/moderne-cli/how-to-guides/jdk-selection-and-config', 'user-documentation/moderne-cli/how-to-guides/air-gapped-cli-install', - 'user-documentation/moderne-cli/how-to-guides/execute-user-supplied-commands', + 'user-documentation/moderne-cli/how-to-guides/cli-upgrade', 'user-documentation/moderne-cli/how-to-guides/clone-and-sync', - 'user-documentation/moderne-cli/how-to-guides/on-prem-scm-config', 'user-documentation/moderne-cli/how-to-guides/parallelism', 'user-documentation/moderne-cli/how-to-guides/afterburner', - 'user-documentation/moderne-cli/how-to-guides/build-steps', - 'user-documentation/moderne-cli/how-to-guides/cli-upgrade', 'user-documentation/moderne-cli/how-to-guides/ssh-key', + 'user-documentation/moderne-cli/how-to-guides/layer-config-cli', + 'user-documentation/moderne-cli/how-to-guides/jdk-selection-and-config', + 'user-documentation/moderne-cli/how-to-guides/execute-user-supplied-commands', + 'user-documentation/moderne-cli/how-to-guides/on-prem-scm-config', + 'user-documentation/moderne-cli/how-to-guides/build-steps', + + ], }, 'user-documentation/moderne-cli/cli-reference',