reactioncommerce / reaction-docs Goto Github PK

JavaScript comments are especially hard to read w/ the current syntax highlighting library.

Update logging best practices: https://github.com/reactioncommerce/reaction-docs/blob/master/public-docs/logging.md

^^ because we have docs for Method and Collection Hooks, but no event hooks.

Update TOC for new combined doc parsing in redoc, which will combine multiple docs into a single long scrolling doc with auto generated TOC.

Not sure if this is here or in redoc but all the images on this page https://reactioncommerce.com/docs/development/products are broken.

Documentation updates are needed to reflect changes made in reactioncommerce/reaction#1468.

The work that @jshimko did for email is probably a good jumping off point

The original Horse buildpack no longer works with Reaction (because of the custom plugin loader), but a community member created a fork with my suggested fixes. We need to update the docs to link to that fork instead.

Doc to be updated
https://github.com/reactioncommerce/reaction-docs/blob/development/developer/deploying/heroku.md

New fork of buildpack that has been confirmed as working by multiple users
https://github.com/swrdfish/meteor-buildpack-horse

new buildpack command
heroku buildpacks:set https://github.com/swrdfish/meteor-buildpack-horse.git

relevant conversation
reactioncommerce/reaction#1363 (comment)

Create a page with:

• Recommended Meteor plugins
• Reaction plugins by the community
• Reaction themes by the community

Still references IronRouter

Currently just:
[Note: We will be adding details here about how to process individual orders, including refunds and credits.]

Sometimes the loading screen took forever. Here's what it looks like:

We need an example that walks through building a plugin that modifies the product schema and alters the PDP layout, adding new fields. Would also be useful if the example carried through the cart/checkout customization at some point as well.

https://github.com/reactioncommerce/reaction-example-plugin

add to test plan to clarify issues in reactioncommerce/reaction#948

The link for spiderable on Meteorpedia is broken because it is https:// but Meteorpedia doesn't support it

HI,
Can you please let setup multiple store functionality exist this Meteor app .i need any seller to be able to sell their item.

If this functionality are exist then how can i setup this

• Customization of email templates
• General Email process (jobs, collections)
• UI docs when ready

See: reactioncommerce/reaction#1282

Hey, I get this error message when following the instructions from https://docs.reactioncommerce.com/reaction-docs/development/installation

$ sudo npm install -g reaction-cli
[sudo] password: 
(node:9761) fs: re-evaluating native module sources is not supported. If you are using the graceful-fs module, please update it to a more recent version.
/usr/local/bin/reaction -> /usr/local/lib/node_modules/reaction-cli/dist/main.js
/usr/local/bin/rc -> /usr/local/lib/node_modules/reaction-cli/dist/main.js
/usr/local/lib
└── [email protected] 

npm WARN optional Skipping failed optional dependency /reaction-cli/chokidar/fsevents:
npm WARN notsup Not compatible with your operating system or architecture: [email protected]

I'm using Ubuntu 14 on a Thinkpad if that's relevant. I can't imagine it's the OS.

Need a more high level overview of workflow, layout, registry, themes and how they all work together. Detail out the structure and functionality of the registry structure.

See reactioncommerce/reaction#899

Add clarification on schema field use..

Installation doc reads:

To install and run Reaction locally:

curl https://install.meteor.com | /bin/sh
git clone https://github.com/reactioncommerce/reaction.git
cd reaction
reaction pull
reaction

Isn't this more accurate? :

To install and run Reaction locally:

curl https://install.meteor.com | /bin/sh
git clone https://github.com/reactioncommerce/reaction.git
cd reaction
npm install -g reaction-cli</b>
reaction pull
reaction

remark and remark-lint changed a bunch since it was implemented here. Most notably, see the [email protected] changelog, and the releases for remark page to find out more.

Or, feel free to ping us on Gitter or me below!

Cheers 👋
Titus

The document ends with "Example use in Template:" but there is no example.

In response to the comment about Code Climate linting issues in #71...

I didn't even know markdown was getting linted. We don't have a lint config in this repo and the linter library that CodeClimate uses is written in Ruby. Other than the hassle of Ruby dependencies, the Atom plugin for that library doesn't update warnings on the fly for me. I have to save the file to check for linting changes.

Can we consider switching to a Node based markdown linting lib like remark-lint and start using a config in the repo?

http://remark.js.org/
https://github.com/wooorm/remark
https://github.com/wooorm/remark-lint
https://github.com/wooorm/remark-lint#configuring-remark-lint
https://github.com/wooorm/remark-lint#editor-integrations

I realize Code Climate doesn't support Remark, but I could create a new engine and submit it to them. It's just a basic Docker image that processes the repo files. It'd likely only require copying a similar engine and changing a few small details. Either way, the Ruby deps with save-and-check workflow is suboptimal.

You can install remark-lint globally with npm and then just add linter-markdown to Atom.

npm i -g remark-lint
apm install linter-markdown

Then we'd just need to add a .remarkrc file to override the same defaults that our current linter ignores.

Thoughts?

I will fix what I can, but just putting these in here for reference.

On home page, link to OngoWorks doesn't work

• On https://docs.reactioncommerce.com/reaction-docs/development/using-velocity-for-testing
  Link to Velocity is broken

On https://docs.reactioncommerce.com/reaction-docs/master/i18n
Link to themes.md is broken

On https://docs.reactioncommerce.com/reaction-docs/master/templates
Link to styleguide.md is broken

On https://docs.reactioncommerce.com/reaction-docs/development/reaction-import
Link to Tom's reaction-import repo is broken

On https://docs.reactioncommerce.com/reaction-docs/development/deploying
Links to Galaxy, Docker and AWS are broken.

I have followed the instruction steps in:
https://docs.reactioncommerce.com/reaction-docs/master/deploying-reaction-using-heroku

But i got error:

An error occurred in the application and your page could not be served. If you are the application owner, check your logs for details.

This is logs on heroku:

/app/.meteor/heroku_build/app/programs/server/node_modules/fibers/future.js:280
2017-04-08T02:37:59.418895+00:00 app[web.1]:                                            throw(ex);
2017-04-08T02:37:59.418897+00:00 app[web.1]:                                            ^
2017-04-08T02:37:59.418898+00:00 app[web.1]:
2017-04-08T02:37:59.418899+00:00 app[web.1]: Error: Address must be a valid e-mail address
2017-04-08T02:37:59.418900+00:00 app[web.1]:     at getErrorObject (packages/aldeed_collection2-core.js:480:15)
2017-04-08T02:37:59.418901+00:00 app[web.1]:     at [object Object].doValidate (packages/aldeed_collection2-core.js:462:13)
2017-04-08T02:37:59.418902+00:00 app[web.1]:     at [object Object].Mongo.Collection.(anonymous function) (packages/aldeed_collection2-core.
js:214:25)
2017-04-08T02:37:59.418904+00:00 app[web.1]:     at [object Object].Mongo.Collection.(anonymous function) [as update] (packages/dispatch_run
-as-user.js:325:19)
2017-04-08T02:37:59.418905+00:00 app[web.1]:     at Object.module.export.exports.default.createDefaultAdminUser (server/api/core/core.js:292
:11)
2017-04-08T02:37:59.418906+00:00 app[web.1]:     at Object.module.export.exports.default.init (server/api/core/core.js:34:10)
2017-04-08T02:37:59.418907+00:00 app[web.1]:     at module.export.exports.default (server/startup/init.js:8:12)
2017-04-08T02:37:59.418908+00:00 app[web.1]:     at module.export.exports.default (server/startup/index.js:18:3)
2017-04-08T02:37:59.418909+00:00 app[web.1]:     at server/main.js:6:3
2017-04-08T02:37:59.418909+00:00 app[web.1]:     at Function.time (/app/.meteor/heroku_build/app/programs/server/profile.js:309:28)
2017-04-08T02:37:59.418910+00:00 app[web.1]:     at /app/.meteor/heroku_build/app/programs/server/boot.js:312:13
2017-04-08T02:37:59.418911+00:00 app[web.1]:     at /app/.meteor/heroku_build/app/programs/server/boot.js:353:5
2017-04-08T02:37:59.418912+00:00 app[web.1]:     at Function.run (/app/.meteor/heroku_build/app/programs/server/profile.js:510:12)
2017-04-08T02:37:59.418912+00:00 app[web.1]:     at /app/.meteor/heroku_build/app/programs/server/boot.js:351:11
2017-04-08T02:37:59.603255+00:00 heroku[web.1]: Process exited with status 1
2017-04-08T02:37:59.630433+00:00 heroku[web.1]: State changed from starting to crashed

At least I don't think that this applies anymore?
"Reaction Core provides a single tenant shop."

While developing on my laptop I thought ReactionCommerce was a little slow (sometimes nearly 10 seconds to load the front page). I didn't think much of it, as I'm used to things running slow on my Acer C720 chromebook that I put full linux on, it often struggles.

But now I've moved my setup to a server with 32 cpu cores, 128GB of RAM, hardware RAID-6 on six drives, a cluster of mongos, and I'm still seeing 10 seconds page loads at worst, over a second at best. Is there some 'caching' I'm forgretting to implement?

Update https://github.com/reactioncommerce/reaction-docs/blob/development/developer/configuration.md to reflect changes in PR: reactioncommerce/reaction#2453

Add documentation for reactioncommerce/reaction#1356

• Update user/admin documentation for Product Detail Page Revision
• Update / add developer docs for revisions, the schema, helpers for fetching

Make ReactionRegistry easier to understand

reactioncommerce/reaction#2656

As reported by @lcampanis in reactioncommerce/reaction#1721

In https://docs.reactioncommerce.com/reaction-docs/development/plugin-routes-6

function addRolesToVisitors() {
  // Add the about permission to all default roles since it's available to all
  Logger.info("::: Adding about route permissions to default roles")
  const shop = Shops.findOne(Reaction.getShopId());
  Shops.update(shop._id, {
      $addToSet: { "defaultVisitorRole": "about"}
    }
  );
  Shops.update(shop._id, {
    $addToSet: { "defaultRole": "about"}
  });
}

Change "defaultRole": "about" to "defaultRoles": "about" (notice s)

This can soon be replaced with: https://github.com/reactioncommerce/reaction/pull/1669/files#diff-8efd71b38bf2153707a7eb6da1e58579R242

Also add a "start page" that explains how the docs are laid out similar to djangoproject.com

All reaction components need docs and example on how to use them, and how to theme / override them.

https://docs.reactioncommerce.com/reaction-docs/master/reaction-payments