Skip to content

Commit 87df0b8

Browse files
authored
Removed images from inventory service, fix typos (#267)
* Removed images from inventory service, fix typos Signed-off-by: Amine RACHYD <[email protected]> * Fix typos Signed-off-by: Amine RACHYD <[email protected]> Signed-off-by: Amine RACHYD <[email protected]>
1 parent c1579f5 commit 87df0b8

File tree

3 files changed

+23
-41
lines changed

3 files changed

+23
-41
lines changed

docs/developer-intermediate/inventory-bff/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -68,9 +68,9 @@ The Inventory solution will use [GraphQL](https://graphql.org/) for its BFF laye
6868

6969
- On GitHub, search the organization you have used to create the repository and click **grant** to allow gitpod to access repositories in that organization.
7070

71-
- Back to [gitpod.io](https://gitpod.io/workspaces), navigate to workspaces and click **New Workspace** to create a new workspace, give it your newly create repository URL.
71+
- Back to [gitpod.io](https://gitpod.io/workspaces), navigate to workspaces and click **New Workspace** to create a new workspace, give it your newly created repository URL.
7272

73-
- If it is your first gitpod workspace, it will ask you for your preferred editor, pick the in browser Visual Studio Code, and the workspace will be created automatically for your.
73+
- If it is your first gitpod workspace, it will ask you for your preferred editor, pick the in browser Visual Studio Code, and the workspace will be created automatically for you.
7474

7575
You are now ready to modify the application!
7676

docs/developer-intermediate/inventory-service/index.md

Lines changed: 19 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -21,12 +21,8 @@
2121
=== "Using OpenShift web terminal"
2222
- In the OpenShift web console, head up to **Topology** menu on the left on the **Developer** perspective and click **Create a new project**
2323

24-
![OpenShift web console](../../images/common/openshiftconsoleproject.png)
25-
2624
- Give a name to your project, call it `dev-{your initials}`, the other fields are optional
2725

28-
![Creating a project using the graphical interface](../../images/common/openshiftproject.png)
29-
3026
- Initialize a web terminal using the `>_` button on the top bar next to your name on the cluster. You should have a terminal with all the necessary development tools
3127

3228
![OpenShift web terminal](../../images/common/openshiftwebterminal.png)
@@ -74,27 +70,28 @@
7470
### Choose your development environment
7571

7672
=== "Gitpod"
77-
- Head over to [gitpod.io](https://gitpod.io), login with your github account
73+
- Head over to [gitpod.io](https://gitpod.io), login with your github account by clicking **Continue with GitHub**.
7874

79-
![Gitpod login](../../images/common/gitpodlogin.png)
75+
- Grant Access to gitpod to your GitHub organization by going to account settings on the top right corner, navigate to **Integrations**, go to GitHub and click **Manage on GitHub**.
8076

81-
- Create a new workspace with the repository you created earlier
77+
- On GitHub, search the organization you have used to create the repository and click **grant** to allow gitpod to access repositories in that organization.
8278

83-
![Workspace creation](../../images/common/gitpodworkspacecreation.png)
79+
- Back to [gitpod.io](https://gitpod.io), navigate to workspaces and click **New Workspace** to create a new workspace, give it your newly created repository URL.
8480

81+
- If it is your first gitpod workspace, it will ask you for your preferred editor, pick the in-browser Visual Studio Code, and the workspace will be created automatically for you.
8582
- Pick Visual Studio Code on the browser as an editor. After waiting some time, you should have an editor on your browser with the code on it. Gitpod will automatically run the application at first launch
8683

87-
![Gitpod web editor](../../images/common/gitpodeditor.png)
88-
89-
- Because Gitpod adds a couple more files in the repository, add at the end of the `.gitignore` file a line with `node_modules` to prevent pushing it to the repository
90-
91-
![Gitpod web editor](../../images/common/gitpodgitignore.png)
92-
93-
You are now ready to modify the application
84+
You are now ready to modify the application!
9485

9586
=== "Locally"
9687
Clone the project and open it using your favorite text editor or IDE (Visual Studio Code, IntelliJ...).
9788

89+
```sh
90+
git clone https://github.com/cnw-team-{team}/inv-svc-{your initials}.git
91+
cd inv-svc-{your initials}
92+
code .
93+
```
94+
9895
Spring Boot uses annotations to configure the various components that will be injected into and
9996
used by the applications. A class with the `@SpringBootApplication` annotation is the starting
10097
point for the rest of the application components to be loaded. Additionally, a `@ComponentScan`
@@ -167,11 +164,6 @@ We will start by creating the initial application component.
167164
git push
168165
```
169166

170-
!!! note
171-
Pushing code from Gitpod into a Github organization might fail. For that you will need to grant Gitpod access to your organization.
172-
![Gitpod org access](../../images/common/pushcodeorg.png)
173-
174-
175167
### Add StockItem controller
176168

177169
In Spring Boot, the `@RestController` annotation tells the framework that the class provides a
@@ -306,19 +298,15 @@ for the REST service.
306298
```
307299

308300
=== "Gitpod"
309-
- Gitpod should prompt you to make your app public, make it so
301+
- Go to the **Remote explorer** tab at the left of the Gitpod editor, you should see the port where your application is running, which is port `9080` in our case.
302+
Click on the **open browser** button (the globe icon).
310303

311-
![View App](../../images/common/gitpodapplaunch.png)
312-
313-
- Go to the **Remote explorer** tab at the left of the Gitpod editor, you should see the port where your application is running. Click on the **open browser** button
314-
315-
![OpenPreview](../../images/common/gitpodexplorer.png)
316-
317-
- You should see the swagger-ui window open
318304

319305
=== "Locally"
320-
- When the server starts, open a browser to [`http://localhost:9080/swagger-ui.html`](http://localhost:9080/swagger-ui.html) to view the swagger documentation. You should see the stock item entry in the list
306+
- When the server starts, open a browser to [`http://localhost:9080/swagger-ui.html`](http://localhost:9080/swagger-ui.html)
321307
---
308+
- You should see the swagger-ui window documentation with the stock item entry in the list
309+
322310
- Commit and push the changes to Git.
323311

324312
```bash
@@ -620,15 +608,9 @@ should be placed in a component that is given a `@Service` annotation.
620608
```
621609

622610
=== "Gitpod"
623-
- Gitpod should prompt you to make your app public, make it so
624-
625-
![View App](../../images/common/gitpodapplaunch.png)
626-
627-
- Go to the **Remote explorer** tab at the left of the Gitpod editor, you should see the port where your application is running. Click on the **open browser** button
628-
629-
![OpenPreview](../../images/common/gitpodexplorer.png)
611+
- Go to the **Remote explorer** tab at the left of the Gitpod editor, you should see the port where your application is running, which is port `9080` in our case.
612+
Click on the **open browser** button (the globe icon).
630613

631-
- You should see the swagger-ui window open
632614

633615
=== "Locally"
634616
- Open a browser to [`http://localhost:9080/swagger-ui.html`](http://localhost:9080/swagger-ui.html)

docs/developer-intermediate/inventory-ui/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -64,9 +64,9 @@
6464

6565
- On GitHub, search the organization you have used to create the repository and click **grant** to allow gitpod to access repositories in that organization.
6666

67-
- Back to [gitpod.io](https://gitpod.io/workspaces), navigate to workspaces and click **New Workspace** to create a new workspace, give it your newly create repository URL.
67+
- Back to [gitpod.io](https://gitpod.io/workspaces), navigate to workspaces and click **New Workspace** to create a new workspace, give it your newly created repository URL.
6868

69-
- If it is your first gitpod workspace, it will ask you for your preferred editor, pick the in browser Visual Studio Code, and the workspace will be created automatically for your.
69+
- If it is your first gitpod workspace, it will ask you for your preferred editor, pick the in browser Visual Studio Code, and the workspace will be created automatically for you.
7070

7171
You are now ready to modify the application!
7272

0 commit comments

Comments
 (0)