Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

vale linter action #3033

Open
wants to merge 30 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
30 commits
Select commit Hold shift + click to select a range
037bfac
vale action
andriitserkovnyi Jan 27, 2025
22cb0dd
Update vale.yml
andriitserkovnyi Jan 27, 2025
a5605d5
Update vale.yml
andriitserkovnyi Jan 27, 2025
a5967d0
Update vale.yml
andriitserkovnyi Jan 27, 2025
1fe0e08
Update vale.yml
andriitserkovnyi Jan 27, 2025
b6b9e8b
update action
andriitserkovnyi Jan 27, 2025
f9b2a86
Delete Units.yml
andriitserkovnyi Jan 27, 2025
b694ffa
vale
andriitserkovnyi Jan 27, 2025
1cc93bd
Merge branch 'master' into vale-linting
andriitserkovnyi Jan 29, 2025
9a4f7ec
update
andriitserkovnyi Jan 29, 2025
e3e213c
quotes
andriitserkovnyi Jan 30, 2025
ce70fff
Update Exclamation.yml
andriitserkovnyi Jan 31, 2025
184aac8
Update Exclamation.yml
andriitserkovnyi Feb 2, 2025
61c4fb9
Merge branch 'master' into vale-linting
andriitserkovnyi Feb 2, 2025
b1cf5bb
Update EmDash.yml
andriitserkovnyi Feb 2, 2025
1bd62dd
fixes
andriitserkovnyi Feb 2, 2025
49f9dd2
fixes
andriitserkovnyi Feb 2, 2025
d339ffa
fix exclamation points
andriitserkovnyi Feb 2, 2025
93c846e
fixes
andriitserkovnyi Feb 2, 2025
521ff95
Update Exclamation.yml
andriitserkovnyi Feb 3, 2025
4991988
Update Exclamation.yml
andriitserkovnyi Feb 3, 2025
a485249
Update Exclamation.yml
andriitserkovnyi Feb 3, 2025
5a36b3a
Update Exclamation.yml
andriitserkovnyi Feb 3, 2025
e0b60e9
double quotes
andriitserkovnyi Feb 4, 2025
bdd6cee
Update Exclamation.yml
andriitserkovnyi Feb 4, 2025
ebb48b9
Update Exclamation.yml
andriitserkovnyi Feb 4, 2025
622dc48
Update Exclamation.yml
andriitserkovnyi Feb 5, 2025
d5f52c2
quotes
andriitserkovnyi Feb 5, 2025
5ad2821
Update qurly-quotes.yml
andriitserkovnyi Feb 5, 2025
0c662c6
Update Quotes.yml
andriitserkovnyi Feb 5, 2025
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
29 changes: 29 additions & 0 deletions .github/workflows/vale.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
name: Lint with Vale

on:
push:
branches:
- main
pull_request:

jobs:
vale-lint:
runs-on: ubuntu-latest

steps:
# Step 1: Checkout the repository
- name: Checkout code
uses: actions/checkout@v3

# Step 2: Install Vale
- name: Install Vale
run: |
sudo apt update
sudo snap install vale
vale --version

# Step 3: Run Vale linter
- name: Run Vale linter
run: |
vale --minAlertLevel=error docs/
continue-on-error: false
1 change: 1 addition & 0 deletions .vale-ignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
lx0amx3m1b
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ To suggest changes, follow the steps:
10. Click **Create pull request**.
11. To confirm that the PR is ready to merge, set a [label](https://docs.github.com/en/issues/using-labels-and-milestones-to-track-work/managing-labels#applying-a-label), like **in progress**, **tech review needed**, or **TW review needed**.

Thats it! Your pull request has been created. Once we review and approve the changes, they will be published on the documentation website.
That's it! Your pull request has been created. Once we review and approve the changes, they will be published on the documentation website.

## Contributors

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -392,7 +392,7 @@ Make sure that for the spryker/file-manager-gui module, the current version is e

## Cross Domain Script Include
The application loads a subset of included JavaScript files from third-party domains.
If the application included a script from an external domain, then the application is entrusting that domain with the applications data and functionality. It has to trust that the external domain is secure enough to prevent an attacker from modifying the script to perform malicious actions within the application.
If the application included a script from an external domain, then the application is entrusting that domain with the application's data and functionality. It has to trust that the external domain is secure enough to prevent an attacker from modifying the script to perform malicious actions within the application.

**Changes:**

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ Translations for all configurations in all locales are contained in the same fil
```
</details>

The translation configuration file has a very simple structure: its a JSON object. The keys of this object represent translation keys, that are the pieces of information from a configuration file that should be translated. The values are simple objects with the structure `"{locale name}": "{translated value}"`.
The translation configuration file has a very simple structure: it's a JSON object. The keys of this object represent translation keys, that are the pieces of information from a configuration file that should be translated. The values are simple objects with the structure `"{locale name}": "{translated value}"`.

You can translate the following properties of configuration:

Expand Down
10 changes: 5 additions & 5 deletions _drafts/acp-apps-development/develop-an-app/app-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,7 @@ Common properties of a widget are:
"id": "notification"
},
"notificationType": "info",
"content": "Dont have credentials yet? Visit <a href=\"https://google.com/\" target=\"_blank\">admin.usercentrics.eu/#/login</a> to create your account."
"content": "Don't have credentials yet? Visit <a href=\"https://google.com/\" target=\"_blank\">admin.usercentrics.eu/#/login</a> to create your account."
}
}
}
Expand Down Expand Up @@ -183,7 +183,7 @@ Common properties of a widget are:
<tr>
<td>select</td>
<td>Single selection: <img src="https://spryker.s3.eu-central-1.amazonaws.com/docs/aop/dev/app-configuration/single-selection.png"> Image Multi-selection: <img src="https://spryker.s3.eu-central-1.amazonaws.com/docs/aop/dev/app-configuration/multi-selection.png"></td>
<td>Similar to the <code>radio</code> widget, but instead of radio buttons, you can use <code>select</code> for selection in a dropdown. Besides, this widget also allows multiple options selection by setting <code>multiple: true</code>.<br>Properties:<ul><li><code>oneOf</code>: list of objects used as options.</li><li><code>multiple</code>: <code>true</code> or <code>false</code></li><li><code>multipleOptions</code>: list of strings to be used as options. Can be used instead of <code>oneOf</code>.</li>See <i>example for select with oneOf</i> under this table.</ul>In case you dont need to have separate labels and values, you can use <code>multipleOptions</code> or <code>enum</code> instead of <code>oneOf</code>.<br> See <i>example for select without oneOf</i> under this table.</td>
<td>Similar to the <code>radio</code> widget, but instead of radio buttons, you can use <code>select</code> for selection in a dropdown. Besides, this widget also allows multiple options selection by setting <code>multiple: true</code>.<br>Properties:<ul><li><code>oneOf</code>: list of objects used as options.</li><li><code>multiple</code>: <code>true</code> or <code>false</code></li><li><code>multipleOptions</code>: list of strings to be used as options. Can be used instead of <code>oneOf</code>.</li>See <i>example for select with oneOf</i> under this table.</ul>In case you don't need to have separate labels and values, you can use <code>multipleOptions</code> or <code>enum</code> instead of <code>oneOf</code>.<br> See <i>example for select without oneOf</i> under this table.</td>
</tr>
<tr>
<td>app-status</td>
Expand Down Expand Up @@ -366,7 +366,7 @@ The returned object looks like this:
```

### Order of fields
The `properties` within the form configuration are to define the forms fields and their corresponding widgets. By default, the fields are displayed in that order also. In some cases, you can use the `order` or `fieldsets` property to change the order of the fields.
The `properties` within the form configuration are to define the form's fields and their corresponding widgets. By default, the fields are displayed in that order also. In some cases, you can use the `order` or `fieldsets` property to change the order of the fields.

The `order` property changes the order of the fields within the form:

Expand Down Expand Up @@ -480,7 +480,7 @@ Here is an example of the full configuration:
"id": "notification"
},
"notificationType": "info",
"content": "Dont have credentials yet? Visit <a href=\"https://google.com/\" target=\"_blank\">admin.usercentrics.eu/#/login</a> to create your account."
"content": "Don't have credentials yet? Visit <a href=\"https://google.com/\" target=\"_blank\">admin.usercentrics.eu/#/login</a> to create your account."
},
"userCentricIntegrationType": {
"type": "string",
Expand Down Expand Up @@ -577,7 +577,7 @@ This is how the configuration looks in the Back Office:
![full-configuration](https://spryker.s3.eu-central-1.amazonaws.com/docs/aop/dev/app-configuration/full-configuration.png)

## Translation appendix
Translation for an app configuration is provided in the `app-store-suite/app/config/<app-name>/translation.json` file. Each field defined in the JSONs `properties` needs to match its corresponding translation entity in the `translation.json` file. For example, to translate the `title` of the widget `isLiveMode`, we provide `"title": "isLiveMode"` in the app configuration JSON.
Translation for an app configuration is provided in the `app-store-suite/app/config/<app-name>/translation.json` file. Each field defined in the JSON's `properties` needs to match its corresponding translation entity in the `translation.json` file. For example, to translate the `title` of the widget `isLiveMode`, we provide `"title": "isLiveMode"` in the app configuration JSON.

*translation.json* file example:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ For the manifest, make sure to follow these conditions:
|description | Full description of the app. New line symbols and HTML tags are not allowed. | "description": "BS PAYONE GmbH is headquartered in Frankfurt am Main and is one of the leading omnichannel-payment providers in Europe. In addition to providing customer support to numerous Savings Banks (Sparkasse) the full-service payment service provider also provides cashless payment transaction services to more than 255,000 customers from stationary trade to the automated and holistic processing of e-commerce and mobile payments." |
|developedBy | Optional. Provides information about who developed the App. | "developedBy": "Spryker Systems GmbH" |
|url | URL to a homepage of the application provider (not visible in the AppCatalog). | "url": "https://www.payone.com/DE-en" |
|isAvailable | Shows if the application is currently available. Possible values:<br><ul><li>false — the application is not available, it's not possible to connect and configure it.</li><li>true — the application is available, it’s possible to connect, configure, and use it.</li></ul> | "isAvailable": true |
|isAvailable | Shows if the application is currently available. Possible values:<br><ul><li>false — the application is not available, it's not possible to connect and configure it.</li><li>true — the application is available, it's possible to connect, configure, and use it.</li></ul> | "isAvailable": true |
|businessModels | An array of suite types that are compatible with the application. Possible values:<ul><li>B2C</li><li>B2B</li><li>B2C_MARKETPLACE</li><li>B2B_MARKETPLACE</li></ul> | See *businessModels example* under this table. |
|categories | An array of categories that the application belongs to. Possible values:<ul><li>BUSINESS_INTELLIGENCE</li><li>CONSENT_MANAGEMENT</li><li>LOYALTY_MANAGEMENT</li><li>PAYMENT</li><li>PRODUCT_INFORMATION_MANAGEMENT</li><li>SEARCH</li><li>TAX</li><li>USER_GENERATED_CONTENT</li></ul> | See *categories example* under this table. |
|pages | Adds additional content to the application detail page. This part contains an object with a page type and its blocks.<br>Possible page types (object keys):<ul><li>Overview</li><li>Legal</li></ul>Each page can contain no or multiple blocks. Each block should be specified by an object with the following keys:<ul><li>title — header of the block;</li><li>type — the way the data is displayed. Possible values:<ul><li>list<li>text</li></ul><li>data — information that is displayed inside the block. Can be a string, if *type=text*, or an array of strings if *type=list*.</li></ul> | See *pages example* under this table. |
Expand Down
6 changes: 3 additions & 3 deletions _drafts/acp-apps-development/develop-an-app/develop-an-app.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ git commit -m "first commit"

After running these commands, you get a new local repository that needs to be linked with your remote one.

If not done yet, create a new remote repository by opening your [Github account](https://github.com/newConnect). After you have created the new repository, GitHub will display instructions on how to proceed. Execute the commands from the list below, as you dont need some of the first steps proposed by GitHub since youve already initialized Git and you already have the `README.md` file from the cloned repository.
If not done yet, create a new remote repository by opening your [Github account](https://github.com/newConnect). After you have created the new repository, GitHub will display instructions on how to proceed. Execute the commands from the list below, as you don't need some of the first steps proposed by GitHub since you've already initialized Git and you already have the `README.md` file from the cloned repository.

```bash
git branch -M main
Expand All @@ -86,7 +86,7 @@ You can also execute this step later.

{% endinfo_block %}

Now, you have done the groundwork that enables you to develop an app. You created a new repository that contains the boilerplate code for almost any app youd like to build.
Now, you have done the groundwork that enables you to develop an app. You created a new repository that contains the boilerplate code for almost any app you'd like to build.

### Validation

Expand Down Expand Up @@ -140,7 +140,7 @@ The configuration file contains all necessary form fields for inputs required by

### Translation

The translation file contains all translations for the form fields youve previously defined. You can use the Hello World [example translation file](/docs/acp/user/develop-an-app/code-snippets/translation-json-file.html) and update it to your needs. Add this file to `config/app/translation.json` of your app.
The translation file contains all translations for the form fields you've previously defined. You can use the Hello World [example translation file](/docs/acp/user/develop-an-app/code-snippets/translation-json-file.html) and update it to your needs. Add this file to `config/app/translation.json` of your app.

### Validation

Expand Down
2 changes: 1 addition & 1 deletion _drafts/acp-apps-development/develop-an-app/sync-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Spryker uses schema files to generate code for your project, including predefine

## Code generation

You can use the Sync APIs OpenAPI schema file to generate code with the help of [Spryks](/docs/dg/dev/sdks/sdk/spryks/spryks.html).
You can use the Sync API's OpenAPI schema file to generate code with the help of [Spryks](/docs/dg/dev/sdks/sdk/spryks/spryks.html).
You can control the code generator with the following parts of the schema file:
- Paths
- Extension
Expand Down
Loading
Loading