You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@couchdb.apache.org by benkeen <gi...@git.apache.org> on 2015/08/28 02:00:40 UTC
[GitHub] couchdb-fauxton pull request: Addon generator code update
GitHub user benkeen opened a pull request:
https://github.com/apache/couchdb-fauxton/pull/505
Addon generator code update
This PR updates the addon generation code and documentation:
- now includes a simple “hello world” React component and ties
it in with the route object
- remove legacy doc & code
- gets it up to our new coding standards
- makes it a lot easier to follow + understand
Also updates the main README to list the various .md doc pages
that have started to gather.
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/benkeen/couchdb-fauxton addon-generator-update
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/couchdb-fauxton/pull/505.patch
To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:
This closes #505
----
commit f2a6bc926e2ea48d4516b9b822237acb6b163355
Author: Ben Keen <be...@gmail.com>
Date: 2015-08-27T23:00:55Z
Addon generator code update
This PR updates the addon generation code:
- now includes a simple “hello world” React component and ties
it in with the route object
- remove legacy doc & code
- gets it up to our new coding standards
- makes it a lot easier to follow + understand
Also updates the main README to list the various .md doc pages
that have started to gather.
----
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] couchdb-fauxton pull request: Addon generator code update
Posted by benkeen <gi...@git.apache.org>.
Github user benkeen commented on the pull request:
https://github.com/apache/couchdb-fauxton/pull/505#issuecomment-135587998
@robertkowalski see what you think of this. The update to the addon generator was long overdue, but the change to the main readme is probably a bit more contentious. It seemed strange to have bits and pieces there so I've left only the key important info about Fauxton: how to install, build, deploy. Everything else is linked to in a section at the end.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] couchdb-fauxton pull request: Addon generator code update
Posted by benkeen <gi...@git.apache.org>.
Github user benkeen commented on a diff in the pull request:
https://github.com/apache/couchdb-fauxton/pull/505#discussion_r38247672
--- Diff: tasks/addon/root/routes.js.underscore ---
@@ -11,30 +11,35 @@
// the License.
define([
- "app",
- "api",
- "addons/{%= name.toLowerCase() %}/resources"
+ 'app',
+ 'api',
+ 'addons/{%= name.toLowerCase() %}/resources',
+ 'addons/{%= name.toLowerCase() %}/components.react'
],
-function (app, FauxtonAPI, {%= name %}) {
- var {%= name.substr(0, 1).toUpperCase() + name.substr(1)%}RouteObject = FauxtonAPI.RouteObject.extend({
- layout: "with_sidebar",
- crumbs: [
- ],
+function (app, FauxtonAPI, {%= name %}, Components) {
+ var {%= name.substr(0, 1).toUpperCase() + name.substr(1)%}RouteObject = FauxtonAPI.RouteObject.extend({
+ layout: 'one_pane',
+ roles: [],
routes: {
+ 'example/addon': 'helloWorld'
--- End diff --
I'll make it example/{name} just to prevent any possible conflicts.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] couchdb-fauxton pull request: Addon generator code update
Posted by benkeen <gi...@git.apache.org>.
Github user benkeen commented on the pull request:
https://github.com/apache/couchdb-fauxton/pull/505#issuecomment-135901017
Updated.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] couchdb-fauxton pull request: Addon generator code update
Posted by benkeen <gi...@git.apache.org>.
Github user benkeen commented on the pull request:
https://github.com/apache/couchdb-fauxton/pull/505#issuecomment-136409727
Merged as 78989e6
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] couchdb-fauxton pull request: Addon generator code update
Posted by robertkowalski <gi...@git.apache.org>.
Github user robertkowalski commented on a diff in the pull request:
https://github.com/apache/couchdb-fauxton/pull/505#discussion_r38213954
--- Diff: CONTRIBUTING.md ---
@@ -36,10 +41,14 @@ issue
Closes COUCHDB-XXXX (if there is a Jira ticket)
```
-When you're ready for a review, submit a Pull Request. We regularly check the PR list for Fauxton and should get back to you with a code review. If no one has responded to you yet, you can find us on IRC in #couchdb-dev. Ping **Garren**, **robertkowalski** or **Deathbear**, though anyone in the room should be able to help you.
+When you're ready for a review, submit a Pull Request. We regularly check the PR list for Fauxton and should get back
+to you with a code review. If no one has responded to you yet, you can find us on IRC in #couchdb-dev.
+Ping **Garren** or **robertkowalski** though anyone in the room should be able to help you.
--- End diff --
i was meaning, michellep is also there
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] couchdb-fauxton pull request: Addon generator code update
Posted by robertkowalski <gi...@git.apache.org>.
Github user robertkowalski commented on a diff in the pull request:
https://github.com/apache/couchdb-fauxton/pull/505#discussion_r38213906
--- Diff: CONTRIBUTING.md ---
@@ -36,10 +41,14 @@ issue
Closes COUCHDB-XXXX (if there is a Jira ticket)
```
-When you're ready for a review, submit a Pull Request. We regularly check the PR list for Fauxton and should get back to you with a code review. If no one has responded to you yet, you can find us on IRC in #couchdb-dev. Ping **Garren**, **robertkowalski** or **Deathbear**, though anyone in the room should be able to help you.
+When you're ready for a review, submit a Pull Request. We regularly check the PR list for Fauxton and should get back
+to you with a code review. If no one has responded to you yet, you can find us on IRC in #couchdb-dev.
+Ping **Garren** or **robertkowalski** though anyone in the room should be able to help you.
--- End diff --
michellep :)
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] couchdb-fauxton pull request: Addon generator code update
Posted by robertkowalski <gi...@git.apache.org>.
Github user robertkowalski commented on the pull request:
https://github.com/apache/couchdb-fauxton/pull/505#issuecomment-135814246
cool stuff, just added an idea
we shoudl try to avoid mixing multiple changes/topic into one commit in the future
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] couchdb-fauxton pull request: Addon generator code update
Posted by benkeen <gi...@git.apache.org>.
Github user benkeen closed the pull request at:
https://github.com/apache/couchdb-fauxton/pull/505
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] couchdb-fauxton pull request: Addon generator code update
Posted by benkeen <gi...@git.apache.org>.
Github user benkeen commented on the pull request:
https://github.com/apache/couchdb-fauxton/pull/505#issuecomment-135829789
^^ Agreed on all points. Reg mixing topics, yeah... I started updating the doc then got carried away & updated the main readme too. I'll actually separate that out into a separate commit.
Also, apologies... but I'm going to make one more addition to this PR then ask you to look at this again. I think I'll bake in adding a primary nav item for the plugin. Just so people can see how that piece works.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] couchdb-fauxton pull request: Addon generator code update
Posted by robertkowalski <gi...@git.apache.org>.
Github user robertkowalski commented on a diff in the pull request:
https://github.com/apache/couchdb-fauxton/pull/505#discussion_r38214823
--- Diff: tasks/addon/root/routes.js.underscore ---
@@ -11,30 +11,35 @@
// the License.
define([
- "app",
- "api",
- "addons/{%= name.toLowerCase() %}/resources"
+ 'app',
+ 'api',
+ 'addons/{%= name.toLowerCase() %}/resources',
+ 'addons/{%= name.toLowerCase() %}/components.react'
],
-function (app, FauxtonAPI, {%= name %}) {
- var {%= name.substr(0, 1).toUpperCase() + name.substr(1)%}RouteObject = FauxtonAPI.RouteObject.extend({
- layout: "with_sidebar",
- crumbs: [
- ],
+function (app, FauxtonAPI, {%= name %}, Components) {
+ var {%= name.substr(0, 1).toUpperCase() + name.substr(1)%}RouteObject = FauxtonAPI.RouteObject.extend({
+ layout: 'one_pane',
+ roles: [],
routes: {
+ 'example/addon': 'helloWorld'
--- End diff --
i was suprised by the route when testing it...
how about naming a route like:
`foo: 'helloWorld'` for a module that is named `foo`
```js
routes: {
'{%= name %}': 'helloWorld'
```
i think?
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] couchdb-fauxton pull request: Addon generator code update
Posted by robertkowalski <gi...@git.apache.org>.
Github user robertkowalski commented on the pull request:
https://github.com/apache/couchdb-fauxton/pull/505#issuecomment-136380395
+1
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---