Skip to content

New Quick Start Guide #288

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 108 commits into from
Jun 23, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
108 commits
Select commit Hold shift + click to select a range
479b85d
Add code-switcher vuepress plugin
pwizla May 6, 2021
ce75023
Create POC of code-switcher plugin usage
pwizla May 6, 2021
4301189
Remove code-switcher plugin, add copy-code plugin
pwizla May 10, 2021
28b553d
Update integration links to form a 3x3 flex layout
pwizla May 10, 2021
37f6725
Add first version of Quick Start Guide rewrite
pwizla May 10, 2021
57cecf2
Add meta tags
pwizla May 11, 2021
56c5763
Add first version of Step 2 for Starters path
pwizla May 11, 2021
10f7084
Remove unnecessary edit icon screenshot
pwizla May 11, 2021
d59208f
Customize CSS
pwizla May 11, 2021
c8807e3
💄 Lint & reword parts of the Starters path
pwizla May 11, 2021
1673fd9
Add first version of Step 2 for Hands-on path
pwizla May 11, 2021
30f4893
Restore integration links look
pwizla May 12, 2021
b413837
Delete old quick start guide files and create a 3-step, 3-file QSG
pwizla May 12, 2021
5242f6e
Update frontmatter title of some files for proper "next/prev" buttons
pwizla May 12, 2021
7b5ec80
Use 'Content-Types Builder' in all dev docs for consistency
pwizla May 12, 2021
663ae39
Update wording for consuming API intro in hands-on path
pwizla May 12, 2021
cec9db4
WIP: Create IntegrationLinksAlt for an alternate look
pwizla May 12, 2021
a8ca2a3
Improve draft
pwizla May 17, 2021
b3e09d0
Improve CSS for InstallLinkAlt components
pwizla May 17, 2021
af5b290
Update wording & links in integration guides
pwizla May 17, 2021
4b1ee7a
Add link to starters in step 3 for starters path
pwizla May 17, 2021
4cf0a4d
Rename quick-start-step1.md back to quick-start.md
pwizla May 18, 2021
80e1d56
Merge branch 'main' into dev/quick-start-guide
pwizla May 18, 2021
5dd6077
Fix sidebar links to consider quick-start-step1 file renaming
pwizla May 18, 2021
88a50fe
Merge branch 'dev/quick-start-guide' of github.com:strapi/documentati…
pwizla May 18, 2021
4e53d09
Group the 3 steps back into a unique file
pwizla May 25, 2021
fba4ee4
Highlight path buttons & create new Requirements style
pwizla May 25, 2021
fa757f3
Delete intermediate congrats
pwizla May 25, 2021
7d175ba
Add more margin below new Requirements block
pwizla May 25, 2021
e9611a1
Replace NPX by NPM in code group titles
pwizla May 25, 2021
9316d56
Title case UI elements
pwizla May 25, 2021
3bca977
Add more margin above path buttons
pwizla May 25, 2021
499985c
Fix links to quick start guide featured in integrations guide
pwizla May 25, 2021
7cc2a46
Rework steps 1 & 2 of Starters path
pwizla May 25, 2021
485941a
Fix step 2 links in integration guides
pwizla May 25, 2021
dd7bd6e
Fix misnaming Step vs. Part
pwizla May 25, 2021
cada5ba
Rework Step 3 of starters path
pwizla May 25, 2021
270ae6d
Add more CSS customizations
pwizla May 26, 2021
65a1d28
Rework introduction
pwizla May 26, 2021
07def64
Rework part 1 of Starters path
pwizla May 26, 2021
c0d0bcc
Rework part 2 of Starters path
pwizla May 26, 2021
6a89341
Rework part 3 of Starters path
pwizla May 26, 2021
fc08af4
Slightly reword congratulations conclusion of Starters path
pwizla May 26, 2021
111af03
Add consistency to step naming
pwizla May 26, 2021
6c10705
Replace Slack by Discord
pwizla May 26, 2021
3f01de2
Rework Hands-on path
pwizla May 27, 2021
04a0273
Rename image files (step → part)
pwizla May 27, 2021
1af9802
Update images
pwizla May 27, 2021
a116985
Improve again Starters path
pwizla May 27, 2021
b6d6bf2
Improve again Hands-on path
pwizla May 27, 2021
a581a35
Experiment with alternate callout styles
pwizla May 27, 2021
378075b
Fix missing uppercase
pwizla May 27, 2021
acfff47
Fine-tune CSS
pwizla May 28, 2021
8595c82
Tone down "congrats" callouts
pwizla May 28, 2021
0b31bcf
Add "use your API" as a final step
pwizla May 28, 2021
e53230e
Simplify "To go further" sections
pwizla May 28, 2021
e785407
Include going to the UI section as a first step in procedures
pwizla May 28, 2021
51d4c42
💄 Clean up CSS
pwizla May 28, 2021
6c55da5
💄 Lint
pwizla May 28, 2021
9415eeb
Adjust viewbox of some integration guide logos so they fit better
pwizla May 28, 2021
0f36b10
Update wording and link for intro of integration guides
pwizla May 28, 2021
0d62361
Restore meta-title for FAQ
pwizla May 28, 2021
0f20b61
Merge branch 'main' into dev/quick-start-guide
pwizla May 28, 2021
13dfaa5
Fix wrong file for Permissions screenshot
pwizla May 31, 2021
f27060f
Be more explicit in tip about server not running
pwizla Jun 1, 2021
e44884f
Add link to Gatsby blog starter
pwizla Jun 1, 2021
8b81001
Switch order for npm / yarn
pwizla Jun 1, 2021
e2c4883
Remove mention of creating your own category from the CM
pwizla Jun 2, 2021
0fb9217
Remove emoji in 'Choose an author and a category…' paragraph
pwizla Jun 2, 2021
9bde13c
Fix (again 😅) wrong screenshot for Users & Permissions
pwizla Jun 2, 2021
7662701
Fix "Draft" not being a button
pwizla Jun 2, 2021
1dda341
Fix bullet points & structure in requirements
pwizla Jun 2, 2021
e9a4861
Enhance sentence about using Gatsby starter
pwizla Jun 2, 2021
54251f5
Merge branch 'dev/quick-start-guide' of github.com:strapi/documentati…
pwizla Jun 2, 2021
e0a3dec
Remove '+' from button names
pwizla Jun 2, 2021
87a71ec
Replace 'dialog' by 'window'
pwizla Jun 2, 2021
2f24cf4
Improve sentence about being prompted for 'Quick Start' in terminal
pwizla Jun 2, 2021
8605566
Replace 'left-hand menu' with 'main navigation'
pwizla Jun 2, 2021
c8b7cb5
Update wording: frontend → front end, backend → back end
pwizla Jun 2, 2021
8cd2053
Rename Parts A, B… instead of 1, 2…
pwizla Jun 2, 2021
b92fd8a
Use hyphenated 'front-end' and 'back-end' when appropriate
pwizla Jun 2, 2021
a4478ad
Update formatting + add many-to-many icon
pwizla Jun 2, 2021
e189648
Remove capitalization for "admin panel"
pwizla Jun 2, 2021
60e81ad
Replace "dropdown" with "drop-down list"
pwizla Jun 2, 2021
71e0d31
Improve Starters path
pwizla Jun 3, 2021
010cd30
Add @vuepress/back-to-top plugin
pwizla Jun 3, 2021
c7d9252
Improve Hands-on path
pwizla Jun 3, 2021
b1d6dad
Update path buttons design
pwizla Jun 3, 2021
2ab9b7c
Update InstallLinkAlt button design
pwizla Jun 3, 2021
933b5d7
Fix InstallLinkAlt button border
pwizla Jun 3, 2021
ee05e85
💄 Add some tiny improvements
pwizla Jun 4, 2021
9b5d729
temp fix for vercel
derrickmehaffy Jun 4, 2021
fa034b2
temp fix for vercel patch 2
derrickmehaffy Jun 4, 2021
691fa9a
Fix code groups not rendering properly
pwizla Jun 4, 2021
64a82ae
Merge branch 'dev/quick-start-guide' of github.com:strapi/documentati…
pwizla Jun 4, 2021
072a1f2
Embed code-groups in <ClientOnly> component
pwizla Jun 4, 2021
2f2370a
Update Nuxt logo
pwizla Jun 14, 2021
738d3b2
Adapt to latest Gatsby starter release
pwizla Jun 15, 2021
5716b4f
Merge branch 'main' into dev/quick-start-guide
pwizla Jun 15, 2021
51a6f81
Switch to card-style tabs to prevent SSR rendering issues of code-groups
pwizla Jun 16, 2021
56823d6
Center Next.js logo
pwizla Jun 17, 2021
c582c53
Replace "requirements" by "prerequisites"
pwizla Jun 17, 2021
1ee2750
Remove unnecessary occurences of "just"
pwizla Jun 17, 2021
e46ec83
Tinker with SVG logo attributes to better align them
pwizla Jun 17, 2021
2a59902
Reduce Ruby + Flutter logo sizes
pwizla Jun 17, 2021
377f82a
Reverting temp fix for Vercel preview
pwizla Jun 21, 2021
42ab03c
Merge branch 'main' into dev/quick-start-guide
pwizla Jun 21, 2021
8147d27
Merge branch 'main' into dev/quick-start-guide
pwizla Jun 23, 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
19 changes: 9 additions & 10 deletions docs/.vuepress/config.js
Original file line number Diff line number Diff line change
Expand Up @@ -131,9 +131,9 @@ const sidebar = {
['/developer-docs/latest/development/plugins/documentation', 'API Documentation'],
['/developer-docs/latest/development/plugins/email', 'Email'],
['/developer-docs/latest/development/plugins/graphql', 'GraphQL'],
['/developer-docs/latest/development/plugins/i18n', 'Internationalization (i18n)'],
['/developer-docs/latest/development/plugins/i18n', 'Internationalization (i18n)'],
['/developer-docs/latest/development/plugins/upload', 'Upload'],
['/developer-docs/latest/development/plugins/users-permissions', 'Users & Permissions']
['/developer-docs/latest/development/plugins/users-permissions', 'Users & Permissions'],
],
sidebarDepth: 1,
},
Expand Down Expand Up @@ -335,18 +335,12 @@ const sidebar = {
collapsable: false,
title: 'Plugins',
children: [
[
'/user-docs/latest/plugins/introduction-to-plugins',
'Introduction to plugins',
],
['/user-docs/latest/plugins/introduction-to-plugins', 'Introduction to plugins'],
[
'/user-docs/latest/plugins/installing-plugins-via-marketplace',
'Installing plugins via the Marketplace',
],
[
'/user-docs/latest/plugins/strapi-plugins',
'List of Strapi plugins',
],
['/user-docs/latest/plugins/strapi-plugins', 'List of Strapi plugins'],
],
},
{
Expand Down Expand Up @@ -397,6 +391,11 @@ module.exports = {
siteTitle: (_, $site) => $site.title,
title: $page => $page.title,
},
'vuepress-plugin-code-copy': {
color: '#ffffff',
successText: 'Copied to clipboard!',
},
'@vuepress/back-to-top': {},
},
head: [
[
Expand Down
109 changes: 109 additions & 0 deletions docs/.vuepress/theme/global-components/InstallLinkAlt.vue
Original file line number Diff line number Diff line change
@@ -0,0 +1,109 @@
<template>
<router-link :to="link" class="install-link install-link--alt">
<span class="install-link__container">
<span class="icon__wrapper">
<slot name="icon" />
</span>
<span class="title__wrapper">
<p class="title"><slot name="title" /></p>
<!-- <p class="description"><slot name="description" /></p> -->
</span>
</span>

</router-link>
</template>

<script>
export default {
name: 'InstallLinkAlt',
props: {
link: {
type: String,
required: true
}
}
}
</script>

<style lang="scss" scoped>
.install-link {
background-color: #f8f8f8;
display: flex;
flex-direction: column;
align-items: center;
justify-content: center;
color: #2c3e50;
padding: 16px;
border-radius: 50%;
width: 40px;
height: 40px;
margin: 16px 0; // You'd normally do layout margins etc from the parent, but seeing the parent
// is a markdown file, that's a bit annoying
text-decoration: none !important;
transition: border-color ease-out .2s;

&:after {
content:'';
position: absolute;
width: 72px;
height: 72px;
border-radius: 50%;
border: solid 1px #bbbbba;
}

&__container {
display: flex;
flex-direction: column;
height: 40px;
}

.icon__wrapper {
flex-shrink: 0;
width: 40px;
height: 40px;
margin-left: auto;
margin-right: auto;
transition: all ease-out .2s;

& ::v-deep svg {
width: 100%;
height: auto;
}
}

.title {
margin-top: 12px;
text-align: center;

&__wrapper {
opacity: 0;
transition: opacity ease-out .2s;
}
}

.description {
font-size: 12px;
margin: 0;
}

&:hover {
&:after {
border-color: #007EFF;
border-width: 2px;
}

.title__wrapper {
opacity: 1;
}

.title {
text-decoration: none;
}

.icon__wrapper {
width: 40px;
height: 44px;
}
}
}
</style>
39 changes: 20 additions & 19 deletions docs/.vuepress/theme/global-components/IntegrationLinks.vue
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<template>
<div>
<div class="integration-links">
<!-- React -->
<div>
<div class="install-link__wrapper">
<InstallLink
link="/developer-docs/latest/developer-resources/content-api/integrations/react.html"
>
Expand Down Expand Up @@ -39,7 +39,7 @@
</div>

<!-- Vue -->
<div>
<div class="install-link__wrapper">
<InstallLink
link="/developer-docs/latest/developer-resources/content-api/integrations/vue-js.html"
>
Expand Down Expand Up @@ -69,7 +69,7 @@
</div>

<!-- Angular -->
<div>
<div class="install-link__wrapper">
<InstallLink
link="/developer-docs/latest/developer-resources/content-api/integrations/angular.html"
>
Expand Down Expand Up @@ -120,7 +120,7 @@
</div>

<!-- Next.js -->
<div>
<div class="install-link__wrapper">
<InstallLink
link="/developer-docs/latest/developer-resources/content-api/integrations/next-js.html"
>
Expand Down Expand Up @@ -172,7 +172,7 @@
</div>

<!-- Nuxt.js -->
<div>
<div class="install-link__wrapper">
<InstallLink
link="/developer-docs/latest/developer-resources/content-api/integrations/nuxt-js.html"
>
Expand Down Expand Up @@ -202,7 +202,7 @@
</div>

<!-- GraphQL -->
<div>
<div class="install-link__wrapper">
<InstallLink
link="/developer-docs/latest/developer-resources/content-api/integrations/graphql.html"
>
Expand Down Expand Up @@ -341,7 +341,7 @@
</div>

<!-- Gatsby -->
<div>
<div class="install-link__wrapper">
<InstallLink
link="/developer-docs/latest/developer-resources/content-api/integrations/gatsby.html"
>
Expand Down Expand Up @@ -370,7 +370,7 @@
</div>

<!-- Gridsome -->
<div>
<div class="install-link__wrapper">
<InstallLink
link="/developer-docs/latest/developer-resources/content-api/integrations/gridsome.html"
>
Expand Down Expand Up @@ -424,7 +424,7 @@
</div>

<!-- Jekyll -->
<div>
<div class="install-link__wrapper">
<InstallLink
link="/developer-docs/latest/developer-resources/content-api/integrations/jekyll.html"
>
Expand Down Expand Up @@ -497,7 +497,7 @@
</div>

<!-- 11ty -->
<div>
<div class="install-link__wrapper">
<InstallLink
link="/developer-docs/latest/developer-resources/content-api/integrations/11ty.html"
>
Expand Down Expand Up @@ -532,7 +532,7 @@
</div>

<!-- Svelte -->
<div>
<div class="install-link__wrapper">
<InstallLink
link="/developer-docs/latest/developer-resources/content-api/integrations/svelte.html"
>
Expand Down Expand Up @@ -574,7 +574,7 @@
</div>

<!-- Sapper -->
<div>
<div class="install-link__wrapper">
<InstallLink
link="/developer-docs/latest/developer-resources/content-api/integrations/sapper.html"
>
Expand Down Expand Up @@ -616,7 +616,7 @@
</div>

<!-- Ruby -->
<div>
<div class="install-link__wrapper">
<InstallLink
link="/developer-docs/latest/developer-resources/content-api/integrations/ruby.html"
>
Expand Down Expand Up @@ -1273,7 +1273,7 @@
</div>

<!-- Python -->
<div>
<div class="install-link__wrapper">
<InstallLink
link="/developer-docs/latest/developer-resources/content-api/integrations/python.html"
>
Expand Down Expand Up @@ -1313,7 +1313,7 @@
</div>

<!-- Dart -->
<div>
<div class="install-link__wrapper">
<InstallLink link="/developer-docs/latest/developer-resources/content-api/integrations/dart.html">
<template #icon>
<svg width="2500" height="2500" viewBox="0 0 256 256" xmlns="http://www.w3.org/2000/svg" preserveAspectRatio="xMinYMin meet"><path d="M70.534 69.696L53.988 53.15l.07 119.6.198 5.59c.082 2.63.57 5.598 1.384 8.674l131.104 46.23 32.772-14.52.012-.04L70.534 69.696" fill="#00D2B8"/><path d="M55.64 187.014l.008.008c-.008-.054-.036-.114-.036-.17 0 .056.008.108.028.162zm163.876 31.71l-32.772 14.52-131.096-46.222c2.504 9.608 8.048 20.408 14.014 26.314l42.784 42.54 95.13.124 11.952-37.316-.012.04z" fill="#55DDCA"/><path d="M3.034 130.116c-4.236 4.522-2.132 13.85 4.688 20.722L37.14 180.5l18.5 6.514c-.814-3.076-1.302-6.044-1.384-8.674l-.198-5.59-.07-119.6-50.954 76.966z" fill="#0081C6"/><path d="M187.82 54.686c-3.076-.786-6.026-1.272-8.7-1.356l-5.908-.204-119.224.016 165.556 165.542h.014l14.54-32.804L187.82 54.686" fill="#0079B3"/><path d="M187.67 54.654c.064.014.114.032.156.038l-.006-.006c-.036-.018-.086-.018-.15-.032zm26.448 14.078c-6.008-6.058-16.666-11.564-26.292-14.04l46.272 131.188-14.54 32.804h-.014l35.532-11.348.076-97.416-41.034-41.188z" fill="#00A4E4"/><path d="M181.338 36.298L151.684 6.862c-6.858-6.794-16.19-8.908-20.7-4.684L53.988 53.142l119.224-.016 5.908.204c2.674.084 5.624.57 8.7 1.356l-6.482-18.388z" fill="#00D2B8"/></svg>
Expand All @@ -1326,7 +1326,7 @@
</div>

<!-- Flutter -->
<div>
<div class="install-link__wrapper">
<InstallLink link="/developer-docs/latest/developer-resources/content-api/integrations/flutter.html">
<template #icon>
<svg enable-background="new 0 0 1999 2474.2" viewBox="0 0 1999 2474.2" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink"><linearGradient id="a" gradientTransform="matrix(380.4042 -380.4175 -53.104 -53.1021 908228.3125 -700059.5)" gradientUnits="userSpaceOnUse" x1="-2115.0029" x2="-2115.0029" y1="1930.7407" y2="1929.7407"><stop offset=".2" stop-opacity=".15"/><stop offset=".85" stop-color="#616161" stop-opacity=".01"/></linearGradient><linearGradient id="b" gradientTransform="matrix(565.291 0 0 -380.9571 1196694.25 743476.5625)" gradientUnits="userSpaceOnUse" x1="-2115.2688" x2="-2114.2688" y1="1946.3563" y2="1946.3563"><stop offset=".2" stop-opacity=".55"/><stop offset=".85" stop-color="#616161" stop-opacity=".01"/></linearGradient><path d="m381 1618-381-381 1237.1-1237h761.9m0 1141.5h-761.9l-285.4 285.4 381 381" fill="#42a5f5" fill-opacity=".8"/><path d="m951.7 2188.8 285.4 285.4h761.9l-666.3-666.3" fill="#0d47a1"/><path d="m571.6 1808.1 380.4-380.5 380.4 380.4-380.4 380.5z" fill="#42a5f5"/><path d="m952 2188.5 380.4-380.4 53.1 53.1-380.4 380.4z" fill="url(#a)"/><path d="m951.7 2188.8 565.3-195.3-184.3-185.7" fill="url(#b)"/></svg>
Expand All @@ -1339,7 +1339,7 @@
</div>

<!-- GO -->
<div>
<div class="install-link__wrapper">
<InstallLink link="/developer-docs/latest/developer-resources/content-api/integrations/go.html">
<template #icon>
<svg version="1.1" viewBox="0 0 400 544.43" xmlns="http://www.w3.org/2000/svg">
Expand All @@ -1360,7 +1360,7 @@
</div>

<!-- PHP -->
<div>
<div class="install-link__wrapper">
<InstallLink link="/developer-docs/latest/developer-resources/content-api/integrations/php.html">
<template #icon>
<svg preserveAspectRatio="xMidYMid" version="1.1" viewBox="0 0 250 135" xmlns="http://www.w3.org/2000/svg">
Expand Down Expand Up @@ -1392,6 +1392,7 @@
</div>
</div>
</template>

<script>
import InstallLink from './InstallLink.vue';

Expand Down
Loading