diff --git a/.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md b/.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md index e3c12f501d..ff714bcb8b 100644 --- a/.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md +++ b/.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md @@ -7,6 +7,16 @@ about: Suggest an idea for this project 💡! -**What is the expected behavior?** + + +- [ ] **I have created my request on the Product Board before I submitted this issue** +- [ ] **I have looked at all the other requests on the Product Board before I submitted this issue** + +**Please describe your feature request:** diff --git a/.travis.yml b/.travis.yml index f2486aa99c..f1a1a823dd 100644 --- a/.travis.yml +++ b/.travis.yml @@ -13,6 +13,7 @@ before_install: - export CHROME_BIN=chromium-browser - export DISPLAY=:99.0 - sh -e /etc/init.d/xvfb start + - git fetch -a # - sudo chown -R $(whoami) $(npm config get prefix)/{lib/node_modules,bin,share} # - npm cache clean --force # - rm -rf node_modules/ @@ -21,6 +22,7 @@ install: - npm run setup --debug script: + - npm run lint - npm run doc cache: diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e271fe6335..d29e21e6e3 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -30,7 +30,7 @@ If you send a pull request, please do it against the `master` branch. We are dev *** ## Setup Development Environment -To facilitate the contribution, we drastically reduce the amount of commands necessary to install the entire development environment. First of all, you need to check if you're using the recommended versions of Node.js (v8) and npm (v5). +To facilitate the contribution, we drastically reduce the amount of commands necessary to install the entire development environment. First of all, you need to check if you're using the [required versions of Node.js and npm](https://strapi.io/documentation/3.x.x/getting-started/installation.html#requirements) Then, please follow the instructions below: diff --git a/README.md b/README.md index 6e2d59dfe4..0c16132e52 100644 --- a/README.md +++ b/README.md @@ -137,6 +137,10 @@ For general help using Strapi, please refer to [the official Strapi documentatio Follow our [migration guides](https://github.com/strapi/strapi/wiki) on the wiki to keep your projects up-to-date. +## Roadmap + +Check out our [roadmap](https://portal.productboard.com/strapi) to get informed by the latest feature released and the upcoming ones. You can also give us insights and vote for a specific feature. + ## License [MIT License](LICENSE.md) Copyright (c) 2015-2018 [Strapi Solutions](https://strapi.io/). diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js index 67d1c0a94d..8547f73d70 100644 --- a/docs/.vuepress/config.js +++ b/docs/.vuepress/config.js @@ -1,12 +1,11 @@ const container = require('markdown-it-container') -let ogprefix = 'og: http://ogp.me/ns#' -let title = 'Strapi Documentation' -let description = 'API creation made simple, secure and fast.' -let color = '#2F80ED' -let author = 'Strapi' -let url = 'https://strapi.io/documentation/' - +const ogprefix = 'og: http://ogp.me/ns#' +const title = 'Strapi Documentation' +const description = 'API creation made simple, secure and fast.' +const color = '#2F80ED' +const author = 'Strapi' +const url = 'https://strapi.io/documentation/' module.exports = { head: [ @@ -40,21 +39,27 @@ module.exports = { title, description, base: '/documentation/', + ga: 'UA-54313258-1', themeConfig: { versions: [ ['Version 3.x.x', '/3.x.x/'], ['Version 1.x.x', '/1.x.x/'], ], repo: 'strapi/strapi', + website: 'https://strapi.io', docsDir: 'docs', editLinks: true, editLinkText: 'Improve this page', serviceWorker: true, + hiddenLinks: [ + '/3.x.x/cli/CLI.html', + '/3.x.x/api-reference/reference.html', + ], sidebar: { '/3.x.x/': [ { collapsable: false, - title: 'Getting started', + title: '🚀 Getting started', children: [ '/3.x.x/getting-started/installation', '/3.x.x/getting-started/quick-start', @@ -62,39 +67,31 @@ module.exports = { ], }, { - collapsable: false, - title: 'Guides', + collapsable: true, + title: '💡 Guides', children: [ - '/3.x.x/guides/authentication.md', - '/3.x.x/configurations/configurations.md', - '/3.x.x/guides/controllers.md', - '/3.x.x/guides/deployment.md', - '/3.x.x/guides/email.md', - '/3.x.x/guides/upload.md', - '/3.x.x/guides/filters.md', - '/3.x.x/guides/graphql.md', - '/3.x.x/guides/i18n.md', - '/3.x.x/guides/models.md', - '/3.x.x/guides/policies.md', - '/3.x.x/guides/public-assets.md', - '/3.x.x/guides/requests.md', - '/3.x.x/guides/responses.md', - '/3.x.x/guides/routing.md', - '/3.x.x/guides/services.md', - ], - }, - { - collapsable: false, - title: 'Globals', - children: [ - '/3.x.x/api-reference/reference', - '/3.x.x/cli/CLI', + '/3.x.x/guides/authentication', '/3.x.x/configurations/configurations', + '/3.x.x/guides/controllers', + '/3.x.x/guides/deployment', + '/3.x.x/guides/email', + '/3.x.x/guides/upload', + '/3.x.x/guides/filters', + '/3.x.x/guides/graphql', + '/3.x.x/guides/i18n', + '/3.x.x/guides/models', + '/3.x.x/guides/policies', + '/3.x.x/guides/public-assets', + '/3.x.x/guides/requests', + '/3.x.x/guides/responses', + '/3.x.x/guides/routing', + '/3.x.x/guides/services', + '/3.x.x/guides/webhooks', ], }, { - collapsable: false, - title: 'Advanced', + collapsable: true, + title: '⚙️️ Advanced', children: [ '/3.x.x/advanced/customize-admin', '/3.x.x/advanced/hooks', @@ -103,9 +100,36 @@ module.exports = { '/3.x.x/advanced/usage-tracking', ], }, + { + collapsable: true, + title: '🔌 Plugin Development', + children: [ + '/3.x.x/plugin-development/quick-start', + '/3.x.x/plugin-development/plugin-architecture', + '/3.x.x/plugin-development/backend-development', + '/3.x.x/plugin-development/frontend-development', + '/3.x.x/plugin-development/frontend-use-cases', + '/3.x.x/plugin-development/utils', + // '/3.x.x/plugin-development/ui-components', TODO: Add this file + ], + }, + { + collapsable: true, + title: '💻 Command Line Interface', + children: [ + '/3.x.x/cli/CLI', + ], + }, + { + collapsable: true, + title: '🏗 API Reference', + children: [ + '/3.x.x/api-reference/reference', + ], + }, { collapsable: false, - title: 'Resources', + title: '📚 Resources', children: [ ['https://github.com/strapi/strapi/blob/master/CONTRIBUTING.md', 'Contributing guide'], ['https://github.com/strapi/strapi/wiki', 'Migration guides'], diff --git a/docs/.vuepress/theme/Layout.vue b/docs/.vuepress/theme/Layout.vue index f15c97bb11..b3797fd98a 100644 --- a/docs/.vuepress/theme/Layout.vue +++ b/docs/.vuepress/theme/Layout.vue @@ -5,14 +5,7 @@ @touchend="onTouchEnd"> - -
- -
- -
+
diff --git a/docs/.vuepress/theme/NavLinks.vue b/docs/.vuepress/theme/NavLinks.vue index f29ee0acd5..38dcfd773f 100644 --- a/docs/.vuepress/theme/NavLinks.vue +++ b/docs/.vuepress/theme/NavLinks.vue @@ -9,11 +9,19 @@ - + Website + + + {{ repoLabel }} @@ -92,6 +100,22 @@ export default { } return 'Source' + }, + websiteLink () { + const { website } = this.$site.themeConfig + if (website) { + return /^https?:/.test(website) + ? website + : `https://${website}` + } + }, + slackLink () { + const { slack } = this.$site.themeConfig + if (slack) { + return /^https?:/.test(slack) + ? slack + : `https://${slack}` + } } } } diff --git a/docs/.vuepress/theme/Navbar.vue b/docs/.vuepress/theme/Navbar.vue index f4a9002a37..1e8fa90e13 100644 --- a/docs/.vuepress/theme/Navbar.vue +++ b/docs/.vuepress/theme/Navbar.vue @@ -11,6 +11,9 @@ {{ $siteTitle }} +