Skip to content

Commit

Permalink
Update cli how-to titles/desc
Browse files Browse the repository at this point in the history
  • Loading branch information
mike-solomon committed Jan 27, 2025
1 parent c33d97d commit 8c9a840
Show file tree
Hide file tree
Showing 14 changed files with 74 additions and 7 deletions.
5 changes: 5 additions & 0 deletions docs/user-documentation/moderne-cli/cli-reference.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
sidebar_label: Reference manual
description: Auto-generated documentation for all Moderne CLI commands.
---

# Moderne CLI reference

## Table of contents
Expand Down
5 changes: 5 additions & 0 deletions docs/user-documentation/moderne-cli/faq.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
sidebar_label: FAQ
description: A list of frequently asked questions about the Moderne CLI.
---

# FAQ

## Invalid entry compressed size exception
Expand Down
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
Original file line number Diff line number Diff line change
@@ -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';

Expand Down
Original file line number Diff line number Diff line change
@@ -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
Expand Down
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
Original file line number Diff line number Diff line change
@@ -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:
Expand Down
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
Original file line number Diff line number Diff line change
@@ -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?
Expand Down
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
5 changes: 5 additions & 0 deletions docs/user-documentation/moderne-cli/how-to-guides/ssh-key.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
14 changes: 8 additions & 6 deletions sidebars.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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',
Expand Down

0 comments on commit 8c9a840

Please sign in to comment.