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

dx barriers to entry tags api preview gripes suggestions #1858

Open
leoj3n opened this issue Oct 6, 2022 · 7 comments
Open

dx barriers to entry tags api preview gripes suggestions #1858

leoj3n opened this issue Oct 6, 2022 · 7 comments
Labels
scope:tools type:docs Related to documentation/website

Comments

@leoj3n
Copy link

leoj3n commented Oct 6, 2022

--template flag does not work.

https://twitter.com/MarkoDevTeam/status/1420431542485012485

Or get started with:
npm init marko --template tags-api

this command proposes a dialog to the user to select "Default starter app"

TODO: Twitter post should be ammended to read like that:

Or get started with:
npm init marko@latest -- --template tags-api

probably will need to see if fix can be made in https://github.com/marko-js/cli
also notice suggesting a slight difference to command here:
https://github.com/marko-js/cli/tree/main/packages/create#npm
npm init @marko myapp --template webpack notice the @marko instead of just marko
EDIT: proposed changes here marko-js/cli#214

Example code errors

so after --template tags-api fails causing regular marko5 app user may go ahead and npm install @marko/tags-api-preview then they may try copy/paste example from readme at https://github.com/marko-js/tags-api-preview#example which will fail to compile at which point developer user might say screw it
EDIT: proposed changes here marko-js/tags-api-preview#29

Consider specifying @latest:

npm init marko@latest --template ...

just assuming that @latest could help if someone somehow has outdated marko
NOTE: primarily a suggestion for the Twitter post and/or blog type posts

More examples

regarding: https://github.com/marko-js/tags-api-preview
TODO: mention using npm init marko -- --template tags-api command to create a new project
TODO: point to https://github.com/marko-js/examples/tree/master/examples/tags-api-guide as well

regarding: https://dev.to/ryansolid/introducing-the-marko-tags-api-preview-37o4
TODO: cannot copy/paste code examples as they are all images... perhaps at least provide try online links like for initial count example... could perhaps be added to examples repo as a set of examples similar to the tags-api-guide set of examples
TODO: mention using npm init marko@latest -- --template tags-api command to create a new project

@leoj3n leoj3n added the type:unverified bug A bug report that has not been verified label Oct 6, 2022
@DylanPiercey DylanPiercey added type:docs Related to documentation/website scope:tools and removed type:unverified bug A bug report that has not been verified labels Oct 6, 2022
@DylanPiercey
Copy link
Contributor

Appreciate the callout. We'll look into smoothing those things out. PR's welcome of course 😄

@leoj3n
Copy link
Author

leoj3n commented Oct 6, 2022

Linking related PR marko-js/tags-api-preview#29 (for compile error in readme example)

Linking related PR marko-js/cli#214 (updates npm init command in cli readme)

@leoj3n
Copy link
Author

leoj3n commented Oct 6, 2022

@DylanPiercey looking like the primary issues with A) the readme example needing to be updated to be <let/count=0/> and B) with the npm command needing to look like npm init marko -- --template tags-api should take a minute to solve; think probably do what needs to be done asap since it will make a big difference for people trying to play with tags-api coming from twitter post etc.

@leoj3n
Copy link
Author

leoj3n commented Oct 6, 2022

image

@leoj3n
Copy link
Author

leoj3n commented Oct 6, 2022

image

@DylanPiercey
Copy link
Contributor

Thanks for your work and feedback here.
I should point out that we will be working on a rework of our documentation once the tags api / Marko 6 is in official beta and outside of the preview.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
scope:tools type:docs Related to documentation/website
Projects
None yet
Development

No branches or pull requests

2 participants