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

add strapi:generate template command #308

Merged
merged 1 commit into from
Jun 7, 2021
Merged

Conversation

markkaylor
Copy link
Contributor

What does it do?

Documentation for strapi generate:template

Related issue(s)/PR(s)

strapi/strapi#10331

@markkaylor markkaylor self-assigned this Jun 2, 2021
@vercel
Copy link

vercel bot commented Jun 2, 2021

This pull request is being automatically deployed with Vercel (learn more).
To see the status of your deployment, click below or on the icon next to each commit.

🔍 Inspect: https://vercel.com/strapijs/documentation/DBCdJvhgguwNmvSZbK7H5P7v7hXE
✅ Preview: https://documentation-git-cli-generate-template-strapijs.vercel.app

@strapi-cla
Copy link

strapi-cla commented Jun 2, 2021

CLA assistant check
All committers have signed the CLA.

@remidej
Copy link
Contributor

remidej commented Jun 2, 2021

I think we should also update the docs on how to create a template, especially the step-by-step guide

@markkaylor
Copy link
Contributor Author

I think we should also update the docs on how to create a template, especially the step-by-step guide

Thanks @remidej I'll do that now.

@derrickmehaffy
Copy link
Member

@markkaylor can you sign the CLA please 🙏

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

strapi generate:template <path>
```

- **strapi generate:template &#60;path&#62;**<br/>
Copy link
Collaborator

@pwizla pwizla Jun 4, 2021

Choose a reason for hiding this comment

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

Could you please indent this so that it looks like the other sections?
See the "generate:plugin" section as an example.
Thank you
Screenshot 2021-06-04 at 14 49 14


You can create this file structure by hand or generate it via the [CLI](/documentation/developer-docs/latest/developer-resources/cli/CLI.html#strapi-generate-template)

:::: tabs
Copy link
Collaborator

Choose a reason for hiding this comment

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

Just a FYI (please don't change your PR content for now):

We will switch to more compact/prettier tabs. This is going to be experimented with the upcoming rewritten Quick Start Guide.

We'll use VuePress code groups for a end result like this:
Screenshot 2021-06-04 at 14 56 44

Just so you know for upcoming PRs :-) Thank you!

@@ -133,9 +155,7 @@ After reading the above rules, follow these steps to create your template:

1. Create a standard Strapi app with `create-strapi-app`, using the `--quickstart` option.
2. Customize your app to match the needs of your use case.
3. Outside of Strapi, create a new directory for your template.
4. Create a `template.json` file in your template directory.
3. Generate your template by running `strapi generate:template <path>`
Copy link
Collaborator

Choose a reason for hiding this comment

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

I would add a link to the the corresponding section in the CLI guide here
(the other file you updated in this PR)

Thank you!

Copy link
Collaborator

@pwizla pwizla left a comment

Choose a reason for hiding this comment

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

Thank you very much for the contribution @markkaylor

I've just added a few comments to update to minor things.
And then it will be OK for me. Thank you!

Copy link
Collaborator

@pwizla pwizla left a comment

Choose a reason for hiding this comment

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

LGTM, thanks Mark!

@markkaylor markkaylor merged commit 26a6bd4 into main Jun 7, 2021
@markkaylor markkaylor deleted the cli-generate-template branch June 7, 2021 09:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants