You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Fix some formatting and wording in the README (#1016)
Signed-off-by: Dr. Jens Harbott <harbott@osism.tech>
Co-authored-by: Dr. Jens Harbott <harbott@osism.tech>
Co-authored-by: Marc Schöchlin <schoechlin@osb-alliance.com>
Copy file name to clipboardexpand all lines: README.md
+16-18
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,7 @@
3
3
4
4
The static [SCS website](https://scs.community) is generated by [Jekyll](https://jekyllrb.com/). The theme is originally based on the template [business-frontpage](https://github.com/sharu725/business-frontpage) by [sharu725](https://github.com/sharu725). We're heavily making use of [Bootstrap 5](https://getbootstrap.com/docs/5.0) to layout the page content.
5
5
6
-
The website is automatically build every 15 minutes or on every push to `main` and subsequently pulled onto our webspace.
6
+
The website is automatically built every 15 minutes or on every push to `main` and subsequently pulled onto our webspace.
7
7
8
8
## Locations
9
9
@@ -20,20 +20,18 @@ Published sites:
20
20

21
21
2. Make your changes in the branch
22
22

23
-
3. Create a pull request to get the changes in the `main` branch
23
+
3. Create a pull request to get the changes into the `main` branch
24
24
* Open https://github.com/SovereignCloudStack/website
25
25
* Select `Contribute` -> `Open pull request`
26
26
* Verify that `base: main` and `compare <your branch>` is selected in the top of the pull request
27
-
* Add a optional description
27
+
* Add an optional description
28
28
*`Create pull request`
29
29
* Assign one ore more persons which can review the changes and remind the person to review the change
30
30
4. The [reviewer](https://github.com/pulls/assigned) inspects [your](https://github.com/pulls) changes and gives feedback
31
-
* If there is something to todo, you can restart at step 2
32
-
* If everything is fine the reviewer approves the merge request
31
+
* If there is something to do, you can restart at step 2
32
+
* If everything is fine, the reviewer approves the merge request
33
33
* Your changes are merged to the `main` branch and rolled out after 15 minutes
34
34
35
-
36
-
37
35
## The editorial workflow
38
36
39
37
The website data is deployed by the following process:
@@ -50,7 +48,7 @@ The description is a little more detailed than it needs to be, as it aims also t
50
48
cd website
51
49
git checkout main
52
50
git pull
53
-
git checkout -b feat/<name of your branch> # not not use spaces
51
+
git checkout -b feat/<name of your branch> # do not use spaces
54
52
```
55
53
2. Make your changes with the tool of your choice
56
54
3. Commit and push with signoffs
@@ -60,16 +58,16 @@ The description is a little more detailed than it needs to be, as it aims also t
60
58
git add <file> ... <file>
61
59
git status
62
60
git commit -s -a
63
-
gut push
61
+
git push -u origin feat/<name of your branch>
64
62
```
65
-
4. Optional: Testing complexer changes
63
+
4. Optional: Testing more complex changes
66
64
* Set the `staging` branch to the same state like the main branch
67
65
```
68
66
git checkout staging
69
67
# check the current difference
70
68
git diff main
71
69
72
-
# This abdondons everything on the staging branch
70
+
# This abandons everything on the staging branch
73
71
git reset --hard origin/main
74
72
# add changes of other branches
75
73
git merge feat/<name of your branch>
@@ -79,26 +77,26 @@ The description is a little more detailed than it needs to be, as it aims also t
79
77
git push --force
80
78
```
81
79
* Test the result: https://staging.scs.community/ (that takes ~15minutes)
82
-
* Start at Step 2 if your are not satisfied
80
+
* Start again at Step 2 if you are not satisfied
83
81
5. Create a pull request to get the changes in the `main` branch
84
82
* Open https://github.com/SovereignCloudStack/website
85
83
* Select `Contribute` -> `Open pull request`
86
84
* Verify that `base: main` and `compare <your branch>` is selected in the top of the pull request
87
-
* Add a optional description
85
+
* Add an optional description
88
86
* `Create pull request`
89
87
* Assign one ore more persons which can review the changes and remind the person to review the change
90
88
6. The [reviewer](https://github.com/pulls/assigned) inspects [your](https://github.com/pulls) changes and gives feedback
91
-
* If there is something to todo, you can restart at step 2
92
-
* If everything is fine the reviewer approves the merge request
89
+
* If there is something to do, you can restart at step 2
90
+
* If everything is fine, the reviewer approves the merge request
93
91
* Your changes are merged to the `main` branch and rolled out after 15 minutes
94
92
95
93
## Frequently asked questions
96
94
97
95
### How can I publish a community blog posting?
98
-
Create a markup document located at `_i18n/en/blog` and/or respectively `_i18n/de/blog` to add a new blog post. Be aware that the file shall be named `YEAR-MONTH-DAY-title.MARKUP` according to the Jekyll conventions (see [Jekyll Docs](https://jekyllrb.com/docs/posts/)).
96
+
Create a markup document located at `_i18n/en/blog` and/or respectively `_i18n/de/blog` to add a new blog post. Be aware that the file shall be named `YEAR-MONTH-DAY-title.MARKUP` according to the Jekyll conventions (see [Jekyll Docs](https://jekyllrb.com/docs/posts/)).
99
97
100
98
### How can I create a new page?
101
-
Due to the internalization plugin, you have to create multiple files. First of all, add a new markup document under `_pages`, set the desired layout, e.g. `default` and add the line
99
+
Due to the internationalization plugin, you have to create multiple files. First of all, add a new markup document under `_pages`, set the desired layout, e.g. `default` and add the line
102
100
```
103
101
{% tf pagetitle.MARKUP %}
104
102
```
@@ -115,7 +113,7 @@ As we're using Bootstrap, please add your custom styling definitions to `assets/
115
113
116
114
## Testing changes on `staging` branch
117
115
118
-
We're using a dedicated workflow to build a staging preview of our website that subsequently is published with GitHub Pages. To make use of this feature, simply push to `staging`. Please try to keep `staging` in sync with `main`, e.g. by deleting and recreating after testing your recent changes. The staging area can be reached via <https://sovereigncloudstack.github.io/website/>.
116
+
We're using a dedicated workflow to build a staging preview of our website that subsequently is published with GitHub Pages. To make use of this feature, simply push to the `staging` branch. Please try to keep `staging` in sync with `main`, e.g. by deleting and recreating after testing your recent changes. The staging area can be reached via <https://sovereigncloudstack.github.io/website/>.
0 commit comments