Skip to content

Commit 40a55a8

Browse files
Updated incorrect URLs (#235)
* Updated URL on fields page * Updated analyze databases page * Updated analyze source code page * Updated host discovery page * Updated servicenow page * Updated six steps page * Update pages/user guides/integrating_with_servicenow.md * Fixed issues with numbering
1 parent 9b870db commit 40a55a8

File tree

6 files changed

+38
-37
lines changed

6 files changed

+38
-37
lines changed

pages/api/create_interview_questions.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ For any additional details regarding the endpoint, checkout the Tidal API docume
2323

2424
# Tools
2525

26-
* [jq](https://stedolan.github.io/jq/) - `jq` is a CLI that allows us quickly parse and filter JSON.
26+
- [jq](https://stedolan.github.io/jq/) - `jq` is a CLI that allows us quickly parse and filter JSON.
2727

2828
# Creating Interview Questions
2929

@@ -33,7 +33,7 @@ Our interview questions are tightly coupled with our application fields. So, bef
3333

3434
### Create a custom field
3535

36-
You can create a custom field for an application by going to https://[your subdomain].tidal.cloud/#/admin and clicking on the 'New Application Field' button. Note: we don't limit the type of field (dropdown, text, number, currency, checkbox) that can be used in interview questions.
36+
You can create a custom field for an application by going to https://[your workspace].tidal.cloud/fields/applications and clicking on the 'New Application Field' button. Note: we don't limit the type of field (dropdown, text, number, currency, checkbox) that can be used in interview questions.
3737

3838
### Get a custom field id
3939

@@ -45,7 +45,6 @@ Once we have created a custom field, we need to get its field id. So, to start w
4545
-H Content-Type\:\ application/json \
4646
-o fields.json
4747

48-
4948
Once we have that, we need to search for our newly created field name. If you have 'jq' installed you can use it to query the json file for your field name
5049

5150
jq '.[] | select(.name=="Your Field Name")' fields.json
@@ -68,7 +67,6 @@ Which should give you an output similiar to
6867
"field_options": []
6968
}
7069

71-
7270
## Custom Question
7371

7472
### Get a question number
@@ -132,7 +130,6 @@ Putting this all together we can then post this request to our API
132130
-H Content-Type\:\ application/json \
133131
-d \{\"question\"\:\ \{\ \"text\"\:\ \"How\ many\ users\ does\ this\ application\ have\?\"\,\ \"number\"\:\ 22\,\ \"field_id\"\:\ 1\}\}
134132

135-
136133
### Updating an existing quesiton
137134

138135
If you have an interview question already and you want to change the number or change what field it applies to you can do a put request

pages/tidal tools/analyze_database.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ For example, in Oracle databases, the Data Dictionary and AWR repository tables
4545

4646
## Getting Started
4747

48-
1. Before you can analyze a database, You must enable the Database Analysis feature for your account. To do so, go to your workspace Settings/Preferences (https://yourworkspace.tidal.cloud/#/admin/setting). You will find the Database Analysis section at the bottom of the page.
48+
1. Before you can analyze a database, You must enable the Database Analysis feature for your account. To do so, go to your workspace Settings/Preferences (https://[your workspace].tidal.cloud/preferences). You will find the Database Analysis section at the bottom of the page.
4949
2. Now that you have activated the Database Analyze feature, You need to install, configure and authenticate via Tidal Tools. Make sure you follow these guides.
5050
- How to [install](tidal-tools.html#install) Tidal Tools.
5151
- Install Tidal Tools [dependencies](tidal-tools.html#dependencies).
@@ -65,7 +65,7 @@ For the most part, all supported Database engines share very similar configurati
6565

6666
Your YAML configuration file for Postgres, MySQL, and SQL Server must contain the following information.
6767

68-
- `id` - The id of the database from your Tidal account. You can find it in the URL bar when looking at a database instance. ex. If you are viewing a database instance in Tidal, the URL will show https://demo2.tidal.cloud/#/database_instances/111 in this case 111 is the database instance ID.
68+
- `id` - The id of the database from your Tidal account. You can find it in the URL bar when looking at a database instance. ex. If you are viewing a database instance in Tidal, the URL will show https://[your workspace].tidal.cloud/database_instances/111/overview in this case 111 is the database instance ID.
6969
- `name` - A common name for your database could be the same or different from db_name, but this value is arbitrary and only for your reference.
7070
- `engine` - The database vendor, either `SQL Server`, `MySQL`, or `PostgreSQL`, it is not case sensitive.
7171
- `host` - The hostname of the server that the database is located on and is accessible via a network connection from your current device and location.
@@ -77,7 +77,7 @@ Your YAML configuration file for Postgres, MySQL, and SQL Server must contain th
7777

7878
When analyzing Oracle databases, the attributes in your configuration file must contain the following details.
7979

80-
- `id` - The id of the database from your Tidal account. You can find it in the URL bar when looking at a database instance. ex. If you are viewing a database instance in Tidal, the URL will show https://demo2.tidal.cloud/#/database_instances/111 in this case 111 is the database instance ID.
80+
- `id` - The id of the database from your Tidal account. You can find it in the URL bar when looking at a database instance. ex. If you are viewing a database instance in Tidal, the URL will show https://[your workspace].tidal.cloud/database_instances/111/overview in this case 111 is the database instance ID.
8181
- `name` - A common name for your database.
8282
- `analyze_workload` - When set to **true** workload analysis is enabled. Be sure to configure AWR data retention and verify licensing. For more information check the advance configuration [section](#advanced-configuration)
8383
- `engine` - **Oracle**

pages/tidal tools/sourcecode.md

Lines changed: 30 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,13 @@ sidebar: main_sidebar
77
permalink: analyze-source-code.html
88
folder: tidaltools
99
---
10+
1011
## Tidal Analyze Source Code
1112

1213
Not sure how ready you are to move to the cloud? With Tidal you have
1314
the option to analyze your specified source code associated with the applications.
1415
The analysis will identify the difficulty to migrate your applications to the
15-
cloud.
16+
cloud.
1617

1718
If you are interested in a deeper dive source code assessment, let us know at
1819
[info@tidalcloud.com](mailto:info@tidalcloud.com).
@@ -24,12 +25,13 @@ Try it out!
2425
## Getting Started
2526

2627
1. Install, configure and authenticate via Tidal Tools. Make sure you follow these guides.
27-
- How to [install](tidal-tools.html#install) Tidal Tools.
28-
- Install Tidal Tools [dependencies](tidal-tools.html#dependencies).
29-
- Make sure you can [connect](tidal-tools.html#connecting-to-the-api) with your workspace using Tidal Tools.
30-
- As the last step, You should run the [tidal doctor](troubleshooting.html#tidal-doctor) command to verify that your environment has been configured properly.
3128

32-
2. You will need the ID of the application for which you are going to perform the source code analysis. You can find it in the URL bar when looking at an application. ex. If you are viewing an application in Tidal, the URL will show `https://demo.tidal.cloud/#/apps/111` in this case 111 is the application ID.
29+
- How to [install](tidal-tools.html#install) Tidal Tools.
30+
- Install Tidal Tools [dependencies](tidal-tools.html#dependencies).
31+
- Make sure you can [connect](tidal-tools.html#connecting-to-the-api) with your workspace using Tidal Tools.
32+
- As the last step, You should run the [tidal doctor](troubleshooting.html#tidal-doctor) command to verify that your environment has been configured properly.
33+
34+
2. You will need the ID of the application for which you are going to perform the source code analysis. You can find it in the URL bar when looking at an application. ex. If you are viewing an application in Tidal, the URL will show `https://[your workspace].tidal.cloud/apps/111/overview` in this case 111 is the application ID.
3335

3436
3. Lastly, you will need a local copy of the source code for the application.
3537

@@ -45,15 +47,16 @@ When analyzing a source code (or multiple), you have two options.
4547

4648
1. Perform the source code analysis and upload the result immediately to your workspace. This is Tidal Tools' default behaviour. To do so, all you need to do is run the following command.
4749

48-
```bash
49-
cd /path/to/source-code
50-
tidal analyze code --app-id 111
51-
```
50+
```bash
51+
cd /path/to/source-code
52+
tidal analyze code --app-id 111
53+
```
5254

53-
Alternatively, you can pass the location to the source code.
54-
```bash
55-
tidal analyze code ~/location/to-source-code/ --app-id 111
56-
```
55+
Alternatively, you can pass the location to the source code.
56+
57+
```bash
58+
tidal analyze code ~/location/to-source-code/ --app-id 111
59+
```
5760

5861
2. Perform the source code analysis and upload the results **at a later time**. The following section will explain how to run database analysis in **offline mode**
5962

@@ -63,33 +66,34 @@ There are circumstances in which you need to perform a source code analysis on a
6366

6467
These are the steps you need to follow in order to bypass internet access limitations:
6568

66-
1. On a Machine with internet access, you need to install, and configure Tidal Tools.
69+
1. On a Machine with internet access, you need to install, and configure Tidal Tools.
6770

6871
2. Package Tidal Tools and its required docker container images into a tar file. This will allow you to move the archive file into your restricted environment. To do so, run the following command.
6972

70-
`tidal backup`
73+
`tidal backup`
7174

72-
Once it has finished, you will find (in your current location) a tar file called `tidal-snapshot_DATE.tar`. This is the file you need to transport into your internet restricted environment.
75+
Once it has finished, you will find (in your current location) a tar file called `tidal-snapshot_DATE.tar`. This is the file you need to transport into your internet restricted environment.
7376

7477
3. On the machine that has no internet access, you will now restore Tidal Tools using the following command.
7578

76-
`tidal restore tidal-snapshot_DATE.tar`
79+
`tidal restore tidal-snapshot_DATE.tar`
80+
81+
This will load a docker image and all the existing Tidal Tools configurations from the original machine. You can now run the source code analysis without any external network connectivity.
7782

78-
This will load a docker image and all the existing Tidal Tools configurations from the original machine. You can now run the source code analysis without any external network connectivity.
83+
`tidal analyze code [path/to-directory] --offline --output-dir [directory]`
7984

80-
`tidal analyze code [path/to-directory] --offline --output-dir [directory]`
85+
Note:
8186

82-
Note:
83-
- The `--offline` flag indicates to Tidal Tools that the output needs to be stored in a file instead of being uploaded.
84-
- The `--output-dir` flag determines where the output will be located.
87+
- The `--offline` flag indicates to Tidal Tools that the output needs to be stored in a file instead of being uploaded.
88+
- The `--output-dir` flag determines where the output will be located.
8589

86-
After the analysis is completed, you will find a zip file called, `result-<DATE>.zip` that can then be transferred into a machine with internet connectivity.
90+
After the analysis is completed, you will find a zip file called, `result-<DATE>.zip` that can then be transferred into a machine with internet connectivity.
8791

8892
4. Back to the machine with internet access, you can now upload your results to your workspace with this command.
8993

90-
`tidal analyze code --app-id [app_id_for_your_application] --upload [file_name]`
94+
`tidal analyze code --app-id [app_id_for_your_application] --upload [file_name]`
9195

92-
You should receive confirmation that the upload has been completed and can navigate to Tidal to see the results.
96+
You should receive confirmation that the upload has been completed and can navigate to Tidal to see the results.
9397

9498
{% include tip.html content="Need to run code analysis on a entire set of applications all from one machine? Run [this command and easily create a directory for every application already in Tidal Migrations](https://github.com/tidalmigrations/gists/blob/master/make_source_code_dirs.sh)" %}
9599

pages/user guides/discover_nmap.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ By leveraging the power of **Tidal Tools**, you can send the output generated by
3535
```
3636
tidal sync nmap my-network.xml
3737
```
38-
5. Head over to your Tidal account! (https://<<account_name>>.tidal.cloud/#/discover/host_discovery)
38+
5. Head over to your Tidal account! (https://[your workspace].tidal.cloud/host-discovery)
3939
4040
4141
## Installing Nmap

pages/user guides/integrating_with_servicenow.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ In order for your Tidal workspace to communicate with your ServiceNow instance,
8989

9090
- Log into your Tidal workspace and head to the ServiceNow integration page.
9191

92-
`` https://<example>.tidal.cloud/#/servicenow ``
92+
`` https://[your workspace].tidal.cloud/_/#/servicenow ``
9393

9494
- Enter the following information:
9595
- Instance Name

pages/user guides/six_steps.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ out.
126126

127127
You can find the `Application ID` in the URL bar when looking at an
128128
application. e.g. if I'm loking at an application in Tidal, the URL
129-
will show `https://demo2.tidal.cloud/#/apps/111` Here, `111` is my
129+
will show `https://[your workspace].tidal.cloud/apps/111/overview` Here, `111` is my
130130
`Application ID`.
131131

132132
I can now analyze the source code with:

0 commit comments

Comments
 (0)