question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Move main plugin/package docs from here to babel/babel

See original GitHub issue

If you have issues please comment here, join our slack (signup: slack.babeljs.io, url: babeljs.slack.com), ping @babeljs on twitter

#528

eg http://babeljs.io/docs/plugins/transform-es2015-modules-systemjs/ vs https://github.com/babel/babel/tree/master/packages/babel-plugin-transform-es2015-modules-systemjs The “via CLI” & “via Node API” are missing. IMHO README should be the source for the webpage automated builder. Added preferred bonus: the web page links to README (“Edit doc contents in README”).

https://github.com/babel/babel.github.io/issues/528 was implemented via https://github.com/babel/babel.github.io/pull/990 (git submodule and rendering the markdown from the README)

Now this website repo can pull in information from the actual readme.md file used for npm in the babel repo.

Issue

What we need to do now is to move the docs in docs/ to link to the README’s in babel/babel/packages

Basically for those docs we want to take the contents there and replace them.

Example: https://github.com/babel/babel.github.io/pull/990/files#diff-b11e0ae0e12e1f69b9e7bd1a63ac06d2R20

screen shot 2016-11-22 at 3 35 33 pm

Instructions

For each docs page that needs to be changed:

  • Find the correct page on the babel website docs under docs/ to edit: Example is docs/plugins/preset-stage-0.md
screen shot 2016-11-22 at 3 36 18 pm
  • Find the corresponding page on babel/babel: Example is [babel-preset-stage-0/README.md]
screen shot 2016-11-22 at 3 37 00 pm

(https://github.com/babel/babel/blob/master/packages/babel-preset-stage-0/README.md)

  • Copy over any missing information from the website page (this repo) to the main babel repo README (it’s not as updated usually).

This might be extra links, examples, etc:

screen shot 2016-11-22 at 3 38 26 pm
  • Replace the old contents with {% include package_readme.html %}
screen shot 2016-11-22 at 3 35 33 pm

This may mean a PR to the main babel repo as well as this repo.

Another Example

Check both https://github.com/babel/babel/pull/4884 and https://github.com/babel/babel.github.io/commit/241be67ed65a4162876972fff839dd5c318595c2

Misc

It’s fine to do this one pr at a time, you don’t have to change everything or all of the docs! (makes it easier to review too)

Issue Analytics

  • State:closed
  • Created 7 years ago
  • Comments:6 (6 by maintainers)

github_iconTop GitHub Comments

3reactions
existentialismcommented, Dec 2, 2016

Remaining READMEs to move (feel free to call dibs!):

  • babel-plugin-external-helpers (@raspo)
  • babel-plugin-transform-class-constructor-call (@raspo)
  • babel-plugin-transform-class-properties (@raspo)
  • babel-plugin-transform-decorators (@raspo)
  • babel-plugin-transform-do-expressions (@raspo)
  • babel-plugin-transform-es3-member-expression-literals (@raspo)
  • babel-plugin-transform-es3-property-literals (@raspo)
  • babel-plugin-transform-es5-property-mutators (@raspo)
  • babel-plugin-transform-eval (@raspo)
  • babel-plugin-transform-exponentiation-operator (@raspo)
  • babel-plugin-transform-export-extensions (@raspo)
  • babel-plugin-transform-flow-comments (@raspo)
  • babel-plugin-transform-flow-strip-types (@raspo)
  • babel-plugin-transform-function-bind (@raspo)
  • babel-plugin-transform-jscript (@raspo)
  • babel-plugin-transform-object-assign (@lukyth)
  • babel-plugin-transform-object-rest-spread (@raspo)
  • babel-plugin-transform-object-set-prototype-of-to-assign (@raspo)
  • babel-plugin-transform-proto-to-assign (@raspo)
  • babel-plugin-transform-runtime (@raspo)
  • babel-plugin-transform-strict-mode (@raspo)
  • babel-plugin-undeclared-variables-check (@raspo)
1reaction
lukythcommented, Nov 23, 2016

I’m going to work on this!

Read more comments on GitHub >

github_iconTop Results From Across the Web

Configure Babel
Create a file called babel.config.json with the following content at the root of your project (where the package.json is). ... Here is an...
Read more >
Migration Guide — Girder 3.1.7 documentation - Read the Docs
This document is meant to guide Girder plugin developers in transitioning between major versions of Girder. Major version bumps contain breaking changes to ......
Read more >
Guide to Webpack 5 - Stack Abuse
In this guide, learn how Webpack 5 works, how to set it up, bundle JavaScript applications and transpile to other ES versions for...
Read more >
ESLint's new config system, Part 2: Introduction to flat config
A pluggable and configurable linter tool for identifying and reporting on patterns in JavaScript. Maintain your code quality with ease.
Read more >
CopyWebpackPlugin | webpack
Copies individual files or entire directories, which already exist, to the build directory. Getting Started. To begin, you'll need to install copy-webpack- ...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found