Skip to content

Commit 51d62d3

Browse files
fkrosfricklerscoopex
authored
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>
1 parent bd05ee1 commit 51d62d3

File tree

1 file changed

+16
-18
lines changed

1 file changed

+16
-18
lines changed

README.md

+16-18
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
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.
55

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.
77

88
## Locations
99

@@ -20,20 +20,18 @@ Published sites:
2020
![Step 2](_assets/doc/step2.png)
2121
2. Make your changes in the branch
2222
![Step 3](_assets/doc/step3.png)
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
2424
* Open https://github.com/SovereignCloudStack/website
2525
* Select `Contribute` -> `Open pull request`
2626
* 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
2828
* `Create pull request`
2929
* Assign one ore more persons which can review the changes and remind the person to review the change
3030
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
3333
* Your changes are merged to the `main` branch and rolled out after 15 minutes
3434

35-
36-
3735
## The editorial workflow
3836

3937
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
5048
cd website
5149
git checkout main
5250
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
5452
```
5553
2. Make your changes with the tool of your choice
5654
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
6058
git add <file> ... <file>
6159
git status
6260
git commit -s -a
63-
gut push
61+
git push -u origin feat/<name of your branch>
6462
```
65-
4. Optional: Testing complexer changes
63+
4. Optional: Testing more complex changes
6664
* Set the `staging` branch to the same state like the main branch
6765
```
6866
git checkout staging
6967
# check the current difference
7068
git diff main
7169
72-
# This abdondons everything on the staging branch
70+
# This abandons everything on the staging branch
7371
git reset --hard origin/main
7472
# add changes of other branches
7573
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
7977
git push --force
8078
```
8179
* 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
8381
5. Create a pull request to get the changes in the `main` branch
8482
* Open https://github.com/SovereignCloudStack/website
8583
* Select `Contribute` -> `Open pull request`
8684
* 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
8886
* `Create pull request`
8987
* Assign one ore more persons which can review the changes and remind the person to review the change
9088
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
9391
* Your changes are merged to the `main` branch and rolled out after 15 minutes
9492
9593
## Frequently asked questions
9694
9795
### 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/)).
9997
10098
### 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
102100
```
103101
{% tf pagetitle.MARKUP %}
104102
```
@@ -115,7 +113,7 @@ As we're using Bootstrap, please add your custom styling definitions to `assets/
115113
116114
## Testing changes on `staging` branch
117115
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/>.
119117
120118
## Testing changes locally
121119

0 commit comments

Comments
 (0)