Skip to content

Commit

Permalink
Update admin platform titles/desc
Browse files Browse the repository at this point in the history
  • Loading branch information
mike-solomon committed Jan 27, 2025
1 parent e38b371 commit b9c6325
Show file tree
Hide file tree
Showing 26 changed files with 132 additions and 4 deletions.
5 changes: 5 additions & 0 deletions docs/administrator-documentation/moderne-platform/faq.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
sidebar_label: FAQ
description: Frequently asked questions related to administrating the Moderne Platform.
---

# Frequently asked questions (FAQ)

## Why do artifact scanners detect vulnerabilities in recipe artifacts/JARs?
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
sidebar_label: Admin pages explained
description: Provides detailed information about all of the admin pages.
---

# Admin pages explained

As an administrator (admin) in the Moderne Platform, you have access to a variety of admin pages that let you manage and control various aspects of the platform. To help ensure you can perform your administrative tasks efficiently and effectively, let's walk through each of these pages.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
sidebar_label: Proof of value process
description: Describes what a typical proof of value process looks like.
---

import ReactPlayer from 'react-player';

# Proof of value process
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
---
sidebar_label: Configuring the Moderne agent
description: Detailed instructions for configuring the Moderne agent.
slug: /administrator-documentation/moderne-platform/how-to-guides/agent-configuration/agent-configuration
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
sidebar_label: All agent variables
description: A reference manual that contains all agent configuration variables.
---

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: HTTP proxy configuration
description: How to configure the Moderne agent to connect to Moderne via an HTTP proxy.
---

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: Artifactory LST configuration
description: How to configure the Moderne agent to retrieve LST artifacts from Artifactory.
---

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: Azure DevOps configuration
description: How to configure the Moderne agent to communicate with Azure DevOps Services.
---

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,14 @@
---
sidebar_label: Client SSL certificate configuration
description: How to configure the Moderne agent with client SSL certificates.
---

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

# Configure an agent with client SSL certificates

If you are configuring the Moderne agent to connect to a service that requires a self-signed certificate to perform a HTTPS request (e.g., Maven or Artifactory) you will need to:
If you are configuring the Moderne agent to connect to a service that requires a self-signed certificate to perform an HTTPS request (e.g., Maven or Artifactory) you will need to:

* Supply a KeyStore for the agent to use in the `PKCS12` format at the following location: `${JAVA_HOME}/lib/security/client_keystore.p12`
* Configure the agent to `skipSSL` for this service (See the [Artifactory](./configuring-artifactory-with-recipes.md) or [Maven](./configure-an-agent-with-maven-repository-access.md) agent documentation)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
sidebar_label: HTTP tool configuration
description: How to configure the Moderne agent with generic HTTP tools so they can be used in recipes.
---


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: GitHub configuration
description: How to configure the Moderne agent to communicate with GitHub.
---

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: GitLab configuration
description: How to configure the Moderne agent to communicate with GitLab.
---

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: Maven repository configuration
description: How to configure the Moderne agent to communicate with Maven repositories.
---

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: PyPI visualizations configuration
description: How to configure the Moderne agent to retrieve visualization artifacts from your PyPI repository.
---

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: Strict recipe source configuration
description: How to configure the Moderne agent to have strict recipe sources.
---

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: Bitbucket Cloud configuration
description: How to configure the Moderne agent to communicate with Bitbucket Cloud.
---

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: Bitbucket Data center configuration
description: How to configure the Moderne agent to communicate with Bitbucket Data Center.
---

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: Organizations service configuration
description: How to configure the Moderne agent to access your Organizations service.
---

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: Artifactory recipe configuration
description: How to configure the Moderne agent to retrieve recipe artifacts from Artifactory.
---

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: Multi-tentant private recipes
description: How to upload and deploy company-specific recipes in a private way.
---

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: Creating visualizations
description: How to create visualizations to better understand data generated by recipes.
---

# How to create visualizations

Visualizations provide a unique way of looking at the data generated by specific recipes. A visualization could be a complex image that you can zoom in and out of to examine connections between nodes or it could be as simple as a text-based table that you can filter or search.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
sidebar_label: Configuring the DevCenter
description: How to create and configure a Moderne DevCenter to get high-level details about your repositories.
---

# Configuring the DevCenter

The Moderne DevCenter is the mission-control dashboard of the Moderne Platform. It provides you with high-level details about the state of all of your repositories. Using it, you can track the progress of upgrades, migrations, and security vulnerabilities. You can also use it to view [key visualizations](../../../user-documentation/moderne-platform/getting-started/visualizations.md) you care about – such as a dependency graph or a SQL operation usage chart.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,11 @@
---
sidebar_label: Importing external recipes
description: How to import external recipes.
---

# Importing external recipes

External recipes can be imported into Moderne.io for use by your organization.
External recipes can be imported into Moderne for use by your organization.

:::tip
It is the responsibility of the administrator configuring this to ensure that the recipe JARs and versions are up-to-date. It is also their responsibility to select/curate the recipe JARs that should be uploaded.
Expand Down Expand Up @@ -37,10 +42,10 @@ From your Moderne tenant, click on _Deploy_ in the left-hand menu:

3. Click _deploy recipe artifact_ to deploy it.

The artifact information will appear in the table if Moderne.io successfully locates the requested artifact.
The artifact information will appear in the table if Moderne successfully locates the requested artifact.

**Note:** If you have an [on-premise agent](./agent-configuration/agent-config.md) connected to an Artifactory instance that has been configured to serve recipes, we will look up recipes in your Artifactory repositories in addition to [Nexus](https://oss.sonatype.org/) and [Maven Central](https://search.maven.org/).

## Step 3: View recipes in the catalog

Your custom recipes will appear in the Marketplace and they will be discoverable through search once they have been successfully deployed.
Your custom recipes will appear in the Marketplace, and they will be discoverable through search once they have been successfully deployed.
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
sidebar_label: Cleaning up LSTs
description: How to clean up old or outdated LSTs.
---

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: Setting up mass ingest
description: Instructions for ingesting a large number of repositories with Moderne.
---

# Mass ingest

One of the first steps of integrating your code with Moderne is setting up a pipeline that builds and publishes [LST](../references/lossless-semantic-trees.md) artifacts to an artifact repository that you control.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
sidebar_label: Configuring the Organizations service
description: How to create and configure an Organizations service to group repositories.
---

# Configuring the Organizations service

Many organizations desire the ability to dynamically control the organizational structure (repository groupings) of their repositories within the Moderne Platform. To facilitate this need, Moderne provides an optional integration with an Organizations service that is hosted in your environment.
Expand Down

0 comments on commit b9c6325

Please sign in to comment.