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.

Sign up for GitHub

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

Jump to bottom

CHANGE docs for 0.6 release #234

Merged
merged 6 commits into from Nov 6, 2016
Merged

CHANGE docs for 0.6 release #234

merged 6 commits into from Nov 6, 2016

Conversation

ndelangen
Copy link
Member

I've given the docs an overhaul. I'll work on it some more later I think.

Feedback is very welcome.

I spend a considerable amount of time getting the scrolling behavior to work in in casperjs; something I did made it not work anymore, and thus I refactored that a bit into what seemed like a sane test to me.

robhrt7
robhrt7 reviewed Jun 18, 2016
View reviewed changes
assets/css/base/buttons.less
@@ -3,27 +3,27 @@

/* TODO: cosmetic changes needed */
.source_btn {
position:relative;
position:relative;
Copy link
Member

Choose a reason for hiding this comment

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

I see different code style is applied here and there, from 4 to 2 spaces. Let's stick to one, and add csslint/eslint/editorconfig? Keeping the 4 spaces as the standard.

Copy link
Member

Choose a reason for hiding this comment

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

And I would really like to have style changes as separate PR next time.

Copy link
Member Author

Choose a reason for hiding this comment

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

I've tried to make it 4 spaces everywhere, in this particular code example it's 4 spaces.

Copy link
Member Author

Choose a reason for hiding this comment

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

eslint is definitely a must do!

@robhrt7
Copy link
Member

robhrt7 commented Jun 18, 2016

Getting an error on /docs/data-nav/ page

[2016-06-18 17:00:41] [WARN] - Could not pre-render spec with EJS: /docs/data-nav/ [Error: Could not find matching close tag for "<%=".]
Error: Could not find matching close tag for "<%=".
    at /Users/robert-lg/LocalProjects/Source/node_modules/ejs/lib/ejs.js:550:19
    at Array.forEach (native)
    at Object.Template.generateSource (/Users/robert-lg/LocalProjects/Source/node_modules/ejs/lib/ejs.js:536:15)
    at Object.Template.compile (/Users/robert-lg/LocalProjects/Source/node_modules/ejs/lib/ejs.js:458:12)
    at Object.compile (/Users/robert-lg/LocalProjects/Source/node_modules/ejs/lib/ejs.js:318:16)
    at handleCache (/Users/robert-lg/LocalProjects/Source/node_modules/ejs/lib/ejs.js:177:16)
    at exports.render (/Users/robert-lg/LocalProjects/Source/node_modules/ejs/lib/ejs.js:345:10)
    at Object.ejs.render (/Users/robert-lg/LocalProjects/Source/core/ejsWithHelpers.js:147:12)
    at exports.process (/Users/robert-lg/LocalProjects/Source/core/middlewares/preRenderEjs.js:31:33)
    at Layer.handle [as handle_request] (/Users/robert-lg/LocalProjects/Source/node_modules/express/lib/router/layer.js:95:5)

robhrt7
robhrt7 reviewed Jun 18, 2016
View reviewed changes
docs/base/readme.md

### Server-side Templating Engines

As we mentioned before, it's easy to use other server-side templating engines like Jade, you only need to create a simple SourceJS middleware ([example](https://github.com/sourcejs/sourcejs-jade)) or process your sources with Grunt/Gulp.
As we mentioned before, it's also possible to use *other* server-side templating engines like Jade. You need to create a SourceJS middleware that will perform the rendering. Our [sourcjejs-jade Middleware](https://github.com/sourcejs/sourcejs-jade) may serve as an example of such middleware.
Copy link
Member

Choose a reason for hiding this comment

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

Let's keep the name "plugin" for all "sourcejs-*" extensions, middleware is just a type of a plugin, and the name "plugin" in more approachable for non-node devs.

@robhrt7
Copy link
Member

robhrt7 commented Jun 18, 2016

Huge tanks for the help with docs, that's one one of the blockers before final release. The hardest part left now, is to determine the migration path, and re-check compatibility.

@ndelangen
Copy link
Member Author

Thanks for the feedback, I'll work on it more this week.

Sorry for the whitespace commit, I noticed I had placed tabs everywhere, so I had to clean it up.

@ndelangen
Copy link
Member Author

Merged 0.6.0-dev into this branch, if you have no further comments, it can be merged in?

@ndelangen
Copy link
Member Author

@operatino We should pick this up and possibly merge? Let's release 0.6!

@robhrt7
Copy link
Member

robhrt7 commented Sep 12, 2016

@ndelangen, yeah, let's finally do it. I've been cleaning up the issues, not just need to sit down and re-test everything.

@ndelangen
Copy link
Member Author

😴

@ndelangen
Copy link
Member Author

🙁

@ndelangen
Copy link
Member Author

😇

@robhrt7
Copy link
Member

robhrt7 commented Nov 6, 2016

I'll revisit the file name structure in docs folder, but the rest is fine now. Next weeks I'll have few free days, will start final preps before 0.6 release.

@robhrt7 robhrt7 merged commit 6e04656 into sourcejs:0.6.0-dev Nov 6, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@ndelangen @robhrt7