reactioncommerce / redoc Goto Github PK

I can't figure out exactly why this is happening and not other places. But this line of markdown

## Removing Products
To remove an entire product, login as a user with sufficient permissions, and click the Delete icon in     the grid view. To remove an individual variant, see the Product Variant section below.

Is displaying like this:

Search docs, using Docs.alias as auto-complete prompt. Search full text of Docs.pageContentData.
Dropdown with results, click dropdown result go to page.

Running npm install on Ubuntu 16.04 will throw:
npm ERR! Failed at the [email protected] install script 'node-pre-gyp install --fallback-to-build'.

The workaround is to run the following before npm install:
npm install node-gyp node-pre-gyp

This will generate a warning:
npm WARN prefer global [email protected] should be installed with -g

Installing globally requires sudo...

In this line, I think parent should be changed to parentDoc
https://github.com/reactioncommerce/redoc/blob/master/packages%2Fredoc-core%2Fserver%2Fmethods%2FprocessDoc.js#L106

use the docPath and anchor contents to xref the TOC and render the CacheDocs document.

local path links are not working in many of our documents. We need to document/explain/fix this strategy to get all our local paths working.

The problem:

We're currently seeing failing links like:

https://docs.reactioncommerce.com/reaction-docs/development/configuration.md

a working version of this link is:

https://docs.reactioncommerce.com/reaction-docs/development/configuration

It seems to work when the last segment in the path matches the last segment of a docPath defined in redoc.json.

In this section: https://docs.reactioncommerce.com/reaction-docs/development/deploying-reaction-using-heroku

There are code blocks like this:

heroku addons:create mongolab

Which do not display at all.

Navigation is not working. Follows the github button install. Didn't see this locally. Maybe needs to be added to browser-policy?

    at https://buttons.github.io/buttons.js:1:5312
    at HTMLIFrameElement.a (https://buttons.github.io/buttons.js:1:934)```

Autoscroll documents as you scroll down the docs/ TOC. Load next document in the order of the TOC when you reach bottom of page.

Insert, delete, reorder TOC from admin UI.

• add accounts, accounts-base
• add sortable, position property to TOC (or just use array order?)
• add discrete login link to docs
• add default admin user
• do not use "/admin" or anthing so obvious, so allow for docs "admin",.suggest "redoc/admin"
• visibility / publish / unpublish
• flushDocCache / refresh element

using "products", and viewing console you'll see breaking links. We need to tweak the regex replace a little.

The search function will highlight the search term with a , and will also add that to URLs:

screen shot 2018-01-26 at 2 35 35 pm

Search the docs using the keyword 'email' the search results will include an item titled: "An Introduction to Architecture: Alerts, Notifications & Emails" which leads to a 404 :(

Docs needed explaining webhook implementation, purpose, and how to configure.

Please see the Error Log Below.

Error: Can't find npm module 'classnames'. Did you forget to call 'Npm.depends' in package.js within
at Object.Npm.require (D:\Devprojects\docs.meteor\local\build\programs\server\boot.js:175:17)
at options.fallback (packages/modules/modules.js:20:1)
at require (packages/modules/.npm/package/node_modules/install/install.js:79:1)
at meteorInstall.app.common.docs.toc.jsx (common/docs/toc.jsx:3:56)
at fileEvaluate (packages/modules/.npm/package/node_modules/install/install.js:183:1)
at require (packages/modules/.npm/package/node_modules/install/install.js:75:1)
at meteorInstall.app.common.docs.docs.jsx (common/docs/docs.jsx:2:40)
at fileEvaluate (packages/modules/.npm/package/node_modules/install/install.js:183:1)
at require (packages/modules/.npm/package/node_modules/install/install.js:75:1)
at D:\Devprojects\docs.meteor\local\build\programs\server\app\app.js:1507:1

Console error appearing as a result of Update Repo Cache cron job:

Appears when job runs.

    at Object.Future.wait (/Users/aaronjudd/.meteor/packages/meteor-tool/.1.4.2_3.1rd9djy++os.osx.x86_64+web.browser+web.cordova/mt-os.osx.x86_64/dev_bundle/server-lib/node_modules/fibers/future.js:449:15)
    at MongoConnection.<anonymous> (packages/meteor.js:213:24)
    at MongoConnection.(anonymous function) [as update] (packages/mongo/mongo_driver.js:774:49)
    at [object Object].update (packages/mongo/collection.js:589:29)
    at [object Object].Mongo.Collection.(anonymous function) [as update] (packages/aldeed_collection2-core.js:232:19)
    at [object Object].upsert (packages/mongo/collection.js:676:15)
    at updateRepoData (packages/reactioncommerce:redoc-co```

Currently browser back displays correct history but not page contents.

Should reload previous page from history.

Related to #31

Router should reload page.

According to Google Analytics, there hasn't been data from docs.reactioncommerce.com since those 2 weeks in March 2016. We need Segment to send data to GA.

Update sidebar to collapse "guide-sub-nav-items" into "guide-nav-items.".

Update with responsive / hamburger menu for mobile.

• YAML Front Matter (YAML header) processing.
• Add ability to combine multiple smaller docs into one large doc

related: reactioncommerce/reaction-docs#29

We are starting to use REDOC for the Rocket.Chat documentation. Awesome work!

What do you guys think about following Telescope approach and moving the core code into packages, or just a big package that can be added into other projects?

This might be a dupe of #81 but it's hard to tell as that issue is a little vague.

No matter how wide you make it they are still obscured.

Must use bowserHistory from react-router instead of using history module. React router 2.0 deprecated the use of it.

a header method to inject a remote header template and data to be rendered locally. This should be possible with DDP.connect . The goal would be that Meteor sites could have a continuous flow when integrated in another Meteor site, and redoc itself wouldn't need customization.

Add Gitter sidecar to Docs
Get settings from Meteor.settings

When you do a search and look through the result you get al the matching entries and then basically it starts over and shows them all again. Not a huge deal but worth fixing.

Quick test caused recurring crash, so this needs a little investigation.

W20170503-11:18:19.900(-7)? (STDERR) Error: failed [404] 404: Not Found
W20170503-11:18:19.900(-7)? (STDERR)     at Object.Future.wait (/Users/aaronjudd/.meteor/packages/meteor-tool/.1.4.4_2.1165hub++os.osx.x86_64+web.browser+web.cordova/mt-os.osx.x86_64/dev_bundle/server-lib/node_modules/fibers/future.js:449:15)

https://github.com/bryanbraun/anchorjs

I was trying to do meteor --settings settings.json and I got the following error messages:

I20170118-10:22:06.416(8) (percolate_synced-cron.js:87) SyncedCron: Scheduled "Update Repo Cache" next run @Wed Jan 18 2017 12:00:00 GMT+0800 (CST)
I20170118-10:22:06.419(8) (percolate_synced-cron.js:87) SyncedCron: Scheduled "Flush Docs Cache" next run @Wed Jan 18 2017 12:00:00 GMT+0800 (CST)
W20170118-10:22:06.915(8)? (STDERR) /Users/username/.meteor/packages/meteor-tool/.1.4.2_3.1rd9djy++os.osx.x86_64+web.browser+web.cordova/mt-os.osx.x86_64/dev_bundle/server-lib/node_modules/fibers/future.js:313
W20170118-10:22:06.916(8)? (STDERR)             throw(ex);
W20170118-10:22:06.916(8)? (STDERR)             ^
W20170118-10:22:06.917(8)? (STDERR) 
W20170118-10:22:06.917(8)? (STDERR) Error: failed [404] 404: Not Found 
W20170118-10:22:06.917(8)? (STDERR)     at Object.Future.wait (/Users/username/.meteor/packages/meteor-tool/.1.4.2_3.1rd9djy++os.osx.x86_64+web.browser+web.cordova/mt-os.osx.x86_64/dev_bundle/server-lib/node_modules/fibers/future.js:449:15)
W20170118-10:22:06.918(8)? (STDERR)     at Object.call (packages/meteor.js:213:24)
W20170118-10:22:06.918(8)? (STDERR)     at Object.HTTP.get (packages/http/httpcall_common.js:50:20)
W20170118-10:22:06.918(8)? (STDERR)     at getRepoData (packages/reactioncommerce:redoc-core/server/methods/repoData.js:82:35)
W20170118-10:22:06.919(8)? (STDERR)     at updateRepoData (packages/reactioncommerce:redoc-core/server/methods/repoData.js:108:22)
W20170118-10:22:06.919(8)? (STDERR)     at packages/reactioncommerce:redoc-core/server/startup.js:54:3
W20170118-10:22:06.919(8)? (STDERR)     at Function.time (/Users/username/Desktop/redoc/.meteor/local/build/programs/server/profile.js:301:28)
W20170118-10:22:06.919(8)? (STDERR)     at /Users/username/Desktop/redoc/.meteor/local/build/programs/server/boot.js:304:13
W20170118-10:22:06.920(8)? (STDERR)     at /Users/username/Desktop/redoc/.meteor/local/build/programs/server/boot.js:345:5
W20170118-10:22:06.920(8)? (STDERR)     at Function.run (/Users/username/Desktop/redoc/.meteor/local/build/programs/server/profile.js:480:12)
W20170118-10:22:06.920(8)? (STDERR)     - - - - -
W20170118-10:22:06.920(8)? (STDERR)     at makeErrorByStatus (packages/http/httpcall_common.js:13:10)
W20170118-10:22:06.921(8)? (STDERR)     at Request._callback (packages/http/httpcall_server.js:113:17)
W20170118-10:22:06.921(8)? (STDERR)     at Request.self.callback (/Users/username/.meteor/packages/http/.1.2.10.3yb3pj++os+web.browser+web.cordova/npm/node_modules/request/request.js:200:22)
W20170118-10:22:06.921(8)? (STDERR)     at emitTwo (events.js:87:13)
W20170118-10:22:06.922(8)? (STDERR)     at Request.emit (events.js:172:7)
W20170118-10:22:06.922(8)? (STDERR)     at Request.<anonymous> (/Users/username/.meteor/packages/http/.1.2.10.3yb3pj++os+web.browser+web.cordova/npm/node_modules/request/request.js:1067:10)
W20170118-10:22:06.923(8)? (STDERR)     at emitOne (events.js:82:20)
W20170118-10:22:06.923(8)? (STDERR)     at Request.emit (events.js:169:7)
W20170118-10:22:06.923(8)? (STDERR)     at IncomingMessage.<anonymous> (/Users/username/.meteor/packages/http/.1.2.10.3yb3pj++os+web.browser+web.cordova/npm/node_modules/request/request.js:988:12)
W20170118-10:22:06.924(8)? (STDERR)     at emitNone (events.js:72:20)
=> Exited with code: 1
=> Your application is crashing. Waiting for file change.

I was wondering if there's anything that I did wrong? Thanks.

add *.js entries to the TOC, and render these with jsdoc-parse for a API section.

on a fresh install where no settings are supplied the defaults should load toc,etc from redoc, it used to do this but is now defaulting to reaction-doc. see: packages/redoc-core/lib/startup.js

No document is loaded when at the root of the doc site.

Steps to reproduce:

1. Navigate to the root (i.e. /) and do not select a subsection
2. Select a different branch from the dropdown
3. Observe that "Requested document not found for this version." is shown and the url contains "undefined"

Once you select a subsection, everything works as expected.

A failing acceptance test is included in PR

We defined ROOT_URL as a subfolder (eg. http://localhost:3000/docs).
If we didn't touch the code, it would just not work at all. Server would render correctly, but then client would re-render a blank page. Any thoughts on how to fix that?
We went ahead and made a few changes to the code, so now it works on a subfolder, but it has it's drawbacks. First, we had to include a meta tag, and now all links have to be relative instead of absolute. Second, although clicking a menu link will open the right URL, if you inspect the link, you'll notice that it points to what would be an invalid location, i.e., without the /docs, and so search engine crawlers wouldn't be able to crawl our page. Do you have a walkthrough on how to run this on a subfolder? TIA

• Updated to latest meteor 1.3 beta
• Restructure app to mirror suggested application structure
• Add 3rd level to TOC
• Add an "edit this on github" link to each doc
• Update styles: Typography
• Update styles: Condense width of content area to help with readability
• Update styles: Increase width of sidebar to make it feel less cramped and support a 3rd level
• Accounts: Sign in with github
• Accounts: Simple admin page or button to refresh the doc cache (admins only)