Skip to content

Commit 22c20cc

Browse files
authored
Updated Installation.md
Signed-off-by: Apurv428 <[email protected]>
1 parent 5975753 commit 22c20cc

File tree

1 file changed

+16
-14
lines changed

1 file changed

+16
-14
lines changed

docs/Installation.md

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -58,11 +58,7 @@ Note: In case software-discovery-tool code is already checked out, do the follow
5858
openmainframeproject/software-discovery-tool-data contains all OMP created json files. To add the data files, we will use `git submodule`
5959
- map the submodule directory with the directory path and update the directory:
6060
```
61-
git submodule update --init --recursive --remote
62-
```
63-
- since we cloned a new repo as root just now, give the permissions to `apache` user like we did before:
64-
```
65-
sudo chown -R apache:apache /opt/software-discovery-tool/distro_data
61+
sudo -u apache git submodule update --init --recursive --remote
6662
```
6763

6864
#### Updating Data Directory
@@ -76,7 +72,10 @@ sudo -u apache git pull <upstream remote> <default branch> --recurse-submodules
7672
sudo -u apache git submodule update --recursive --remote
7773
```
7874

79-
#### Using data from PDS
75+
#### Bringing in additional data: PDS
76+
77+
The data directory we cloned above only brings in sources maintained by this project. Notably it does not include SUSE Linux Enterprise Server, Red Hat Enterprise Linux, or Ubuntu. Instead, these sources are maintained by the Package Distro Search tool (abbreviated as PDS). In order to bring in those data sources, you will need to do that directly, as follows.
78+
8079
For example, taking RHEL_8_Package_List.json
8180
- Usage help will be displayed:
8281
```
@@ -94,7 +93,7 @@ Example:
9493
```
9594
Example of extracting the RHEL_8_Package_List.json from PDS repo:
9695
```
97-
./package_build.py RHEL_8_Package_List.json
96+
sudo -u apache ./bin/package_build.py RHEL_8_Package_List.json
9897
Extracting RHEL_8_Package_List.json from PDS data ...
9998
Thanks for using SDT!
10099
```
@@ -105,9 +104,11 @@ Thanks for using SDT!
105104
```
106105
sudo -u apache ./bin/package_build.py RHEL_8_Package_List.json
107106
```
108-
Now to know how to update the `src/config/supported_distros.py` to reflect the new json files in the UI, follow steps mentioned in
109-
Step 2 of
110-
[Adding_new_distros](https://github.com/openmainframeproject/software-discovery-tool/blob/master/docs/Adding_new_distros.md#step-2-update-the-supported_distros-variable-in-configuration-file-sdt_basesrcconfigconfigpy)
107+
108+
#### Update Supported Distros list
109+
110+
The `src/config/supported_distros.py` must now be updated to reflect the new json files that have been brought in order for them to be reflected in the UI. We started with a sample file back in Step 2, so that's a good starting place. For more details about the formatting and expectations of this file, follow steps mentioned in Step 2 of [Adding_new_distros](https://github.com/openmainframeproject/software-discovery-tool/blob/master/docs/Adding_new_distros.md#step-2-update-the-supported_distros-variable-in-configuration-file-sdt_basesrcconfigconfigpy)
111+
111112

112113
### Step 6: Install and populate the SQL database
113114

@@ -215,15 +216,16 @@ In case any of the parameters are updated, the server has to be restarted:
215216

216217
#### Ensure Node.js and npm are installed
217218

218-
# Make sure you have Node.js and npm installed. You can download them from [here](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)
219+
sudo apt install npm
220+
219221

220222
#### Change to the react-frontend directory
221223

222-
cd react-frontend
224+
cd react-frontend
223225

224226
#### Install the required npm packages
225227

226-
npm i
228+
sudo npm i
227229

228230
#### Setting up the Environment Variables
229231

@@ -252,4 +254,4 @@ To configure the Flask server URL for your React application, follow these steps
252254
253255
#### Start the react frontend application
254256
255-
npm run start
257+
sudo npm run start

0 commit comments

Comments
 (0)