Skip to content

Commit

Permalink
feat: Sync docs from applandinc.appmap.io
Browse files Browse the repository at this point in the history
  • Loading branch information
Daniel-Warner-X authored and github-actions[bot] committed Dec 9, 2024
1 parent 71d0c33 commit e99c4a6
Show file tree
Hide file tree
Showing 6 changed files with 201 additions and 3 deletions.
62 changes: 62 additions & 0 deletions docs/get-started-with-appmap/navie-ai-quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ redirect_from: [/docs/setup-appmap-in-your-code-editor/navie-ai-quickstart]
- [Open AppMap Navie AI](#open-appmap-navie-ai)
- [Ask Navie about your App](#ask-navie-about-your-app)
- [Improve Navie AI Responses with AppMap Data](#improve-navie-ai-responses-with-appmap-data)
- [Using Navie with JetBrains IDEs + Corporate-provided Github Copilot LLM Backend](#using-navie-with-jetbrains-ides--corporate-provided-github-copilot-llm-backend)
- [Next Steps](#next-steps)

## Choose your AI Provider (Optional)
Expand Down Expand Up @@ -56,6 +57,11 @@ The Navie UI includes a standard chat window, and a context panel which will inc
- SQL Queries
- Other I/O Data

**Navie will look for the files listed above in the following locations:**
- The currently open project
- All workspace folders in Visual Studio Code
- All modules available in JetBrains IDEs

![Navie Context Window](/assets/img/navie-context-window.webp)

## Improve Navie AI Responses with AppMap Data
Expand All @@ -72,6 +78,62 @@ With this AppMap Data in your project, asking questions to Navie will now includ

![Navie AppMap context window 2](/assets/img/navie-appmap-context-window.webp)

## Using Navie with JetBrains IDEs + Corporate-provided GitHub Copilot LLM backend

Organizations that must use Copilot language models and primarily use JetBrains IDEs, such as IntelliJ, must install AppMap in both IntelliJ and Visual Studio Code to access the full features of AppMap's Navie AI Software Architect. This setup allows you to toggle between the two environments and integrate AI capabilities into your development tools.

AppMap Navie, backed by GitHub Copilot language models, is exclusively available within the Visual Studio Code.

![IntelliJ with Corporate Backend Diagram](/assets/img/docs/intellij-with-corp-copilot-backend.png)

### Step-by-Step Installation Instructions for using JetBrains IDEs with Corporate-provided GitHub Copilot LLM backend


**Visual Studio Code Setup**

<ol>
<li>Install Visual Studio Code </li>
<li>Install Copilot in Visual Studio Code </li>
<li>Install AppMap in Visual Studio Code</li>
<li>Sign in to AppMap using your corporate email address. AppMap Navie will connect to Copilot automatically. If you don’t see a message confirming this, try reloading the window or contact AppMap support at <a href="mailto:[email protected]">[email protected]</a>.</li>
<li>Open your project in Visual Studio Code. Confirm that your code is visible in Visual Studio Code in the Workspace / Explorer View.</li>
</ol>

**JetBrains IDE Setup**

<ol start="6">
<li>Install the AppMap plugin for JetBrains</li>
<li>Sign in to AppMap using your company email address</li>
</ol>

**Make AppMap Data to enhance the responses of Navie AI**

<ol start="8">
<li><a href="https://appmap.io/docs/get-started-with-appmap/making-appmap-data.html">Make AppMap Observability Data (if desired).</a></li>
<li> After making AppMap data, confirm that AppMap data files are available in the AppMap plugin panel</li>
</ol>

**Use Navie AI in Visual Studio Code**

<ol start="10">
<li>Return to Visual Studio Code</li>
<li>Open the AppMap sidebar panel, confirm that AppMap data files are visible</li>
<li>Open Navie using the “New Navie Chat” button, or run the command “AppMap: Ask Navie AI”
<img src="/assets/img/docs/navie-from-the-command-window.png" alt="Navie from the command window in Visual Studio Code"/>
</li>
<li>Ask Navie a question or request a diagram of your code.</li>
<li>Select some code in a code editor, then open Navie. You’ll be chatting about the selected code.</li>
<li>Drag and drop a file into a Navie chat, while using the Shift key. You’ll be chatting about the selected file. It can also contain prompt information, such as instructions that you want Navie to follow.</li>
</ol>

**Clean Up**

When you are done with a task, run “Delete All AppMaps” from the command window.
<img src="/assets/img/docs/delete-all-appmaps-command.png" alt="Delete all AppMaps command in Visual Studio Code"/>

Keep the AppMap data in your workspace focused on the task that you are working on. This will ensure that Navie references the most recent and relevant information available.


## Next Steps

Continue to ask questions to Navie, creating new code for your application, and continue to generate additional AppMap Data as your code changes. On each subsequent question asked, Navie will re-query your AppMap Data, traces, data flows, and source code for your project to power the context for the answer.
Expand Down
37 changes: 37 additions & 0 deletions docs/navie-reference/navie-bring-your-own-model-examples.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ redirect_from: [/docs/navie-reference/navie-copilot-backend]
# Bring Your Own Model Examples

- [GitHub Copilot Language Model](#github-copilot-language-model)
- [Changing the Copilot Language Model](#changing-the-copilot-language-model)
- [Google Gemini](#google-gemini)
- [OpenAI](#openai)
- [Anthropic (Claude)](#anthropic-claude)
- [Azure OpenAI](#azure-openai)
Expand Down Expand Up @@ -69,10 +71,45 @@ If you have the Copilot extension installed, but have not signed in, you'll see

Click the `Sign in to GitHub` and login with an account that has a valid paid or trial GitHub Copilot subscription.

#### Changing the Copilot Language Model

GitHub Copilot supports a variety of different language models. Use the VS Code command "AppMap: Select Copilot Model" in the command palette.

To open the Command Palette.

You can use a hotkey to open the VS Code Command Palette
- Mac: `Cmd + Shift + P`
- Windows/Linux: `Ctrl + Shift + P`

Search for `AppMap: Select Copilot Model` in the command palette.

![Select copilot model](/assets/img/product/select-copilot-model-1.webp)

Then select the specific model you'd like to use with AppMap Navie

![Select copilot model](/assets/img/product/select-copilot-model-2.webp)

#### Video Demo <!-- omit in toc -->

{% include vimeo.html id='992238965' %}

## Google Gemini

After configuring your [Google Cloud authentication keys](https://cloud.google.com/docs/authentication/api-keys) and ensuring you have access to the Google Gemini services on your Google Cloud account, configure the following environment variables in your VS Code editor. [Refer to the Navie documentation](/docs/using-navie-ai/bring-your-own-model.html#configuring-in-vs-code) for more details on where to set the Navie environment variables.

| `GOOGLE_WEB_CREDENTIALS` | `[contents of downloaded JSON]`
| `APPMAP_NAVIE_MODEL` | `gemini-1.5-pro-002`
| `APPMAP_NAVIE_COMPLETION_BACKEND` | `vertex-ai`

![Configure navie environment variables](/assets/img/product/navie-gemini-config-1.webp)

***NOTE:*** If your code editor previously used the default GitHub Copilot backend, open the "gear" icon in the Navie chat window to reset the language model setting to use the environment variables instead by selecting "Use AppMap Hosted Provider". This will disable the GitHub Copilot Language Model backend and will by default use your environment variable configuration.

![use appmap model to disable copilot as a backend](/assets/img/product/navie-llm-configuration.webp)

You can confirm your model and API endpoint after making this change in the Navie chat window, which will display the currently configured language model backend.
![confirm LLM backend and api endpoint](/assets/img/product/navie-gemini-config-2.webp)

## OpenAI

**Note:** We recommend configuring your OpenAI key using the code editor extension. Follow the [Bring Your Own Key](/docs/using-navie-ai/bring-your-own-model.html#configuring-your-openai-key) docs for instructions. The configuration options below are for advanced users.
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/appmap-airgapped-install.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: "Learn how to install AppMap components like IDE plugins, libraries
toc: true
reference: true
name: AppMap Offline Install for Secure Environments
step: 19
step: 20
---

# AppMap Offline Install for Secure Environments
Expand Down
4 changes: 3 additions & 1 deletion docs/reference/appmap-java.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,9 +71,11 @@ the JVM. This is done by passing the `-javaagent` argument to your
JVM when recording tests. For example:

```shell
$ java -javaagent:$HOME/.appmap/lib/java/appmap.jar myapp.jar
$ java -javaagent:$HOME/.appmap/lib/java/appmap.jar -jar myapp.jar
```

Note that, when using the <code>-jar</code> option as described above, the <code>-javaagent</code> argument must come first. Otherwise, the agent will not be loaded.

## Requests recording

`appmap-java` can automatically record and save an AppMap for each HTTP server request which it processes. This functionality is currently supported for applications built using [Spring Boot](https://spring.io/projects/spring-boot), Servlet-stack web applications built using [Spring Framework](https://docs.spring.io/spring-framework/reference/web.html), and [Spark Framework](http://sparkjava.com/).
Expand Down
97 changes: 97 additions & 0 deletions docs/reference/subscriptions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,97 @@
---
layout: docs
title: Docs - Reference
description: "Complete guide to managing AppMap subscriptions, including how to subscribe, manage users, and unsubscribe for personal, team, and enterprise licenses."
toc: true
reference: true
step: 19
name: Subscription Management
---

# Subscription Management

This guide explains how to manage your AppMap subscription throughout its lifecycle, from initial setup through cancellation. The procedures differ based on your license type:

- **Pro:** Purchase through Stripe to activate your Personal subscription. For Team subscriptions, you'll manage an organization with
assistance from AppMap support.
- **Enterprise:** Managed through the AppMap sales team.

Terms of the Community, Pro, and Enterprise tiers are detailed on the [Pricing page](/pricing.html).

## Activating AppMap with a License Key

Before you subscribe, you'll obtain a license key. This is typically performed from within the AppMap extension for your code editor.
For more details, follow the [license key installation instructions](/docs/reference/license-key-install).

## Community Tier

Once you've activated AppMap with a license key, you'll have access to the Community tier.

The Community tier is subject to limitations, such as the maximum number of Navie AI conversations you can have in a 7 day period.

## Pro Tier

1. Sign in to [getappmap.com](https://getappmap.com) using your email address. You'll be emailed a one-time login code.
2. Go to your Account Settings page and click "Subscribe".
3. You'll be redirected to a checkout page provided by Stripe.
4. Choose your plan (monthly or annual), number of licenses, and enter payment details.
5. Complete the Stripe checkout process.
6. You'll be redirected back to [getappmap.com](https://getappmap.com) when you've successfully subscribed.
7. You can now return to your code editor and start using AppMap Pro!

### Team Licenses

If you buy a license with multiple seats, other users can join your subscription through the use of an AppMap Organization.

You'll need to contact AppMap support at [email protected] to set up your organization. Your organization will be configured
with an domain extension that matches your company's email addresses. All users with email addresses that match the domain
will automatically be joined to your organization.

From the AppMap account settings page, you can manage your organization members. For example, if a team member leaves your organization, you can remove them from your organization.

### Managing Your Subscription

From your Account Settings page, you can access the Stripe billing portal to:

- Update your payment method
- Change the number of seats
- Switch between monthly and annual billing
- View invoices and payment history
- Update billing information

### Canceling Your Subscription

1. Access the Stripe billing portal from your Account Settings page
2. Navigate to "Subscription details"
3. Click "Cancel subscription"
4. Confirm cancellation
- Service continues until end of current billing period

## Enterprise Tier

Enterprise subscriptions are managed in collaboration with the AppMap sales team.
Contact AppMap sales to begin the enterprise subscription process:

- Email: [[email protected]](mailto:[email protected])

Similar to the Pro subscription, you'll be set up with an AppMap Organization. Your users will auto-join to the organization based on their email domain, and you can manage your organization members from the AppMap account settings page.

## Disabling Navie AI Hosted Proxy

If you have a Pro or Enterprise subscription, you can disable the Navie AI hosted proxy for your organization. This setting will prevent
users in your organization from using the Navie AI hosted proxy. This setting is useful if you have a security policy that requires users
to use an approved LLM such as:

* GitHub Copilot
* An internally provided LLM proxy
* Organization-provided LLM API keys

## Troubleshooting

For all subscription-related issues, contact AppMap support at [email protected]

## Additional Resources

- [License Key Installation Guide](/docs/reference/license-key-install)
- [Terms and Conditions](/community/terms-and-conditions)
- [Privacy Policy](/community/privacy-policy)
2 changes: 1 addition & 1 deletion docs/reference/uninstalling-appmap.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: "Learn how to uninstall AppMap components like IDE plugins, librari
toc: true
reference: true
name: Uninstalling AppMap
step: 20
step: 21
---

# Uninstalling AppMap
Expand Down

0 comments on commit e99c4a6

Please sign in to comment.