Skip to content

Add TOC, Scaffolding to tech vision doc #166

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 2 commits into from
May 23, 2019
Merged

Conversation

jednano
Copy link

@jednano jednano commented May 22, 2019

Problem

  1. The technical vision document is a bit too long and has no table of contents.
  2. I just published a scaffolding tool that this document would do well to point to.

Solution

  1. Add a table of contents.
  2. Add a section about scaffolding.

@jednano jednano requested a review from DrewML May 22, 2019 22:18
@@ -181,9 +194,14 @@ _Disclaimer: the above list is not exhaustive and is in no particular order._

Ideally, for each front-end project, there will be a separate project that covers both performance and critical-path testing. This project is separate so that it doesn't cripple the short feedback loops of feature development. Additionally, we would do well to have additional performance testing around the most commonly used components (e.g., used in 3+ places).

## Scaffolding

[Yeoman][] is the de facto standard for scaffolding modern web applications. In an effort to make the above guide as painless as possible and to encourage best practices, a [TSX Yeoman Generator](https://www.npmjs.com/package/generator-tsx) has been created for you. Refer to its documentation for more information.
Copy link
Contributor

Choose a reason for hiding this comment

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

Would prefer if we remove is the de facto standard. I won't be too bike-sheddy here, but that's a strong endorsement of a tool that I don't see the FE community adopting much in recent years. We should probably just remain neutral here.

Yeoman is a tool for scaffolding applications.

Copy link
Author

Choose a reason for hiding this comment

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

np

@jednano jednano merged commit e4ec0cf into magento:master May 23, 2019
@jednano jednano deleted the tech-vision branch May 23, 2019 16:14
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.

2 participants