Merge branch 'main' into dependabot/npm_and_yarn/apexcharts-3.53.0

README.md

@@ -3,7 +3,7 @@
 
 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.
 
-The website is automatically build every 15 minutes or on every push to `main` and subsequently pulled onto our webspace.
+The website is automatically built every 15 minutes or on every push to `main` and subsequently pulled onto our webspace.
 
 ## Locations
 
@@ -20,20 +20,18 @@ Published sites:
    ![Step 2](_assets/doc/step2.png)
 2. Make your changes in the branch
    ![Step 3](_assets/doc/step3.png)
-3. Create a pull request to get the changes in the `main` branch
+3. Create a pull request to get the changes into the `main` branch
    * Open https://github.com/SovereignCloudStack/website
    * Select `Contribute` -> `Open pull request`
      * Verify that `base: main` and `compare <your branch>` is selected in the top of the pull request
-     * Add a optional description
+     * Add an optional description
      * `Create pull request`
    * Assign one ore more persons which can review the changes and remind the person to review the change
 4. The [reviewer](https://github.com/pulls/assigned) inspects [your](https://github.com/pulls) changes and gives feedback
-   * If there is something to todo, you can restart at step 2
-   * If everything is fine the reviewer approves the merge request
+   * If there is something to do, you can restart at step 2
+   * If everything is fine, the reviewer approves the merge request
    * Your changes are merged to the `main` branch and rolled out after 15 minutes
 
-
-
 ## The editorial workflow
 
 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
    cd website
    git checkout main
    git pull
-   git checkout -b feat/<name of your branch> # not not use spaces
+   git checkout -b feat/<name of your branch> # do not use spaces
    ```
 2. Make your changes with the tool of your choice
 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
    git add <file> ... <file>
    git status
    git commit -s -a
-   gut push
+   git push -u origin feat/<name of your branch>
    ```
-4. Optional: Testing complexer changes
+4. Optional: Testing more complex changes
   * Set the `staging` branch to the same state like the main branch
      ```
      git checkout staging
      # check the current difference
      git diff main
 
-     # This abdondons everything on the staging branch
+     # This abandons everything on the staging branch
      git reset --hard origin/main
      # add changes of other branches
      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
      git push --force
      ```
   * Test the result: https://staging.scs.community/ (that takes ~15minutes)
-  * Start at Step 2 if your are not satisfied
+  * Start again at Step 2 if you are not satisfied
 5. Create a pull request to get the changes in the `main` branch
    * Open https://github.com/SovereignCloudStack/website
    * Select `Contribute` -> `Open pull request`
      * Verify that `base: main` and `compare <your branch>` is selected in the top of the pull request
-     * Add a optional description
+     * Add an optional description
      * `Create pull request`
    * Assign one ore more persons which can review the changes and remind the person to review the change
 6. The [reviewer](https://github.com/pulls/assigned) inspects [your](https://github.com/pulls) changes and gives feedback
-   * If there is something to todo, you can restart at step 2
-   * If everything is fine the reviewer approves the merge request
+   * If there is something to do, you can restart at step 2
+   * If everything is fine, the reviewer approves the merge request
    * Your changes are merged to the `main` branch and rolled out after 15 minutes
 
 ## Frequently asked questions
 
 ### How can I publish a community blog posting?
-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/)).
+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/)).
 
 ### How can I create a new page?
-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
+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
 ```
 {% tf pagetitle.MARKUP %}
 ```
@@ -115,7 +113,7 @@ As we're using Bootstrap, please add your custom styling definitions to `assets/
 
 ## Testing changes on `staging` branch
 
-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/>.
+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/>.
 
 ## Testing changes locally