Skip to content

Commit 439ca7e

Browse files
committed
Added images for documentation
1 parent fee4d4f commit 439ca7e

9 files changed

+28
-3
lines changed

README.md

+27-2
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,16 @@
66

77
- On `Create a new repository` page, Select the options as highlighted in the below image and then click `Create repository` button at the bottom of the page.
88

9+
![create-new-repo.png](./images/create-new-repo.png)
10+
911
- Clone this repository on your local system:
1012
```
1113
git clone git@github.com:RedHatQuickCourses/my-training-repository.git
1214
```
1315
NOTE: Use your repository url in the above command.
1416

1517
- Go in to the course repository directory and initialize the course.
16-
```
18+
```
1719
cd my-training-repository/
1820
sh course-init.sh
1921
```
@@ -35,10 +37,23 @@ antora.yml:title: REPLACE Course Title
3537
git push origin main
3638
```
3739

40+
- Browse your git repository url
41+
42+
- On your github repo page, on left hand side pane, click on settings gear icon near `About` heading.
43+
44+
- Click `Use your GitHub Pages website` option to select (checked) it and then click `Save changes` button.
45+
46+
![github-pages-setting](./images/github-pages-setting.png)
47+
48+
- You should now see the link to access the rendered content within that same block.
49+
50+
![quickcourse-rendered-url](./images/quickcourse-rendered-url.png)
51+
52+
FIXME: highlight the relevant area on images.
3853

3954
## Development using devspace
4055

41-
- Make sure you have configured your `quay.io` credentials on the OpenShift Dev Spaces portal.
56+
- Access the devspace url (FIXME: url link)
4257

4358
- Click on `Log in with OpenShift` button.
4459

@@ -48,8 +63,12 @@ antora.yml:title: REPLACE Course Title
4863

4964
- On the `Authorize Access` page, under `Requested permissions`, mae sure `user:full` option is selected (ticked) and click on `Allow selected permissions` button.
5065

66+
- Configure your `quay.io` credentials on the OpenShift Dev Spaces portal.
67+
5168
- Click your username on top right and click on `User Preferences` option.
5269

70+
![](./images/devspace-userpreferences.png)
71+
5372
- On the `User Preferences` screen under `Container Registries` tab, click on `Add Container Registry` option.
5473

5574
- On the Add Container Registry pop-up provide details as below and the click on `Add` Button.
@@ -58,14 +77,18 @@ antora.yml:title: REPLACE Course Title
5877
**Username:** *your quay.io login* <br>
5978
**Password:** *your quai.io login* password <br>
6079

80+
![quay-credentials](./images/quay-credentials.png)
6181

6282
- Click on `Create Workspace` option on left pane.
6383
Under `Import from Git section, provide the Git repo URL for your training and click on `Create & Open` button.
6484

85+
6586
NOTE: Make sure you have initialized your training content repository and committed the changes before using it in the devspace.
6687

6788
- Click on the search bar for Workspace on top and click on `Run Task` option, then click `devfile`.
6889

90+
![devspace-runtask](./images/devspace-runtask.png)
91+
6992
- Click on `0-install` option and wait for it to finish.
7093

7194
- Repeat the earlier step to select devfile and click on `1-watch` option this time.
@@ -74,6 +97,8 @@ NOTE: Make sure you have initialized your training content repository and commit
7497

7598
- Pop-up will be displayed at the bottom of the screen.
7699

100+
![devspace-pop-up](./images/devspace-pop-up.png)
101+
77102
- Create `Open In New Tab` button.
78103

79104
- On the next pop-up message: `Do you want VS Code - Open Source to open the external website?` click on `Open` button.

images/create-new-repo.png

184 KB
Loading

images/devspace-pop-up.png

111 KB
Loading

images/devspace-runtask.png

136 KB
Loading

images/devspace-userpreferences.png

95.3 KB
Loading

images/github-pages-setting.png

223 KB
Loading

images/quay-credentials.png

81.5 KB
Loading

images/quickcourse-rendered-url.png

165 KB
Loading

package-lock.json

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)