Skip to content

Commit b542fbd

Browse files
committed
Merge 4.2
2 parents 9af65a2 + badbbc1 commit b542fbd

File tree

111 files changed

+9085
-7411
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

111 files changed

+9085
-7411
lines changed

.editorconfig

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -20,36 +20,29 @@ indent_style = space
2020
indent_size = 2
2121

2222
[*.md]
23+
max_line_length = 100
2324
trim_trailing_whitespace = false
25+
indent_size = 4
2426

2527
[*.neon]
2628
indent_style = tab
2729
indent_size = 4
2830

2931
[*.xml]
30-
indent_style = space
3132
indent_size = 4
3233

3334
[*.{yaml,yml}]
34-
indent_style = space
3535
indent_size = 2
3636
trim_trailing_whitespace = false
3737

3838
[.circleci/config.yml]
39-
indent_style = space
4039
indent_size = 2
4140

4241
[.github/workflows/*.yml]
43-
indent_style = space
4442
indent_size = 2
4543

4644
[.gitmodules]
4745
indent_style = tab
4846

4947
[.proselintrc]
50-
indent_style = space
51-
indent_size = 2
52-
53-
[.travis.yml]
54-
indent_style = space
5548
indent_size = 2

.github/ISSUE_TEMPLATE/1_Support_question.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@ about: See https://api-platform.com/support/ for questions about using API Platf
55

66
# Support question
77

8-
We use GitHub issues only to discuss bugs and new features.
9-
For this kind of questions about using API Platform, please use
10-
any of the support alternatives shown in [API Platform support](https://api-platform.com/support/).
8+
We use GitHub issues only to discuss bugs and new features. For this kind of questions about using
9+
API Platform, please use any of the support alternatives shown in
10+
[API Platform support](https://api-platform.com/support/).
1111

1212
Thanks!

.github/workflows/cd.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ jobs:
4545
- name: Install php
4646
uses: shivammathur/setup-php@v2
4747
with:
48-
php-version: "8.2"
48+
php-version: "8.4"
4949
tools: phive
5050

5151
- name: Auth gcloud

.github/workflows/ci.yml

Lines changed: 40 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -9,29 +9,12 @@ permissions:
99
contents: read
1010

1111
jobs:
12-
build:
13-
name: Lint
12+
proselint:
13+
name: Prose Lint
1414
runs-on: ubuntu-latest
15-
16-
permissions:
17-
contents: read
18-
packages: read
19-
statuses: write
20-
2115
steps:
22-
- name: Checkout
16+
- name: Checkout code
2317
uses: actions/checkout@v4
24-
with:
25-
fetch-depth: 0
26-
27-
- name: Lint
28-
uses: super-linter/super-linter/slim@v7
29-
env:
30-
VALIDATE_EDITORCONFIG: false
31-
VALIDATE_JSCPD: false
32-
VALIDATE_MARKDOWN_PRETTIER: false
33-
DEFAULT_BRANCH: "origin/4.1"
34-
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
3518

3619
- uses: actions/cache@v4
3720
with:
@@ -45,3 +28,40 @@ jobs:
4528

4629
- name: Run Proselint
4730
run: find . -name '*.md' -exec proselint {} \;
31+
lint:
32+
name: Lint
33+
runs-on: ubuntu-latest
34+
35+
steps:
36+
- name: Checkout code
37+
uses: actions/checkout@v4
38+
39+
- uses: DavidAnson/markdownlint-cli2-action@v21
40+
with:
41+
globs: '**/*.md'
42+
43+
prettier-format:
44+
name: Prettier
45+
runs-on: ubuntu-latest
46+
steps:
47+
- name: Checkout code
48+
uses: actions/checkout@v4
49+
50+
- name: Setup Node.js
51+
uses: actions/setup-node@v4
52+
with:
53+
node-version: '20'
54+
55+
- name: Prettier Dry Run
56+
run: |
57+
npx prettier --check "**/*.md" || {
58+
echo "::error title=Formatting Failed::Some files are not formatted correctly."
59+
echo "-------------------------------------------------------"
60+
echo "❌ CHECK FAILED"
61+
echo "To fix these issues, run the following command locally:"
62+
echo ""
63+
echo " npx prettier --write \"**/*.md\" --prose-wrap always"
64+
echo ""
65+
echo "-------------------------------------------------------"
66+
exit 1
67+
}

.markdownlint.yaml

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
MD013:
3+
line_length: 1000
4+
code_blocks: false
5+
tables: false
6+
no-inline-html:
7+
allowed_elements: [a, p, img, br, code-selector, video, source, iframe, h1]
8+
MD046:
9+
style: fenced
10+
MD004:
11+
style: dash
12+
MD007:
13+
indent: 4

.markdownlint.yml

Lines changed: 0 additions & 5 deletions
This file was deleted.

.prettierrc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"printWidth": 100,
3+
"proseWrap": "always"
4+
}

CONTRIBUTING.md

Lines changed: 24 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,8 @@
22

33
First of all, thank you for contributing, you're awesome!
44

5-
To have your code integrated in the API Platform documentation project, there are some rules to follow, but don't panic, it's easy!
5+
To have your code integrated in the API Platform documentation project, there are some rules to
6+
follow, but don't panic, it's easy!
67

78
## Reporting Bugs in the documentation
89

@@ -12,29 +13,36 @@ Before submitting your issue:
1213
- A clear title to resume the issue
1314
- A description of the workflow needed to reproduce the bug
1415

15-
> [!NOTE]
16-
> Don't hesitate giving as much information as you can.
16+
> [!NOTE] Don't hesitate giving as much information as you can.
1717
1818
## Code of Conduct
1919

20-
By contributing to this project, you agree to abide by our [Code of Conduct](https://github.com/api-platform/docs#coc-ov-file). We expect all contributors to foster a welcoming and inclusive environment.
20+
By contributing to this project, you agree to abide by our
21+
[Code of Conduct](https://github.com/api-platform/docs#coc-ov-file). We expect all contributors to
22+
foster a welcoming and inclusive environment.
2123

2224
## How to Contribute
2325

24-
1. Fork this repository by clicking the "Fork" button at the top right of the `api-platform/docs` repository page.
26+
1. Fork this repository by clicking the "Fork" button at the top right of the `api-platform/docs`
27+
repository page.
2528

2629
2. Clone the forked repository to your local machine:
27-
```console
28-
git clone https://github.com/your-username/repository-name.git
29-
```
30+
31+
```console
32+
git clone https://github.com/your-username/repository-name.git
33+
```
34+
3035
3. Create a new branch for your contribution:
31-
```console
32-
git switch -c docs-your-branch-name
33-
```
36+
37+
```console
38+
git switch -c docs-your-branch-name
39+
```
40+
3441
4. Commit and push your changes
35-
5. Submit a Pull Request. You must decide on what branch your changes will be based depending of the nature of the change.
36-
See [the dedicated documentation entry](https://api-platform.com/docs/extra/releases/).
42+
5. Submit a Pull Request. You must decide on what branch your changes will be based depending of the
43+
nature of the change. See
44+
[the dedicated documentation entry](https://api-platform.com/docs/extra/releases/).
3745

38-
> [!TIP]
39-
> You can also contribute to improving the documentation directly by clicking on the
40-
> **"You can also help us improve the documentation of this page."** link, located at the end of each documentation page.
46+
> [!TIP] You can also contribute to improving the documentation directly by clicking on the **"You
47+
> can also help us improve the documentation of this page."** link, located at the end of each
48+
> documentation page.

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,11 @@
44

55
[![Lint](https://github.com/api-platform/docs/actions/workflows/ci.yml/badge.svg)](https://github.com/api-platform/docs/actions/workflows/ci.yml)
66

7-
Welcome to the official documentation for [API Platform](https://api-platform.com), a powerful framework for building APIs and web applications.
7+
Welcome to the official documentation for [API Platform](https://api-platform.com), a powerful
8+
framework for building APIs and web applications.
89

910
This repository contains all the API Platform documentation resources.
1011

1112
## Contributing
1213

1314
Please check our [CONTRIBUTING file](/CONTRIBUTING.md) to contribute.
14-

0 commit comments

Comments
 (0)