Skip to content

Commit 65a1401

Browse files
Cristian-VenticinqueCristian-Venticinque
committed
Adding new Working with Workspaces topic.
Updating references. Removing duplicated content and linking. Removing duplicated page alias.
1 parent 35cd0aa commit 65a1401

4 files changed

Lines changed: 138 additions & 39 deletions

File tree

‎modules/ROOT/nav.adoc‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@
1212
** xref:start-add-folders.adoc[]
1313
** xref:start-open-output-panel.adoc[]
1414
** xref:start-scm.adoc[]
15+
** xref:start-workspaces.adoc[]
1516
1617
// TUTORIALS
1718
* xref:tutorials.adoc[]

‎modules/ROOT/pages/imp-implement-local-apis.adoc‎

Lines changed: 5 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,9 @@ For your projects to work properly, the `.code-workspace` file _must not reside_
3636

3737
In addition, Anypoint Code Builder permits only one pair of iterative design and implementation project folders per multi-root workspace.
3838

39-
For more information, see https://code.visualstudio.com/docs/editor/multi-root-workspaces[Multi-root Workspaces^] in the VS Code documentation.
39+
For general information about using workspaces in Anypoint Code Builder, see xref:start-workspaces.adoc[].
40+
41+
For more information about VS Code workspaces, see https://code.visualstudio.com/docs/editor/multi-root-workspaces[Multi-root Workspaces^] in the VS Code documentation.
4042

4143

4244
== Before You Begin
@@ -120,7 +122,7 @@ which you then implement within a Mule application.
120122
You can switch between the spec and the implementation project in the Explorer view.
121123

122124

123-
To close your multi-root workspace, see <<close-workspace>>.
125+
To close or reopen your workspace later, see xref:start-workspaces.adoc[Working with Workspaces].
124126

125127

126128
[[rescaffold-api-spec]]
@@ -143,42 +145,7 @@ After you see the message that your project was rescaffolded successfully, navig
143145
//TODO:
144146
// ADD NOTE ABOUT caveats for rescaffolding AsyncAPI specs?
145147

146-
[[close-workspace]]
147-
== Close a Multi-Root Workspace
148-
149-
To close the workspace:
150-
151-
// Pointer to Command Palette
152-
include::partial$acb-reusable-steps.adoc[tags="open-command-palette"]
153-
. Select the following command:
154-
+
155-
[source,command]
156-
----
157-
Workspaces: Close Workspace
158-
----
159-
160-
After closing, you can reopen a synchronized project from the workspace that you created when implementing the API.
161-
See <<open-workspace>>.
162-
163-
[[open-workspace]]
164-
== Open a Multi-Root Workspace
165-
166-
To open a multi-root workspace from the `.code-workspace` file:
167-
168-
// Pointer to Command Palette
169-
include::partial$acb-reusable-steps.adoc[tags="open-command-palette"]
170-
. Select the following command:
171-
+
172-
[source,command]
173-
----
174-
File: Open Workspace from File...
175-
----
176-
. Navigate to your home directory and double-click the `.code-workspace` file for the workspace.
177-
+
178-
The projects open in the Explorer view, and the folder name for the multi-root workspace includes *(WORKSPACE)*, for example:
179-
+
180-
image::imp-local-api-open-workspace.png["A multi-root workspace in Explorer view"]
181-
182148
== See Also
183149

150+
* xref:start-workspaces.adoc[]
184151
* xref:tut-local-api-specification.adoc[] Tutorial

‎modules/ROOT/pages/start-workspaces.adoc‎

Lines changed: 132 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,132 @@
1+
= Working with Workspaces
2+
:page-deployment-options: cloud-ide, desktop-ide
3+
4+
include::reuse::partial$beta-banner.adoc[tag="anypoint-code-builder"]
5+
6+
Organize your Mule projects, API specifications, and agent networks in workspaces to ensure all Anypoint Code Builder features work correctly. Workspaces help you manage multiple related projects and avoid build-time and design-time issues.
7+
8+
[[valid-setups]]
9+
== Valid Setups for Anypoint Code Builder
10+
11+
Anypoint Code Builder requires one of the following project configurations to function properly:
12+
13+
* A single Mule project open at the root of your directory
14+
* A multi-root workspace pointing directly to one or more Mule projects
15+
16+
If your directory structure doesn't meet these requirements, Anypoint Code Builder displays a message with steps to resolve the issue, such as opening a Mule project or creating a workspace.
17+
18+
[[create-project-workspace]]
19+
== Create a Project in a Workspace
20+
21+
When you create a new project (API specification, integration, or agent network), add it to a workspace. This setup enables you to add more projects later without restructuring your environment.
22+
23+
To create a project in a workspace:
24+
25+
. Start the project creation process using one of the following methods:
26+
+
27+
** From the *Quick Actions* menu, select the project type
28+
+
29+
For example, *Design an API* or *Develop an Integration*.
30+
** From the Command Palette, run the appropriate command
31+
+
32+
For example, `MuleSoft: Design an API`.
33+
** Ask MuleSoft Vibes to create the project using natural language.
34+
35+
. In the project creation form, select *Create in workspace*.
36+
. Complete the remaining project configuration options.
37+
. Click *Create Project*.
38+
+
39+
Anypoint Code Builder creates the project and adds it to a workspace. If no workspace is open, a new workspace is created.
40+
41+
[[import-studio-workspace]]
42+
== Import an Anypoint Studio Workspace
43+
44+
If you have existing projects in Anypoint Studio, you can import your Studio workspace into Anypoint Code Builder.
45+
46+
To import a Studio workspace:
47+
48+
// Pointer to Command Palette
49+
include::partial$acb-reusable-steps.adoc[tags="open-command-palette"]
50+
. Select the following command:
51+
+
52+
[source,command]
53+
----
54+
MuleSoft: Import Studio Workspace
55+
----
56+
. Navigate to the location of your Studio workspace and select it.
57+
. Choose a location to save the new workspace file.
58+
+
59+
Anypoint Code Builder creates a workspace that references your existing Studio projects. Changes made to the original Studio workspace are automatically reflected in Anypoint Code Builder.
60+
61+
[[switch-workspaces]]
62+
== Open and Switch Between Workspaces
63+
64+
You can open or switch between workspaces using the menu, the Command Palette, or MuleSoft Vibes.
65+
66+
=== Open a Workspace Manually
67+
68+
. Open the workspace file using one of these methods:
69+
+
70+
* From the menu bar, select *File* > *Open Workspace from File...*.
71+
* From the Command Palette, run the command `File: Open Workspace from File...`.
72+
. Navigate to your home directory or the location where you saved the `.code-workspace` file, and select it.
73+
+
74+
The projects open in the Explorer view, and the folder name for the workspace includes *(WORKSPACE)* to indicate that you're working in a multi-root workspace:
75+
+
76+
image::imp-local-api-open-workspace.png["A multi-root workspace in Explorer view"]
77+
78+
=== Open a Workspace with MuleSoft Vibes
79+
80+
You can ask MuleSoft Vibes to switch workspaces using natural language prompts, such as:
81+
82+
* "Open my American Flights workspace"
83+
* "Switch to the `<YourWorkspaceName>` workspace"
84+
85+
[[close-workspace]]
86+
== Close a Workspace
87+
88+
To close the current workspace:
89+
90+
// Pointer to Command Palette
91+
include::partial$acb-reusable-steps.adoc[tags="open-command-palette"]
92+
. Select the following command:
93+
+
94+
[source,command]
95+
----
96+
Workspaces: Close Workspace
97+
----
98+
99+
[[actions-in-workspaces]]
100+
== Actions in Workspaces
101+
102+
Anypoint Code Builder organizes actions based on their scope:
103+
104+
[cols="1,2"]
105+
|===
106+
| Action Type | Location
107+
108+
| *Global actions*
109+
| Always available from the Command Palette. These actions don't depend on a specific project, such as creating a new project, importing assets from Exchange, or opening ACB settings.
110+
111+
| *Project-specific actions*
112+
| Available from the context menu (right-click) in the Explorer view. These actions apply to a specific project, such as running, debugging, deploying, or exporting a project.
113+
|===
114+
115+
When working with multiple projects in a workspace, select the target project before running project-specific actions. For example, when you run or debug, you must select which project in the workspace to execute.
116+
117+
[[workspace-file]]
118+
== Workspace File Location
119+
120+
VS Code stores workspace configuration in a file with the `.code-workspace` extension. This file maps the folders for your projects.
121+
122+
[IMPORTANT]
123+
====
124+
The `.code-workspace` file must not reside within any of your project folders. Save it in a separate directory, such as your home directory or a dedicated workspaces folder.
125+
====
126+
127+
== See Also
128+
129+
* xref:imp-implement-local-apis.adoc[Iteratively Design and Implement APIs]
130+
* xref:int-create-integrations.adoc[Creating Integrations]
131+
* xref:des-create-api-specs.adoc[Creating and Importing API Specifications]
132+
* https://code.visualstudio.com/docs/editor/multi-root-workspaces[Multi-root Workspaces^] in the VS Code documentation

‎modules/ROOT/pages/vibes-conversation-history.adoc‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
= View Conversation History
2-
:page-aliases: a4d-mcp-server.adoc
32

43
MuleSoft Vibes allows you to return to tasks you have previously started and continue working from where you left off.
54

0 commit comments

Comments
 (0)