Skip to content
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

New Quick Start Guide #288

Merged
merged 108 commits into from
Jun 23, 2021
Merged

New Quick Start Guide #288

merged 108 commits into from
Jun 23, 2021

Conversation

pwizla
Copy link
Collaborator

@pwizla pwizla commented May 18, 2021

What does it do?

Rewrites the Quick Start Guide:

  • 2 paths, the fastest with Starters, and another "hands-on" approach which is a rewrite of the current Quick Start
  • 2 big parts; you can "eject" at the end of each part to discover & play with the product on your own

Note: It is highly encouraged that you compile this locally and read the final document in your browser, instead of just reviewing the text on Github. So you can benefit the most from the experience 🙂

pwizla and others added 23 commits May 6, 2021 15:01
- code-switcher plugin is not compatible with screenshots inside "tabs".
- copy-code plugin is ready to be used but not configured yet
* Step 1 (installation) is written for both paths
* Steps 2 & 3 are just outlines for now
* Current Quick Start Guide file has not been deleted yet, but renamed
* Added first screenshots
* Fix some formatting
* Reword some parts
* Add a few links
@pwizla pwizla self-assigned this May 18, 2021
@derrickmehaffy derrickmehaffy self-requested a review May 18, 2021 17:58
@pwizla pwizla added internal PRs created by the Strapi core team and removed flag: don't merge This PR should not be merged at the moment labels Jun 15, 2021
Once [this issue]( vuejs/vuepress#2711) with
VuePress is fixed, we might be able to use the prettier code-groups
again :-)
It would imply that it's easy, and this is something to avoid in the
documentation :-)
Copy link
Member

@derrickmehaffy derrickmehaffy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@@ -383,7 +377,7 @@ module.exports = {
title: '',
port: 8080,
description: 'The headless CMS developers love.',
base: '/documentation/',
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remember we need to revert this before we merge it

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(Unless we merge in my fix PR)

Copy link
Collaborator Author

@pwizla pwizla Jun 21, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the reminder, Derrick!

I've just reverted it and I suggest we don't change anything on the repo until deploying this Wednesday. We'll switch to a new infra in a few weeks anyway, so that will be the perfect moment to reconsider everything. Thank you! :-)

@@ -1,5 +1,5 @@
---
meta:
- http-equiv: refresh
content: 0;url=/documentation/developer-docs/latest/getting-started/introduction.html
- http-equiv: refresh
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@derrickmehaffy Should I also revert this if we don't merge your workaround PR?

@pwizla pwizla merged commit 3bc73d0 into main Jun 23, 2021
@pwizla pwizla deleted the dev/quick-start-guide branch June 23, 2021 08:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
internal PRs created by the Strapi core team pr: feature release (Was this backported from strapi/strapi PRs? We use "pr: new content" instead.) source: Dev Docs PRs/issues targeting the Developer Docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants