Skip to content

Commit 39adc7b

Browse files
committed
Merge '4.0' into main
2 parents cb93b34 + c4d119d commit 39adc7b

File tree

106 files changed

+9401
-6215
lines changed

Some content is hidden

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

106 files changed

+9401
-6215
lines changed
Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
11
---
22
name: ⛔ Support Question
33
about: See https://api-platform.com/support/ for questions about using API Platform
4-
54
---
65

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

1112
Thanks!
Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
---
22
name: 📄 Documentation issue
33
about: Report a documentation issue
4-
54
---

.github/workflows/cd.yml

Lines changed: 24 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,18 @@
1+
---
12
name: Deploy Website
23

34
on:
45
push:
56
branches:
67
- main
7-
- '*.*'
8+
- "*.*"
9+
10+
permissions:
11+
contents: read
12+
actions: read
13+
checks: write
14+
deployments: write
15+
pull-requests: read
816

917
jobs:
1018
deploy:
@@ -28,57 +36,52 @@ jobs:
2836
restore-keys: |
2937
${{ runner.os }}-yarn-
3038
31-
3239
- name: Setup Hugo
33-
uses: peaceiris/actions-hugo@v2
40+
uses: peaceiris/actions-hugo@v3
3441
with:
35-
hugo-version: '0.134.2'
42+
hugo-version: "0.134.2"
3643
extended: true
3744

3845
- name: Install php
3946
uses: shivammathur/setup-php@v2
4047
with:
41-
php-version: '8.2'
48+
php-version: "8.2"
4249
tools: phive
4350

4451
- name: Auth gcloud
45-
uses: google-github-actions/auth@v1
52+
uses: google-github-actions/auth@v2
4653
with:
4754
credentials_json: ${{ secrets.BUCKET_CREDS }}
48-
49-
- name: 'Set up Cloud SDK'
50-
uses: 'google-github-actions/setup-gcloud@v1'
55+
56+
- name: Set up Cloud SDK
57+
uses: google-github-actions/setup-gcloud@v2
5158

5259
- name: Clone website
53-
uses: actions/checkout@v2
60+
uses: actions/checkout@v4
5461
with:
5562
repository: api-platform/docs-website
5663
path: docs-website
64+
5765
- name: Install javascript packages
5866
working-directory: docs-website
5967
run: npm install
68+
6069
- name: Fetch API Platform docs
6170
working-directory: docs-website
6271
run: tools/get-docs.sh
72+
6373
- name: Fetch API Platform references and guides
6474
working-directory: docs-website
6575
run: tools/get-core-docs.sh
66-
- name: Build menu
76+
77+
- name: Build menu
6778
working-directory: docs-website
6879
run: node tools/menu.mjs
80+
6981
- name: Hugo
7082
working-directory: docs-website
7183
run: hugo --minify
84+
7285
- name: Deploy
7386
working-directory: docs-website
7487
run: gsutil -q -m rsync -d -r ./public gs://api-platform-website-v3/
75-
# This need to move to website
76-
# env:
77-
# GITHUB_KEY: ${{ secrets.CONTRIBUTORS_GITHUB_TOKEN }}
78-
# NODE_OPTIONS: --openssl-legacy-provider
79-
# - name: Deploy
80-
# uses: peaceiris/actions-gh-pages@v3
81-
# with:
82-
# github_token: ${{ secrets.GITHUB_TOKEN }}
83-
# publish_dir: ./public
84-
# cname: api-platform.com

.github/workflows/ci.yml

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
1+
---
12
name: Lint
23

34
on:
45
push:
56
pull_request:
67

7-
permissions: {}
8+
permissions:
9+
contents: read
810

911
jobs:
1012
build:
@@ -23,12 +25,12 @@ jobs:
2325
fetch-depth: 0
2426

2527
- name: Lint
26-
uses: github/super-linter/slim@v4
28+
uses: super-linter/super-linter/slim@v7
2729
env:
28-
VALIDATE_ALL_CODEBASE: false
2930
VALIDATE_EDITORCONFIG: false
3031
VALIDATE_JSCPD: false
31-
DEFAULT_BRANCH: "4.0"
32+
VALIDATE_MARKDOWN_PRETTIER: false
33+
DEFAULT_BRANCH: "origin/4.0"
3234
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
3335

3436
- uses: actions/cache@v4

.markdownlint.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
---
12
MD013:
23
line_length: 400
34
no-inline-html:

CONTRIBUTING.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# Contributing to the API Platform Documentation
2+
3+
First of all, thank you for contributing, you're awesome!
4+
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!
6+
7+
## Reporting Bugs in the documentation
8+
9+
Before submitting your issue:
10+
11+
- Check if the bug is not already reported!
12+
- A clear title to resume the issue
13+
- A description of the workflow needed to reproduce the bug
14+
15+
> [!NOTE]
16+
> Don't hesitate giving as much information as you can.
17+
18+
## Code of Conduct
19+
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.
21+
22+
## How to Contribute
23+
24+
1. Fork this repository by clicking the "Fork" button at the top right of the `api-platform/docs` repository page.
25+
26+
2. Clone the forked repository to your local machine:
27+
```console
28+
git clone https://github.com/your-username/repository-name.git
29+
```
30+
3. Create a new branch for your contribution:
31+
```console
32+
git switch -c docs-your-branch-name
33+
```
34+
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/).
37+
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.

0 commit comments

Comments
 (0)