From 82c0e845c92615dcc720db227d7a0642feaac220 Mon Sep 17 00:00:00 2001 From: Daniel Warner Date: Fri, 17 Nov 2023 18:17:51 -0500 Subject: [PATCH 1/2] update text on record appmaps page --- .../record-instructions/IntelliJ.vue | 73 +++++++++---------- .../record-instructions/Java.vue | 55 +++++++------- .../record-instructions/Python.vue | 45 ++++++------ .../record-instructions/Ruby.vue | 65 ++++++++--------- .../record-instructions/TestsPrompt.vue | 7 +- .../WebFrameworkPrompt.vue | 7 +- 6 files changed, 128 insertions(+), 124 deletions(-) diff --git a/packages/components/src/components/install-guide/record-instructions/IntelliJ.vue b/packages/components/src/components/install-guide/record-instructions/IntelliJ.vue index e1283fbf39..48f0f6164b 100644 --- a/packages/components/src/components/install-guide/record-instructions/IntelliJ.vue +++ b/packages/components/src/components/install-guide/record-instructions/IntelliJ.vue @@ -1,5 +1,8 @@ @@ -71,53 +76,47 @@

Remote recording -

+

- Did you know? When you run a Spring app, you can make AppMaps of all the HTTP requests - served by your app. Spring wasn't detected in this project, though. + When you run a Spring app, you can make AppMaps of all the HTTP requests + served by your app.

+

Spring was not detected in this project.


Process recording -

+
+

Record an entire Java process from startup to teardown.


- AppMap can record an entire Java process from start to finish. To use process recording, run - your application using + To use process recording, run your application using "Start with AppMap". When your application exits, the AppMap will be saved and opened. -

+


- Visit + Docs: AppMap Docs - Java Process recordingJava process recording - for more information.


- Code Block recording -

+ Code Block recording +

- You can use the AppMap Java library directly to record a specific span of code. With this - method, you can control exactly what code is recorded, and where the recording is saved. To + With this method, you can control exactly which code spans are recorded. +


+

+ You can use the AppMap Java library directly to record a specific span of code. To use code block recording, add an AppMap code snippet to the section of code you want to record, then run your application using - "Start with AppMap". -

-

- Visit - AppMap Docs - Java Code Block recording - for more information. + "Start with AppMap". Instructions for adding the AppMap code snippet to a span of code can be + found in our documentation.

@@ -126,7 +125,7 @@ import TestsIcon from '@/assets/tests-icon.svg'; import RemoteRecordingIcon from '@/assets/remote-recording-icon.svg'; import ProcessIcon from '@/assets/process-icon.svg'; -import PlayIcon from '@/assets/play-icon.svg'; +import CodeBlockIcon from '@/assets/code-block-icon.svg'; import VRunConfigDark from '@/assets/jetbrains_run_config_execute_dark.svg'; import VRunConfigLight from '@/assets/jetbrains_run_config_execute.svg'; import VTestsPrompt from './TestsPrompt.vue'; @@ -144,7 +143,7 @@ export default { VRunConfigDark, VRunConfigLight, VTestsPrompt, - PlayIcon, + CodeBlockIcon, ProcessIcon, RemoteRecordingIcon, TestsIcon, diff --git a/packages/components/src/components/install-guide/record-instructions/Java.vue b/packages/components/src/components/install-guide/record-instructions/Java.vue index e867226603..1f232e8fc4 100644 --- a/packages/components/src/components/install-guide/record-instructions/Java.vue +++ b/packages/components/src/components/install-guide/record-instructions/Java.vue @@ -1,5 +1,8 @@ @@ -38,7 +42,8 @@

Requests recording -

+
+

Create AppMaps as you interact with your applications UI or API. This is helpful for tracing the backend during specific usage scenarios.


When your application uses Django or Flask, and you run your application with AppMap enabled, HTTP server requests recording is enabled. To record requests, first run your @@ -46,26 +51,25 @@


- Start your Django server: + Start your Django server with AppMap enabled:

- Start your Flask server: + Start your Flask server with AppMap enabled:

-

Then, interact with your application through its user interface and/or by making API requests using a tool such as Postman. An AppMap will be created for each HTTP server request that's served by your app. -

+


- For more information, visit + Docs: AppMap docs - Python Requests recording. + >Python requests recording

@@ -73,18 +77,13 @@

Context manager recording -

+

- You can use the AppMap Python package directly to record a specific span of code. With this - method, you can control exactly what code is recorded, and where the recording is saved. To + You can use the AppMap Python package directly to record a specific span of code.


+

With this method, you can control exactly what code is recorded, and where the recording is saved. To use Context manager recording, add an AppMap code snippet to the section of code you want to - record, then run your application with AppMap enabled. Visit - AppMap Docs - Python Context manager recording - for more information. + record, then run your application with AppMap enabled. Instructions for adding the AppMap code snippet to a span of code can be + found in our documentation.

diff --git a/packages/components/src/components/install-guide/record-instructions/Ruby.vue b/packages/components/src/components/install-guide/record-instructions/Ruby.vue index 1670f4aa9c..b55dfd350e 100644 --- a/packages/components/src/components/install-guide/record-instructions/Ruby.vue +++ b/packages/components/src/components/install-guide/record-instructions/Ruby.vue @@ -1,5 +1,8 @@ @@ -91,17 +92,15 @@

Block recording -

+
+

+ With this method, you can control exactly which code spans are recorded. +


- You can use the AppMap Ruby gem directly to record a specific span of code. With this - method, you can control exactly what code is recorded, and where the recording is saved. To - use Block recording, add an AppMap code snippet to the section of code you want to record, - then run your application with AppMap enabled. Visit - AppMap Docs - Ruby Block recording - for more information. -

+ To use Block recording, add an AppMap code snippet to the section of code you want to record, + then run your application with AppMap enabled. Instructions for adding the AppMap code snippet to a span of code can be + found in our documentation. +


diff --git a/packages/components/src/components/install-guide/record-instructions/TestsPrompt.vue b/packages/components/src/components/install-guide/record-instructions/TestsPrompt.vue index a56caf2f5e..8eb5ad8ef5 100644 --- a/packages/components/src/components/install-guide/record-instructions/TestsPrompt.vue +++ b/packages/components/src/components/install-guide/record-instructions/TestsPrompt.vue @@ -2,10 +2,11 @@

Tests recording -

+

- Did you know? If you use a test framework such as {{ framework }}, you can make AppMaps of all - your test cases. Tests weren't detected in this project, though. + If you use a test framework such as {{ framework }}, you can make AppMaps of all + your test cases.

+

No tests were detected in this project.

diff --git a/packages/components/src/components/install-guide/record-instructions/WebFrameworkPrompt.vue b/packages/components/src/components/install-guide/record-instructions/WebFrameworkPrompt.vue index 5103fd6cfb..185a0eff2b 100644 --- a/packages/components/src/components/install-guide/record-instructions/WebFrameworkPrompt.vue +++ b/packages/components/src/components/install-guide/record-instructions/WebFrameworkPrompt.vue @@ -2,10 +2,11 @@

Requests recording -

+

- Did you know? When you run a {{ this.frameworks }} app, you can make AppMaps of all the HTTP - requests served by your app. {{ this.frameworks }} wasn't detected in this project, though. + When you run a {{ this.frameworks }} app, you can make AppMaps of all the HTTP + requests served by your app.

+

{{ this.frameworks }} was not detected in this project.

From aaa1dba827c04e98978522153a5fb30fb84920ca Mon Sep 17 00:00:00 2001 From: Daniel Warner Date: Mon, 20 Nov 2023 14:05:44 -0500 Subject: [PATCH 2/2] fix formatting issues --- .../record-instructions/IntelliJ.vue | 76 ++++++++++++------- .../record-instructions/Java.vue | 56 +++++++++----- .../record-instructions/Python.vue | 51 +++++++++---- .../record-instructions/Ruby.vue | 74 +++++++++++------- .../record-instructions/TestsPrompt.vue | 9 ++- .../WebFrameworkPrompt.vue | 9 ++- 6 files changed, 180 insertions(+), 95 deletions(-) diff --git a/packages/components/src/components/install-guide/record-instructions/IntelliJ.vue b/packages/components/src/components/install-guide/record-instructions/IntelliJ.vue index 48f0f6164b..9b8c583789 100644 --- a/packages/components/src/components/install-guide/record-instructions/IntelliJ.vue +++ b/packages/components/src/components/install-guide/record-instructions/IntelliJ.vue @@ -1,8 +1,11 @@

Process recording -


-

Record an entire Java process from startup to teardown.


+ +
+

Record an entire Java process from startup to teardown.

+

To use process recording, run your application using "Start with AppMap". When your application exits, the AppMap will be saved and opened. -


+

+

Docs:

Code Block recording -


-

- With this method, you can control exactly which code spans are recorded. -


+ +
+

With this method, you can control exactly which code spans are recorded.

+

- You can use the AppMap Java library directly to record a specific span of code. To - use code block recording, add an AppMap code snippet to the section of code you want to - record, then run your application using - "Start with AppMap". Instructions for adding the AppMap code snippet to a span of code can be - found in our documentation. + You can use the AppMap Java library directly to record a specific span of code. To use code + block recording, add an AppMap code snippet to the section of code you want to record, then + run your application using + "Start with AppMap". Instructions + for adding the AppMap code snippet to a span of code can be + found in our documentation.

diff --git a/packages/components/src/components/install-guide/record-instructions/Java.vue b/packages/components/src/components/install-guide/record-instructions/Java.vue index 1f232e8fc4..0d1ae85782 100644 --- a/packages/components/src/components/install-guide/record-instructions/Java.vue +++ b/packages/components/src/components/install-guide/record-instructions/Java.vue @@ -1,8 +1,11 @@

Docs:

Requests recording -


-

Create AppMaps as you interact with your applications UI or API. This is helpful for tracing the backend during specific usage scenarios.


+ +
+

+ Create AppMaps as you interact with your applications UI or API. This is helpful for + tracing the backend during specific usage scenarios. +

+

When your application uses Django or Flask, and you run your application with AppMap enabled, HTTP server requests recording is enabled. To record requests, first run your @@ -62,7 +75,8 @@ Then, interact with your application through its user interface and/or by making API requests using a tool such as Postman. An AppMap will be created for each HTTP server request that's served by your app. -


+

+

Docs:

Context manager recording -


+ +
+

You can use the AppMap Python package directly to record a specific span of code.

+

- You can use the AppMap Python package directly to record a specific span of code.


-

With this method, you can control exactly what code is recorded, and where the recording is saved. To - use Context manager recording, add an AppMap code snippet to the section of code you want to - record, then run your application with AppMap enabled. Instructions for adding the AppMap code snippet to a span of code can be - found in our documentation. + With this method, you can control exactly what code is recorded, and where the recording is + saved. To use Context manager recording, add an AppMap code snippet to the section of code + you want to record, then run your application with AppMap enabled. Instructions for adding + the AppMap code snippet to a span of code can be + found in our documentation.

diff --git a/packages/components/src/components/install-guide/record-instructions/Ruby.vue b/packages/components/src/components/install-guide/record-instructions/Ruby.vue index b55dfd350e..b3bc72e305 100644 --- a/packages/components/src/components/install-guide/record-instructions/Ruby.vue +++ b/packages/components/src/components/install-guide/record-instructions/Ruby.vue @@ -1,8 +1,10 @@