Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
177 commits
Select commit Hold shift + click to select a range
d6ab945
Update core store migration (#801)
pwizla Apr 12, 2022
9a32465
Merge branch 'main' into next
pwizla Apr 12, 2022
8ce5149
Typescript documentation (#835)
stb13579 Apr 15, 2022
4426e88
add ts config to services
stb13579 Apr 26, 2022
8c525c9
Add callout for alpha/beta migration scripts
pwizla May 5, 2022
f7edbb7
Revert "Add callout for alpha/beta migration scripts"
pwizla May 5, 2022
89ee8e5
Add callout for alpha/beta migration scripts (#878)
pwizla May 5, 2022
b35f96b
Typescript phase 2 (#864)
stb13579 May 11, 2022
91c5105
Force node
pwizla May 11, 2022
0b96443
update TypeScript dedicated page (#898)
stb13579 Jun 1, 2022
b5210ec
Merge branch 'main' into next
pwizla Jun 15, 2022
57696ee
Merge branch 'next' of github.com:strapi/documentation into next
pwizla Jun 15, 2022
23b7b13
Release 4.3.0-beta (#934)
pwizla Jun 15, 2022
0d0c8da
Re-add missing --typescript flag in CLI install. guide
pwizla Jun 15, 2022
031e07b
Add link to TypeScript development docs to CLI installation docs
pwizla Jun 15, 2022
cae479a
Add missing word 😅
pwizla Jun 15, 2022
2647e7a
Use production logo
pwizla Jul 25, 2022
d7b496b
Merge branch 'main' into next
pwizla Jul 25, 2022
d9f2553
Restore beta logo
pwizla Jul 26, 2022
f069fc7
typescript programmatic use (#980) (#1010)
pwizla Jul 26, 2022
680d2b9
Mention folders in CM (#1009)
pwizla Jul 26, 2022
2ab2378
Keep official (not beta) logo
pwizla Jul 26, 2022
9163f49
Add missing comma
pwizla Jul 26, 2022
a68c2a3
Update TS (migration) callout title
pwizla Jul 26, 2022
11bfae4
Reword TS callout
pwizla Jul 26, 2022
c70d932
Merge branch 'main' into next
pwizla Jul 28, 2022
a90fc31
Merge branch 'main' into next
pwizla Aug 2, 2022
e57c7de
Bump version number (alpha)
pwizla Aug 2, 2022
09aa8c5
Merge branch 'user/custom-fields' into repo/custom-fields
pwizla Aug 2, 2022
2da106b
Merge branch 'main' into repo/custom-fields
pwizla Aug 9, 2022
f31ff99
Merge branch 'main' into next
pwizla Aug 9, 2022
923db78
Merge branch 'next' into repo/custom-fields
pwizla Aug 9, 2022
0f58e21
Fix code block ending
pwizla Aug 16, 2022
caf3217
Merge branch 'main' into next
pwizla Aug 18, 2022
a685f89
Mention that Global settings > API tokens is accessible only w/ permi…
pwizla Aug 18, 2022
5ab2083
Add API Tokens permissions to U&P table
pwizla Aug 18, 2022
dafefe8
Update procedure to create an API token for API tokens v2
pwizla Aug 18, 2022
89821a2
Properly format table + fix wording
pwizla Aug 18, 2022
c902142
Merge branch 'main' into next
pwizla Aug 24, 2022
d19d21f
Merge branch 'next' into repo/custom-fields
pwizla Aug 24, 2022
5be14dc
Custom Fields - User Guide: All updates (#1039)
pwizla Aug 24, 2022
b168d11
Custom Fields - Dev docs: All updates (#1036)
pwizla Aug 24, 2022
5999f32
Remove multimarkdown plugin
pwizla Aug 24, 2022
544cfe9
Remove markdown-it dependency
pwizla Aug 24, 2022
b1fa6ce
Fix broken link
pwizla Aug 24, 2022
97ed4b6
Add tip about publishing a plugin on npm
pwizla Aug 24, 2022
d9d698c
Restore beta logo
pwizla Aug 25, 2022
1d6c43b
Revert #1071
pwizla Aug 25, 2022
497f3a7
Merge branch 'dev/hotfix-populate-true' into next
pwizla Aug 25, 2022
92e0ca6
Update new top navbar links
pwizla Aug 25, 2022
afcf7be
Implement simple rebranding on docs-next (#1079)
pwizla Aug 25, 2022
c9d32f8
Flatten APIs structure in TOC
pwizla Aug 25, 2022
4bfb33e
Update version number
pwizla Aug 25, 2022
bf8b71c
Fix custom fields conflict
pwizla Aug 25, 2022
7f276a8
Update pre-release tip
pwizla Aug 25, 2022
10ccd2f
Merge branch 'repo/custom-fields' into next
pwizla Aug 25, 2022
f3d1f89
Fix callout type
pwizla Aug 25, 2022
bd68781
fix: typo in code sample (#1084)
iquirino Aug 26, 2022
035ac1a
Fix usage of "allow"
pwizla Aug 26, 2022
8164e6e
fix file path
stb13579 Aug 31, 2022
4b73c39
Merge pull request #1098 from strapi/dev/custom-fields-fix
stb13579 Aug 31, 2022
ff0621c
update API token screenshot
stb13579 Sep 5, 2022
8043a9e
Remove outdated content + update button name
stb13579 Sep 5, 2022
1f3d5f8
Add regenerate API token section
stb13579 Sep 5, 2022
eb382d2
update text for new user interface
stb13579 Sep 5, 2022
38d5484
update text to match UI
stb13579 Sep 6, 2022
d913ca4
reword for clarity and specificity
stb13579 Sep 6, 2022
200aa15
update screenshots
stb13579 Sep 6, 2022
b7d04aa
updated text
stb13579 Sep 6, 2022
66cdb62
fix caps and move screenshot
stb13579 Sep 6, 2022
1a09171
Merge pull request #1109 from strapi/user/api-tokens-v2-updates-shaun
stb13579 Sep 7, 2022
7f9ffbf
Update node support to 18
alexandrebodin Sep 8, 2022
f4dccf3
add manual installation sqlite
quiloos39 Sep 8, 2022
4975cdd
chore: fix typos
kuizuo Sep 9, 2022
2a96c6e
Merge pull request #1120 from kuizuo/patch-1
stb13579 Sep 9, 2022
3df4f36
Merge pull request #1117 from strapi/chore/node-18
stb13579 Sep 9, 2022
8f43632
Update Azure db connection to v4 (#1119)
stb13579 Sep 9, 2022
3c91cc0
Merge remote-tracking branch 'origin/next' into user/api-tokens-v2-up…
stb13579 Sep 9, 2022
6523d60
Merge pull request #1068 from strapi/user/api-tokens-v2-updates
stb13579 Sep 9, 2022
368ff43
Revert "Merge pull request #1068 from strapi/user/api-tokens-v2-updates"
stb13579 Sep 9, 2022
4204d8f
Rework entire history on API Tokens v2 PR (#1122)
derrickmehaffy Sep 9, 2022
804c69a
Fix variable name
o0th Sep 10, 2022
6438125
Merge pull request #1123 from o0th/patch-1
stb13579 Sep 12, 2022
5a74799
Deployment guides cleanup (#1116)
gpene Sep 12, 2022
0f6ad03
Remove path from .env
pwizla Sep 13, 2022
e66c414
Change @custom-fields to @beta (#1135)
markkaylor Sep 16, 2022
65773df
Update amazon-aws.md
mauicode26 Sep 18, 2022
6d20cc4
update db config for v4
stb13579 Sep 19, 2022
6e0fdb4
Revert "update db config for v4"
stb13579 Sep 19, 2022
d5b24f6
update db config for v4
stb13579 Sep 19, 2022
ec8ab1c
Merge pull request #1136 from muzucode/patch-2
stb13579 Sep 19, 2022
d1d49f8
Update docs/developer-docs/latest/setup-deployment-guides/configurati…
quiloos39 Sep 20, 2022
0f0a6ca
Update docs/developer-docs/latest/setup-deployment-guides/configurati…
quiloos39 Sep 20, 2022
696acc4
change bracket alignment
stb13579 Sep 20, 2022
29b2e13
add callout for thumbnail loading
stb13579 Sep 20, 2022
6588c66
change tableName to collectionName (#1141)
laurenskling Sep 20, 2022
fda638b
Fix kind and collectionName docs (#1140)
laurenskling Sep 20, 2022
b93f68f
Merge pull request #1138 from strapi/dev/do-droplet-db-fix
stb13579 Sep 20, 2022
bec5062
Clarify steps for plugin creation (#1114)
stb13579 Sep 20, 2022
1901420
Add documentation for the request context feature (#1134)
alexandrebodin Sep 20, 2022
f133aca
Mention node 16 as most recommended
pwizla Sep 20, 2022
474ea14
add graphql plugin config to ts example similar to js
tpimh Sep 21, 2022
d9bd8c6
Merge pull request #1118 from quiloos39/main
stb13579 Sep 21, 2022
9a529bb
Bump version number to 4.3.9
pwizla Sep 21, 2022
f05b8d7
Sqlite update (#1147)
stb13579 Sep 21, 2022
4464676
Bump dependencies version
biko8 Sep 21, 2022
4c15b5b
Remove callout re: unstable (#1153)
gpene Sep 22, 2022
534f77e
Rebranding: Moved search bar (#1154)
pwizla Sep 22, 2022
bc0fc09
add migration guide
stb13579 Sep 22, 2022
1c84917
add guide
stb13579 Sep 22, 2022
a3e3244
update naming convention
stb13579 Sep 22, 2022
6d07e87
update procedure and code examples
stb13579 Sep 22, 2022
6a07d17
fix punctuation
stb13579 Sep 22, 2022
536f0ba
update for TypeScript only
stb13579 Sep 22, 2022
c023da9
Revert "Rebranding: Moved search bar (#1154)"
pwizla Sep 23, 2022
8308a4f
Updated Heroku deployment documentation (#991)
levipettersen Sep 23, 2022
588728b
Update admin-customization.md for plugin translation (#1100)
MorganeLeCaignec Sep 23, 2022
89f8868
Installing hotjar (#1061)
Aurelsicoko Sep 23, 2022
856e8d1
cleanup language
stb13579 Sep 23, 2022
5943781
add regenerate and sync the labels with the UI
stb13579 Sep 23, 2022
5e7e350
Add callout for read-only API tokens
stb13579 Sep 23, 2022
bb5ddf2
Windows Desktop Recommended Version Correction
vivekout Sep 23, 2022
1a7dcec
Update docs/developer-docs/latest/update-migration-guides/update-vers…
biko8 Sep 24, 2022
08eea96
Update docs/developer-docs/latest/update-migration-guides/update-vers…
biko8 Sep 24, 2022
22542b9
Update docs/developer-docs/latest/update-migration-guides/update-vers…
biko8 Sep 24, 2022
f8f98a9
fix: typos fixed
Shubhdeep12 Sep 24, 2022
d2943c8
fixed typos
Shubhdeep12 Sep 24, 2022
2494005
Merge pull request #1162 from Shubhdeep12/user/fixed-typos
stb13579 Sep 26, 2022
80bb6d6
Merge pull request #1161 from Shubhdeep12/dev/fixed-typos
stb13579 Sep 26, 2022
f891057
Merge pull request #1160 from vivekout/patch-1
stb13579 Sep 26, 2022
ac7c9fd
Merge pull request #1158 from strapi/user/api-token-v2-rbac
stb13579 Sep 26, 2022
30287aa
Merge pull request #1159 from strapi/dev/api-token-read-only
stb13579 Sep 26, 2022
81c4eea
Merge pull request #1149 from biko8/patch-1
stb13579 Sep 26, 2022
f1e95e5
update the video demo link for v4
jizusun Sep 26, 2022
52c3054
Update introduction.md
jizusun Sep 26, 2022
20bd825
Merge pull request #1157 from strapi/dev/v4.2.x-migration-update
stb13579 Sep 26, 2022
a5f773b
Merge pull request #1163 from jizusun/patch-1
stb13579 Sep 26, 2022
d36c0a1
Merge pull request #1145 from itsemast/appolo-server-ts-fix
stb13579 Sep 26, 2022
318b284
Missing environmet variables added for pm2. (#1164)
habil Sep 26, 2022
e45fc27
Merge branch 'main' into next
pwizla Sep 26, 2022
6bd6f7f
Update link to ColorPicker input
pwizla Sep 26, 2022
9a9dffd
Merge branch 'production'
pwizla Sep 26, 2022
5b28b0b
Revert "Merge branch 'production'"
pwizla Sep 26, 2022
805b0f1
Merge pull request #1142 from strapi/dev/gcp-thumbnail-fix
stb13579 Sep 27, 2022
efa5bf5
update guide name
stb13579 Sep 27, 2022
205e1ea
fix header meta content
stb13579 Sep 27, 2022
ba36c4c
Merge pull request #1155 from strapi/dev/migrate-4.3.7+
stb13579 Sep 27, 2022
5d5c25f
Merge branch 'next'
pwizla Sep 27, 2022
523d93e
Fix logo
pwizla Sep 27, 2022
361d42d
Clean up custom fields page
pwizla Sep 27, 2022
977c132
Fix code-blocks (empty blank lines) in TypeScript documentation
pwizla Sep 27, 2022
3f5cb75
Fix pre-release doc. link (docs-next) in top nav bar
pwizla Sep 27, 2022
2257fd5
Clean up branding.styl
pwizla Sep 27, 2022
d547c04
Clean up comments in REST API population
pwizla Sep 27, 2022
dcaf7f2
Clean up comments from "Installing plugins via Marketplace"
pwizla Sep 27, 2022
4359d57
Revert unwanted wording change in "Installing plugins via Marketplace"
pwizla Sep 27, 2022
c8815b0
Remove outdated TODO in "Installing plugins via Marketplace"
pwizla Sep 27, 2022
8653a6a
Fix link to Roadmap (#1168)
mikehaertl Sep 28, 2022
f054dbb
Merge branch 'production'
pwizla Sep 28, 2022
f6ce46b
Fix logo and nav
pwizla Sep 28, 2022
17b2788
Temporarily revert back to old logo
pwizla Sep 28, 2022
f28de47
Merge branch 'main' of github.com:strapi/documentation
pwizla Sep 28, 2022
54a7f16
Update link to ColorPicker input (again) (#1171)
romash1408 Sep 29, 2022
948942f
Fix Query engine link
hayelomt Sep 30, 2022
96fc3a3
Merge pull request #1179 from titanht/patch-1
stb13579 Sep 30, 2022
a30adc0
fix upload code example
stb13579 Oct 3, 2022
8bf68a5
Merge pull request #1185 from strapi/dev/upload-fix
stb13579 Oct 4, 2022
28893ff
Move search bar to the the left and fix its behavior (#1187)
pwizla Oct 4, 2022
de9382e
Merge branch 'main' into next
pwizla Oct 4, 2022
2f1d38d
Fix logo and nav
pwizla Oct 4, 2022
05ee060
fix TypeScript code errors
stb13579 Oct 4, 2022
cacfaf7
Merge pull request #1189 from strapi/dev/sso-fix
stb13579 Oct 4, 2022
6823684
add github token callout (#1180)
stb13579 Oct 5, 2022
8410d73
Revise contributing.md (#1143)
stb13579 Oct 5, 2022
11a413d
fix 4.4.1 version (#1176)
7dir Oct 5, 2022
d5d5b2c
Update heroku.md (#1075)
arshi-mustafa786 Oct 5, 2022
3cac643
Docker documentation for v4 (#1144)
derrickmehaffy Oct 5, 2022
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
58 changes: 31 additions & 27 deletions .algolia/docsearch.config.json
Original file line number Diff line number Diff line change
@@ -1,34 +1,38 @@
{
"index_name": "documentation",
"start_urls": [
"https://docs.strapi.io"
{
"url": "https://docs.strapi.io"
}
],
"selectors": {
"lvl0": {
"selector": "(//*[contains(@class, 'sidebar-heading open')])[1]",
"type": "xpath",
"global": true
},
"lvl1": {
"selector": "//h1/text()",
"type": "xpath",
"global": true
},
"lvl2": {
"selector": "/html/head/meta[@name='description']/@content",
"type": "xpath",
"global": true
},
"lvl4": {
"selector": "//h2/text()",
"type": "xpath",
"global": true
},
"text": ".content__default p",
"lang": {
"selector": "/html/@lang",
"type": "xpath",
"global": true
"default": {
"lvl0": {
"selector": "(//*[contains(@class, 'sidebar-heading open')])[1]",
"type": "xpath",
"global": true
},
"lvl1": {
"selector": "//h1/text()",
"type": "xpath",
"global": true
},
"lvl2": {
"selector": "/html/head/meta[@name='description']/@content",
"type": "xpath",
"global": true
},
"lvl3": {
"selector": "//h2/text()",
"type": "xpath",
"global": true
},
"text": ".content__default p, .content__default ul>li a, .content__default ul>li code",
"lang": {
"selector": "/html/@lang",
"type": "xpath",
"global": true
}
}
},
"strip_chars": " .,;:#",
Expand All @@ -40,4 +44,4 @@
"lang"
]
}
}
}
91 changes: 38 additions & 53 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,47 +6,44 @@ All efforts to contribute are highly appreciated, we recommend you talk to a mai

## Open Development & Community Driven

Strapi is an open-source project. See the [LICENSE](https://github.com/strapi/documentation/blob/main/LICENSE) file for licensing information. All the work done is available on GitHub.
Strapi is an open-source project. See the [LICENSE](https://github.com/strapi/documentation/blob/main/LICENSE) file for licensing information. All of the work is available on GitHub.

The core team and the contributors send pull requests which go through the same validation process.

## Documentation Requests
## Code of Conduct

Requests for new documentation are highly encouraged, this is not limited to new additions but also changes or more information requested on existing documentation. Please use our [request documentation](https://github.com/strapi/documentation/issues/new?template=DOC_REQUEST.md&title%5B%5D=REQUEST) issue template.
This project and everyone participating in it are governed by the [Strapi Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold the code.

## Code of Conduct
## Documentation Requests

This project and everyone participating in it are governed by the [Strapi Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please read the [full text](CODE_OF_CONDUCT.md) so that you can read which actions may or may not be tolerated.
Requests for new documentation are highly encouraged, this is not limited to new additions but also changes or more information requested on existing documentation. Please use our [request documentation](https://github.com/strapi/documentation/issues/new?template=DOC_REQUEST.md&title%5B%5D=REQUEST) issue template. If you are requesting documentation, please feel free to open a pull request.

## Bugs

We are using [GitHub Issues](https://github.com/strapi/documentation/issues) to manage our public bugs. Before submitting an issue you need to make sure:
Bug reports help to improve the documentation. Please use our [Documentation Bug Report](https://github.com/strapi/documentation/issues/new?template=BUG_REPORT.yml) template to report documentation bugs. Before submitting an issue:

- Checked for any existing pull requests that may address the same issue
- Checked for any open issues related to your issue, if so, please provide context on that issue
- Follow the issue template and try to fill out as much information as you can
- Issues not following the templates **will be closed**
- You may update the closed issue with the required information and it will be reopened
- The issue is with the Strapi **documentation only**, code issues should be directed at the main [strapi/strapi](https://github.com/strapi/strapi) repo issues
- If you are requesting documentation, please do feel free to make a pull request
- Documentation requests will be handled when we have free room within our roadmap
- Open requests **are not handled** in a "first come, first serve" basis, they are handled on a "best-effort" depending on the time required to produce
- Do not ask technical questions about how to do something
- Questions should be directed at the following resources
- Open a Q&A thread on our [Official Forum](https://forum.strapi.io)
- Talk with other community members on our [Community Discord](https://discord.strapi.io)
- Check for existing pull requests that may address the same issue.
- Check for related open issues, if so, please provide context on the existing issue.
- Follow the issue template and fill out as much information as you can.
- Verify the issue is only with the Strapi documentation, code issues should be directed at the main [strapi/strapi](https://github.com/strapi/strapi) repository.

Technical questions should be asked using the following resources:

Please note that rude or impolite comments on issues that violate our [Code of Conduct](./CODE_OF_CONDUCT.md) will be deleted and issues that violate the COC will be closed.
- Open a Q&A thread on our [Official Forum](https://forum.strapi.io)
- Engage with other community members on our [Community Discord](https://discord.strapi.io)

---

## Submitting a Pull Request
## Pull Requests

The core team will review your pull request and will either merge it, request changes to it, or close it.
The core team reviews community pull requests and either merges, requests changes, or comments and closes the pull request. You can open a documentation pull request by:

### Setup and pull request creation
- clicking the `Improve this page` link at the bottom of any documentation page to directly edit in GitHub,
- forking the `documentation` repository and working locally.

Follow the procedure below to contribute to the Strapi documentation.
### Setup and write locally

The following procedure allows you to work locally on the Strapi documentation.

1. Fork the `documentation` repository.
2. Clone your forked `documentation` repository.
Expand All @@ -65,7 +62,7 @@ Follow the procedure below to contribute to the Strapi documentation.
cd documentation/docs/user-docs
```

4. Choose the branch from which to work: either `main` for a contribution on the latest, current version or Strapi ; or `v[x]` for a contribution on a previous version of Strapi.
4. Choose the branch from which to work: either `main` for a contribution on the current version of Strapi or `v[x]` for a contribution on a previous version of Strapi.

```bash
#current version of Strapi (i.e. v4)
Expand All @@ -86,7 +83,7 @@ Follow the procedure below to contribute to the Strapi documentation.
git pull
```

6. Create your own branch, based on either `main` or `v[x]` , on which you will work on your documentation contribution. Make sure the name of your branch indicates both the type of documentation and the topic.
6. Create your branch, based on either `main` or `v[x]`, to work on your documentation contribution. Make sure your branch name indicates both the type of documentation and the topic.

```bash
# developer documentation
Expand Down Expand Up @@ -118,43 +115,31 @@ Follow the procedure below to contribute to the Strapi documentation.

The project is now up and running at http://localhost:8080 and you should be able to access it in your browser.


You are now ready to contribute to the Strapi documentation! 🚀

🤗 Make sure to follow the [12 Rules of Technical Writing](https://handbook.strapi.io/user-success-manual/12-rules-of-technical-writing) and the [Strapi Documentation Style Guide](https://handbook.strapi.io/user-success-manual/strapi-documentation-style-guide) when writing your documentation contribution. These documents are meant to help you write a contribution that fits the whole Strapi documentation and make the reviewing process easier and quicker.

When you are finished writing, create a pull request from your forked repository to the original `documentation` repository (see [the GitHub docs](https://docs.github.com/en/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork) for more information).
### Write technical documentation

✋ To be able to submit your contribution, you must sign the CLA (Contributor License Agreement), directly via GitHub (see [our dedicated blog post](https://strapi.io/blog/switching-from-dco-to-cla) for more information).
For lengthier contributions, we provide general guidelines that can help you write clear and concise documentation:

### Pull request review and management
- The [12 Rules of Technical Writing](https://handbook.strapi.io/user-success-manual/12-rules-of-technical-writing) gives an overview of how to structure and write clear documentation.
- The [Strapi Documentation Style Guide](https://handbook.strapi.io/user-success-manual/strapi-documentation-style-guide) has formatting guidelines and how to implement formatting in markdown files.

Read the information below to know how your contribution will be handled by the Strapi Documentation team until it is merged and deployed.
When you are finished writing, create a pull request from your forked repository to the original `documentation` repository (see [the GitHub docs](https://docs.github.com/en/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork) for more information) or use the _Create a new branch for this commit and start a pull request_ option if you are using the GitHub web browser interface (see [the GitHub docs](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request)).

#### Handling
✋ Sign the CLA (Contributor License Agreement), directly via GitHub (see [our dedicated blog post](https://strapi.io/blog/switching-from-dco-to-cla) for more information).

When a new pull request is submitted in the Strapi `documentation` repository, it is handled in the following week, meaning that the Strapi team:
### Review and management of pull requests

- acknowledges the new pull request, leaving a 👀 reaction on the description
- tags the pull request, to indicate the type of documentation that is being updated, and optionally the level of priority for the contribution
- assigns the pull request to a member of the Strapi Documentation team, who will be in charge of the reviewing and merging
The pull request review process and timeline are based on the availability of Strapi's Documentation team to handle community contributions. The workflow is:

#### Review
1. The pull request is assigned to a member of the Documentation team.
2. At least 1 member of the Documentation team will review the pull request for:

Once all of the handling steps are done by the Strapi team, you can expect your pull request to be reviewed in the next week or so.
- accuracy,
- quality,
- alignment with the documentation scope and roadmap.

Here is what the Strapi Documentation team will review in your pull request:

- The accuracy and coherence of the contribution, by testing any new piece of code or action for example,
- The quality of the technical writing, to make sure it is proper technical documentation that is easy to understand (see [12 Rules of Technical Writing](https://www.notion.so/12-Rules-of-Technical-Writing-c75e080e6b19432287b3dd61c2c9fa04))
- The fit of the contribution among the rest of the Strapi documentation (see [Strapi Documentation Style Guide](https://www.notion.so/Strapi-Documentation-Style-Guide-b9c21387732741ed8b0a3f9701612577))

The pull request will be validated once the contribution ticks all the boxes. At least the validation of the Strapi Documentation team member in charge of the pull request is necessary for it to be merged.

#### Deployment

Once your pull request is validated and merged, it will be deployed with the next batch of merged pull requests. The Strapi Documentation team only deploys the documentation on Wednesdays, but not every week.
3. Reviewers will either approve, ask for changes, or reject the pull request.
4. Accepted pull requests will be merged and deployed as part of the regular documentation deployments on Wednesdays every 2 weeks.

Every documentation deployment is communicated through a message in [the "News" section of the Strapi forum](https://forum.strapi.io/c/news/5).


2 changes: 1 addition & 1 deletion docs/.vuepress/config/theme-config.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
const themeConfig = {
logo: '/assets/logo.svg',
logo: '/assets/logo.png',
nav: [
{
text: 'Resource Center',
Expand Down
Binary file added docs/.vuepress/public/assets/SearchIcon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
128 changes: 128 additions & 0 deletions docs/.vuepress/styles/branding.styl
Original file line number Diff line number Diff line change
@@ -1,4 +1,132 @@
body
// TODO: system fonts
font-family: system-ui

.install-link
// text-decoration: none
background-color: #4945FF
border-radius: 6px
padding: 20px
color: $primary100
justify-content: space-between

.text
flex-grow: 1

.title
color: $neutral0

.description
color: $primary100

.arrow
width: 24px
height: 24px

&:hover
.title
color: $neutral0
text-decoration: underline
.description
color: $neutral0
// text-decoration: none
.arrow
// TODO:

#algolia-autocomplete-listbox-0
#algolia-autocomplete-listbox-1
#algolia-autocomplete-listbox-2
left: 24px !important

.search-box
display: inline-block
width: 20rem
margin: 0 !important
padding: 22px 0 20px 0 !important
text-align: center

>span
display: inline-block
width: 100%

.search-query
display: none

#algolia-search-input
display: inline-block
width: calc(20rem - 90px) !important
height: 40px !important;
padding: 0 0 0 40px !important;
font-family: system-ui, -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Oxygen, Ubuntu, Cantarell, 'Open Sans', 'Helvetica Neue', sans-serif;
font-size: 13px !important;
color: $neutral600 !important
border-radius: 6px !important
border: 1px solid $neutral200 !important
background: #fff url(/assets/SearchIcon.png) 12px 12px no-repeat !important;
background-size: 16px 16px !important;

&::-webkit-input-placeholder
color $neutral600 !important
&:-moz-placeholder /* Firefox 18- */
color $neutral600 !important
&::-moz-placeholder /* Firefox 19+ */
color $neutral600 !important
&:-ms-input-placeholder
color $neutral600 !important

.theme-container
display: flex
flex-direction: column
height: 100%

.algolia-autocomplete
&.algolia-autocomplete-left
&.ds-dropdown-menu
left: 24px !important

.al
.algolia-search-wrapper
.algolia-autocomplete
.ds-dropdown-menu [class^=ds-dataset-]
padding: 0
border: 1px solid $neutral150
.ds-suggestions
margin-top: 0
.ds-dropdown-menu
overflow: initial
margin: 10px 0 0
box-shadow 0 1px 3px 1px rgba(0,0,0,.15)
&:before
background $neutral100
border: 1px solid $neutral150
box-shadow 0 1px 3px 1px $neutral150
.ds-suggestion.ds-cursor
.algolia-docsearch-suggestion:not(.suggestion-layout-simple)
.algolia-docsearch-suggestion--content
background-color: $primary100
.algolia-docsearch-suggestion
padding: 0
.algolia-docsearch-suggestion--wrapper
padding: 0 0 0 16px
.algolia-docsearch-suggestion--category-header
margin: 0
padding: 10px 16px 10px
color: $neutral900 !important
border-bottom: 1px solid $neutral150 !important
background: $neutral100
.algolia-docsearch-suggestion--subcategory-column
color: $neutral600 !important
&:before
background $neutral150
.algolia-docsearch-suggestion--title
padding-right: 16px
color $neutral900 !important
line-height 22px !important
.algolia-docsearch-suggestion--text
padding-right: 16px
color $neutral400 !important
.algolia-docsearch-footer
display: none !important
font-family system-ui
color $neutral800

Expand Down
Loading