Skip to content

Commit 89c6852

Browse files
committed
download the docs to a separate folder. It worked the same as it was, but it could be uploading stuff we didn't want.
Also updated the tmsgui screenshots, just to be 100% sure this is working
1 parent 5896a6f commit 89c6852

File tree

6 files changed

+27
-15
lines changed

6 files changed

+27
-15
lines changed

.github/workflows/deploy-to-aws.yml

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ jobs:
2525
uses: actions/download-artifact@v4
2626
with:
2727
name: smartsetup-doc
28+
path: ./smartsetup-doc
2829

2930
- name: Check folder 1
3031
run: pwd
@@ -38,11 +39,8 @@ jobs:
3839
aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
3940
aws-region: us-east-1
4041

41-
- name: Check folder
42-
run: ls -la
43-
44-
- name: Upload documentation files
45-
run: aws s3 sync ./ s3://tms-site-doc/smartsetup
42+
- name: Upload documentation files
43+
run: aws s3 sync ./smartsetup-doc s3://tms-site-doc/smartsetup
4644

4745
- name: Invalidate CDN
4846
run: aws cloudfront create-invalidation --distribution-id E28KJG21XS16K3 --paths "/smartsetup*"

doc/source/guide/gui-tool-usage.md

Lines changed: 24 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -7,23 +7,37 @@ uid: SmartSetup.GUIToolUsage
77

88
Alternatively to command-line, you can use the GUI tool. Just launch `tmsgui.exe` executable.
99

10-
If the working folder is not initialized, it will first ask for credentials to download products from repository. If you skip this step, no credentials will be saved and you can continue using the GUI to build projects that have been manually downloaded:
10+
If the working folder is not initialized, it will first ask you what servers you want to enable:
11+
12+
{{#image}}tmsgui-welcome-dialog.png{{/image}}
13+
14+
Here, you can choose if you want to manage **tms** products, if you want manage products from the **community** server, or both.
15+
16+
If you enable the tms server, you will get another dialog asking you for the credentials:
1117

1218
{{#image}}tmsgui-login.png{{/image}}
1319

14-
The GUI tool lists the installed and available products in the main listing view.
20+
And then you should arrive to the main view:
1521

1622
{{#image}}tmsgui-main-screen.png{{/image}}
1723

18-
At the right, you have some buttons that perform on the selected products:
24+
1. **Search box**: type to find the product you want to install
25+
2. **Filter pane**: select if to see all available products, or only installed ones.
26+
3. **Product list**: a list of all products installed or available
27+
4. **Server selection box** this box is only visible if there is more than one active server, and it allows to filter the results by server
28+
5. **Settings**: Set general settings for tms/tmsgui
29+
6. **Install**: download and install the selected products. Equivalent to `tms install` command.
30+
7. **Uninstall**: uninstall the selected products. Equivalent to `tms uninstall` command.
31+
8. **Full build/Partial build**: rebuild the selected products. If no products are selected, rebuild everything. Equivalent to `tms build -full` and `tms build` commands
32+
9. **Credentials**: ask for new credentials. Equivalent to `tms credentials` command.
33+
10.**Configure**: create (if missing) and open the YAML configuration file. Equivalent to `tms config` command.
34+
11.**Output tab**: shows the output of the current command-line being executed. For long-running commands like installing and building, you can switch to it to follow the progress of the execution.
35+
12. **Status bar**: at the bottom of the main window, the GUI displays the current working folder, and the current Smart Setup version.
36+
37+
When there are errors, an error pane will show:
1938

20-
- **Install**: download and install the selected products. Equivalent to `tms install` command.
21-
- **Uninstall**: uninstall the selected products. Equivalent to `tms uninstall` command.
22-
- **Full build/Partial build**: rebuild the selected products. If no products are selected, rebuild everything. Equivalent to `tms build -full` and `tms build` commands
23-
- **Configure**: create (if missing) and open the YAML configuration file. Equivalent to `tms config` command.
24-
- **Credentials**: ask for new credentials. Equivalent to `tms credentials` command.
39+
{{#image}}tmsgui-errors.png{{/image}}
2540

26-
In the status bar, at the bottom of the main window, the GUI displays the current working folder, and the current Smart Setup version.
41+
If you click on the messages of the error pane, it will show more detailed information about the particular error.
2742

28-
Under the hood, the GUI just executes the `tms` command-line. The `Output` tab shows the output of the current command-line being executed. For long-running commands like installing and building, you can switch to it to follow the progress of the execution.
2943

124 KB
Loading

doc/source/images/tmsgui-login.png

6.7 KB
Loading
22.6 KB
Loading
29.6 KB
Loading

0 commit comments

Comments
 (0)