Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
37 commits
Select commit Hold shift + click to select a range
15e37cb
Add temp workaround for legacy domain (#307)
derrickmehaffy Aug 11, 2021
d53b228
Update node env var to fix build bug (#381)
derrickmehaffy Aug 11, 2021
18cef5a
Add a local node script for legacy (#382)
derrickmehaffy Aug 11, 2021
94cbee3
Removed Slack from the Navbar Community dropdown (#384)
kasonde Aug 16, 2021
66d1a06
Edit the "Create a Go File" section (#388)
mikebolt Aug 20, 2021
fd50474
remove DO managed db warning (#390)
Aug 20, 2021
24c999a
Add hiring link (#387)
pierreburgy Aug 20, 2021
8cb692f
Case for 1 can be handled in loop (#370)
gustawdaniel Aug 20, 2021
03394ab
Change code snippet for service create customisation (#372)
bkowalik Aug 23, 2021
52c72f3
VuePress enhancements (#368)
pwizla Aug 25, 2021
3b9e91a
Highlight active tab in blue instead of default VuePress green (#393)
pwizla Aug 25, 2021
f40995e
Fix CLI commands for Hand-on path in QSG (#395)
pwizla Aug 26, 2021
aae681f
Launch the server: added steps to execute build & start on windows (#…
ericrinaldo Aug 27, 2021
2df2b71
Remove breaking markdown on laravel page (#398)
Rocksheep Aug 31, 2021
d0fbfd9
Update python.md (#400)
Faheem2k19 Sep 1, 2021
e7ba720
Update laravel.md (#402)
bigpreshy Sep 2, 2021
4dc60dd
small grammar fix (#405)
aboustayyef Sep 3, 2021
8c5ca5b
Update is/are conjugation mistake in FAQ (#406)
Victor-Jansson Sep 6, 2021
fca41a7
Add Okta example to SSO (#396)
derrickmehaffy Sep 9, 2021
484d86b
Grammar correction (#414)
philipszdavido Sep 13, 2021
d863be4
Use a nodejs version supported by Strapi (#411)
tmaier Sep 13, 2021
cd81cc1
Fix socketPath usage on google app engine (#392)
cihadturhan Sep 13, 2021
975155d
Update laravel.md (#410)
bigpreshy Sep 13, 2021
53dd3fd
Fix for the Okta sample config (#419)
derrickmehaffy Sep 20, 2021
6f5b045
Fix grammar (#421)
posty72 Sep 24, 2021
b8dd4f6
Update sentence for initializer in folder structure (#426)
SujayPrabhu96 Sep 27, 2021
3aa09be
Update README.md (#427)
teinett Sep 28, 2021
a3959eb
[dev/latest-guides-auth-request] Fixed grammatical error (#431)
Brlaney Oct 1, 2021
b855ce2
npm build command doesn't work. Use npm run build (#440)
nwazuo Oct 13, 2021
c349b2f
Update note in v3 migration guides (#449)
derrickmehaffy Oct 20, 2021
6f9e3f7
fix publicationState filter docs (#425)
petr-hajek Oct 21, 2021
993be36
Believe there is a typo in the file name (#471)
craigharman Nov 2, 2021
eb6f511
[v3] CLI Node version reference (#470)
derrickmehaffy Nov 2, 2021
052a267
Add Strapi handbook links (#492)
pwizla Nov 17, 2021
ad53d1c
Update 'Database Access' location (#487)
aboluwade-oluwasegun Nov 17, 2021
0b0accf
Update amazon-aws.md (#484)
sripriyesha Nov 17, 2021
131389b
Merge branch 'main' into v3
derrickmehaffy Nov 29, 2021
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
4 changes: 1 addition & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,6 @@ The core team will review your pull request and will either merge it, request ch

### Contribution Workflow

<!-- TODO add contrib-docs and link here -->

#### Setting up

1. Fork the `documentation` repository.
Expand Down Expand Up @@ -87,7 +85,7 @@ The core team will review your pull request and will either merge it, request ch
```

#### Writing
We can't provide you specific procedures with step-by-step instructions to write technical documentation. But if you have any question or need help, do feel free to reach us through [our forum](https://forum.strapi.io/).
We can't provide you specific procedures with step-by-step instructions to write technical documentation. But our ["12 Rules of Technical Writing"](https://handbook.strapi.io/user-success-manual/12-rules-of-technical-writing) and [style guide](https://handbook.strapi.io/user-success-manual/strapi-documentation-style-guide) should help you get started. If you have any question or need help, do feel free to reach us through [our forum](https://forum.strapi.io/).

#### Sharing & reviewing

Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Strapi is a free and open-source headless CMS delivering your content anywhere y

The following are required if you are submitting pull requests to the documentation. For more information on how to contribute please see our [contribution guide](./CONTRIBUTING.md)

- NodeJS >= 10.16 <=12
- NodeJS >=12.x <=14.x
- NPM >= 6.x
- Yarn >= 1.22.x

Expand Down
119 changes: 92 additions & 27 deletions docs/.vuepress/config.js
Original file line number Diff line number Diff line change
Expand Up @@ -48,8 +48,7 @@ const sidebar = {
children: [
{
title: 'Hosting Provider Guides',
path:
'/developer-docs/latest/setup-deployment-guides/deployment.html#hosting-provider-guides',
path: '/developer-docs/latest/setup-deployment-guides/deployment.html#hosting-provider-guides',
collapsable: true,
children: [
[
Expand Down Expand Up @@ -93,8 +92,7 @@ const sidebar = {
},
{
title: 'Optional Software Guides',
path:
'/developer-docs/latest/setup-deployment-guides/deployment.html#optional-software-guides',
path: '/developer-docs/latest/setup-deployment-guides/deployment.html#optional-software-guides',
collapsable: true,
children: [
[
Expand Down Expand Up @@ -380,27 +378,82 @@ const checklinksIgnoredFiles = [
'./developer-docs/latest/update-migration-guides/migration-guides/migration-guide-beta.20-to-3.0.0.md', // line 93
];

const plugins = [
['vuepress-plugin-element-tabs', {}],
['check-md', {
ignore: checklinksIgnoredFiles,
}],
['seo', {
siteTitle: (_, $site) => $site.title,
title: $page => $page.title,
}],
['vuepress-plugin-code-copy', {
color: '#ffffff',
successText: 'Copied to clipboard!',
}],
['@vuepress/back-to-top', {}],
['vuepress-plugin-container', {
type: 'callout',
defaultTitle: ''
}],
['vuepress-plugin-container', {
type: 'strapi',
defaultTitle: '',
before: info => `<div class="custom-block strapi"><p class="custom-block-title">🤓 ${info}</p>`,
after: '</div>'
}],
['vuepress-plugin-container', {
type: 'tip',
before: info => `<div class="custom-block tip"><p class="custom-block-title">💡 ${info}</p>`,
after: '</div>'
}],
['vuepress-plugin-container', {
type: 'note',
before: info => `<div class="custom-block note"><p class="custom-block-title">✏️ ${info}</p>`,
after: '</div>'
}],
['vuepress-plugin-container', {
type: 'caution',
before: info => `<div class="custom-block caution"><p class="custom-block-title">✋ ${info}</p>`,
after: '</div>'
}],
['vuepress-plugin-container', {
type: 'warning',
before: info => `<div class="custom-block warning"><p class="custom-block-title">️❗️ ${info}</p>`,
after: '</div>'
}],
['vuepress-plugin-container', {
type: 'prerequisites',
defaultTitle: 'PREREQUISITES'
}],
['vuepress-plugin-container', {
type: 'api-call',
defaultTitle: ''
}],
['vuepress-plugin-container', {
type: 'request',
defaultTitle: 'Request'
}],
['vuepress-plugin-container', {
type: 'response',
defaultTitle: 'Response'
}]
];

const checkLegacy = () => {
if (process.env.DEPLOY_ENV == 'legacy') {
return '/documentation/';
} else {
return '/';
}
};

module.exports = {
title: '',
port: 8080,
description: 'The headless CMS developers love.',
base: '/documentation/',
plugins: {
'@vuepress/medium-zoom': {},
'vuepress-plugin-element-tabs': {},
'check-md': {
ignore: checklinksIgnoredFiles,
},
seo: {
siteTitle: (_, $site) => $site.title,
title: $page => $page.title,
},
'vuepress-plugin-code-copy': {
color: '#ffffff',
successText: 'Copied to clipboard!',
},
'@vuepress/back-to-top': {},
},
base: checkLegacy(),
plugins: plugins,
head: [
[
'link',
Expand Down Expand Up @@ -503,6 +556,10 @@ module.exports = {
themeConfig: {
logo: '/assets/logo.png',
nav: [
{
text: 'Resource Center',
link: 'https://strapi.io/resource-center',
},
{
text: 'Documentation',
items: [
Expand Down Expand Up @@ -544,13 +601,11 @@ module.exports = {
},
{
text: 'Content-Types Builder',
link:
'/user-docs/latest/content-types-builder/introduction-to-content-types-builder.html',
link: '/user-docs/latest/content-types-builder/introduction-to-content-types-builder.html',
},
{
text: 'Users, Roles, and Permissions',
link:
'/user-docs/latest/users-roles-permissions/introduction-to-users-roles-permissions.html',
link: '/user-docs/latest/users-roles-permissions/introduction-to-users-roles-permissions.html',
},
{
text: 'Plugins',
Expand Down Expand Up @@ -592,8 +647,8 @@ module.exports = {
link: 'https://forum.strapi.io',
},
{
text: 'Slack',
link: 'https://slack.strapi.io',
text: 'Discord',
link: 'https://discord.strapi.io',
},
{
text: 'Awesome-Strapi',
Expand All @@ -616,6 +671,10 @@ module.exports = {
},
],
},
{
text: "We're hiring!",
link: 'https://strapi.io/careers#open-positions',
},
],
repo: 'strapi/documentation',
docsDir: 'docs',
Expand All @@ -634,4 +693,10 @@ module.exports = {
'/user-docs/latest/': sidebar.user,
},
},
markdown: {
extendMarkdown: md => {
// use more markdown-it plugins!
md.use(require('markdown-it-include'))
}
}
};
4 changes: 3 additions & 1 deletion docs/.vuepress/styles/index.styl
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,6 @@
color: $accentColor !important

.el-tabs__item:not(.is-disabled):hover
color: $accentColor !important
color: $accentColor !important

@import "strapi-custom-blocks.styl"
Loading