[GitHub] incubator-nifi pull request: NIFI-152 Dev guide update

classic Classic list List threaded Threaded
13 messages Options
Reply | Threaded
Open this post in threaded view
|

[GitHub] incubator-nifi pull request: NIFI-152 Dev guide update

JPercivall
GitHub user danbress opened a pull request:

    https://github.com/apache/incubator-nifi/pull/15

    NIFI-152 Dev guide update

    I made two tiny tweaks(fixed some broken markup, and changed a "." to a ":"), and updated the processor documentation section to reflect the new generated documentation feature.  You'll see a pull request for that shortly.

You can merge this pull request into a Git repository by running:

    $ git pull https://github.com/danbress/incubator-nifi dev-guide-update

Alternatively you can review and apply these changes as the patch at:

    https://github.com/apache/incubator-nifi/pull/15.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 #15
   
----
commit e4f79ec5fe1123aa5d56dbd40ec54f406bbe5a4d
Author: danbress <[hidden email]>
Date:   2015-02-01T14:10:47Z

    NIFI-152 - Fixing broken link, adding info about Documentation

commit 822173a193a6a724f78b07ba6a04f403b8ecde50
Author: danbress <[hidden email]>
Date:   2015-02-01T14:52:07Z

    NIFI-152 - fixing more markup

----


---
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 [hidden email] or file a JIRA ticket
with INFRA.
---
Reply | Threaded
Open this post in threaded view
|

[GitHub] incubator-nifi pull request: NIFI-152 Dev guide update

JPercivall
Github user joewitt commented on the pull request:

    https://github.com/apache/incubator-nifi/pull/15#issuecomment-73311247
 
    There is an apparent space between the s and the preceeding word in two cases.  Is that intentional?  I am not sure about the processor to component switch and associated docs.  Is that related to the new doc generation capability?  Mark P: Is this something you're working with Dan on?  Definitely want to help close tickets and accept patches but this one I don't know much about.
   
    thanks dan


---
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 [hidden email] or file a JIRA ticket
with INFRA.
---
Reply | Threaded
Open this post in threaded view
|

[GitHub] incubator-nifi pull request: NIFI-152 Dev guide update

JPercivall
In reply to this post by JPercivall
Github user danbress commented on the pull request:

    https://github.com/apache/incubator-nifi/pull/15#issuecomment-73317104
 
    Joe,
    The space is not intentional per se, but without it the monospace markup
    doesn't show up. So we might want to pick one(monospace no 's') or the
    other ('s' with no monospace) or figure out how to do both!
   
    I may have used the word component instead of processor in the section I
    added to reflect that the documentation applies to all configurable
    components(Processors, ControllerServices and ReportingTasks) and not just
    processors.
   
    It might not make sense to merge this until my other pull request is
    merged. I'm working on incorporating Mark's suggestions on that on this
    weekend.
   
    Dan
    On Fri, Feb 6, 2015 at 3:59 PM Joe Witt <[hidden email]> wrote:
   
    > There is an apparent space between the s and the preceeding word in two
    > cases. Is that intentional? I am not sure about the processor to component
    > switch and associated docs. Is that related to the new doc generation
    > capability? Mark P: Is this something you're working with Dan on?
    > Definitely want to help close tickets and accept patches but this one I
    > don't know much about.
    >
    > thanks dan
    >
    > —
    > Reply to this email directly or view it on GitHub
    > <https://github.com/apache/incubator-nifi/pull/15#issuecomment-73311247>.
    >



---
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 [hidden email] or file a JIRA ticket
with INFRA.
---
Reply | Threaded
Open this post in threaded view
|

[GitHub] incubator-nifi pull request: NIFI-152 Dev guide update

JPercivall
In reply to this post by JPercivall
Github user danbress commented on the pull request:

    https://github.com/apache/incubator-nifi/pull/15#issuecomment-73388991
 
    I figured out how to get rid of the space in the html(use ++monospace++s instead of `monospace`s), but now the CSS is padding <code> elements, and I'm not sure how to use their existing stylesheet and only modify that one property.  They seem to be embedding the stylesheet.


---
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 [hidden email] or file a JIRA ticket
with INFRA.
---
Reply | Threaded
Open this post in threaded view
|

Re: [GitHub] incubator-nifi pull request: NIFI-152 Dev guide update

Mark Payne
In reply to this post by JPercivall
Joe,


When I tried to do the pull here, it ended up pulling in all of the changes from the other ticket that Dan was working on. So I backed out the pull and decided to just wait until he had finished up his other ticket (which it looks like he may have now).


Dan,


Not sure why exactly it tried to pull in all the other documentation changes -- did you do it on the same branch as the other? May need to do a patch or a diff instead of a pull request? Not sure. We need to get it separated out though, I think.


Thanks

-Mark








From: joewitt
Sent: ‎Sunday‎, ‎February‎ ‎8‎, ‎2015 ‎6‎:‎01‎ ‎AM
To: [hidden email]





Github user joewitt commented on the pull request:

    https://github.com/apache/incubator-nifi/pull/15#issuecomment-73311247
 
    There is an apparent space between the s and the preceeding word in two cases.  Is that intentional?  I am not sure about the processor to component switch and associated docs.  Is that related to the new doc generation capability?  Mark P: Is this something you're working with Dan on?  Definitely want to help close tickets and accept patches but this one I don't know much about.
   
    thanks dan


---
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 [hidden email] or file a JIRA ticket
with INFRA.
---
Reply | Threaded
Open this post in threaded view
|

Re: [GitHub] incubator-nifi pull request: NIFI-152 Dev guide update

Dan Bress
Mark,
   It was not my intention have the changes from the documentation-generation be part of this as well.  I might have branched off the wrong place.  I'll look now and get back to you.

Dan

Dan Bress
Software Engineer
ONYX Consulting Services

________________________________________
From: Mark Payne <[hidden email]>
Sent: Sunday, February 8, 2015 8:23 AM
To: [hidden email]
Subject: Re: [GitHub] incubator-nifi pull request: NIFI-152 Dev guide update

Joe,


When I tried to do the pull here, it ended up pulling in all of the changes from the other ticket that Dan was working on. So I backed out the pull and decided to just wait until he had finished up his other ticket (which it looks like he may have now).


Dan,


Not sure why exactly it tried to pull in all the other documentation changes -- did you do it on the same branch as the other? May need to do a patch or a diff instead of a pull request? Not sure. We need to get it separated out though, I think.


Thanks

-Mark








From: joewitt
Sent: ‎Sunday‎, ‎February‎ ‎8‎, ‎2015 ‎6‎:‎01‎ ‎AM
To: [hidden email]





Github user joewitt commented on the pull request:

    https://github.com/apache/incubator-nifi/pull/15#issuecomment-73311247

    There is an apparent space between the s and the preceeding word in two cases.  Is that intentional?  I am not sure about the processor to component switch and associated docs.  Is that related to the new doc generation capability?  Mark P: Is this something you're working with Dan on?  Definitely want to help close tickets and accept patches but this one I don't know much about.

    thanks dan


---
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 [hidden email] or file a JIRA ticket
with INFRA.
---
Reply | Threaded
Open this post in threaded view
|

Re: [GitHub] incubator-nifi pull request: NIFI-152 Dev guide update

Dan Bress
Mark,
   OK I'm confused.  I'm looking at the pull request for just this piece:
   https://github.com/apache/incubator-nifi/pull/15/files

   and I see only one file changed(developer-guide.adoc)

   Also when I visualize the branch history for this branch, it does not contain any of the NIFI-280 commits.  So I'm not sure how pulling this in is also getting the doc generation stuff.

Dan Bress
Software Engineer
ONYX Consulting Services

________________________________________
From: Daniel Bress <[hidden email]>
Sent: Sunday, February 8, 2015 10:23 AM
To: [hidden email]
Subject: Re: [GitHub] incubator-nifi pull request: NIFI-152 Dev guide update

Mark,
   It was not my intention have the changes from the documentation-generation be part of this as well.  I might have branched off the wrong place.  I'll look now and get back to you.

Dan

Dan Bress
Software Engineer
ONYX Consulting Services

________________________________________
From: Mark Payne <[hidden email]>
Sent: Sunday, February 8, 2015 8:23 AM
To: [hidden email]
Subject: Re: [GitHub] incubator-nifi pull request: NIFI-152 Dev guide update

Joe,


When I tried to do the pull here, it ended up pulling in all of the changes from the other ticket that Dan was working on. So I backed out the pull and decided to just wait until he had finished up his other ticket (which it looks like he may have now).


Dan,


Not sure why exactly it tried to pull in all the other documentation changes -- did you do it on the same branch as the other? May need to do a patch or a diff instead of a pull request? Not sure. We need to get it separated out though, I think.


Thanks

-Mark








From: joewitt
Sent: ‎Sunday‎, ‎February‎ ‎8‎, ‎2015 ‎6‎:‎01‎ ‎AM
To: [hidden email]





Github user joewitt commented on the pull request:

    https://github.com/apache/incubator-nifi/pull/15#issuecomment-73311247

    There is an apparent space between the s and the preceeding word in two cases.  Is that intentional?  I am not sure about the processor to component switch and associated docs.  Is that related to the new doc generation capability?  Mark P: Is this something you're working with Dan on?  Definitely want to help close tickets and accept patches but this one I don't know much about.

    thanks dan


---
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 [hidden email] or file a JIRA ticket
with INFRA.
---
Reply | Threaded
Open this post in threaded view
|

[GitHub] incubator-nifi pull request: NIFI-152 Dev guide update

JPercivall
In reply to this post by JPercivall
Github user danbress commented on the pull request:

    https://github.com/apache/incubator-nifi/pull/15#issuecomment-73418616
 
    OK, to solve the issue with the space between monospace and s I did the following:
   
    1) copied the asciidoc default stylesheet into our codebase
    2) uncommented a line to import the google web fonts css
    3) modified the copied asciidoc css to remove trailing padding on < code > elements
    4) modified the pom to use the copied asciidoc css
   
    Looks good now!
   
    My very limited understanding of the MIT license reads that we can copy/modify/distribute their asciidoc css with our product so long as include the copyright and the license.  So does this mean as long as the license and copyright are in the ascii-mod.css we are good?  Is there more to it than that?


---
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 [hidden email] or file a JIRA ticket
with INFRA.
---
Reply | Threaded
Open this post in threaded view
|

[GitHub] incubator-nifi pull request: NIFI-152 Dev guide update

JPercivall
In reply to this post by JPercivall
Github user joewitt commented on the pull request:

    https://github.com/apache/incubator-nifi/pull/15#issuecomment-73418821
 
    Regarding licensing I believe you are quite right.  So easily managed.
   
    I don't fully follow the two threads you're working and the branching thing so not quite sure where to go from here.  Maybe kill both threads and just have one overarching one for your work so it can be merged as a unit.  Does that seem fine?  I am happy to help do the licensing part if you like or you can take a crack at it.  I put up a licensing guidance thing on the nifi website (horrifically wordy i realize) that may be of use.
   
    Thanks!
    Joe


---
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 [hidden email] or file a JIRA ticket
with INFRA.
---
Reply | Threaded
Open this post in threaded view
|

[GitHub] incubator-nifi pull request: NIFI-152 Dev guide update

JPercivall
In reply to this post by JPercivall
Github user danbress commented on the pull request:

    https://github.com/apache/incubator-nifi/pull/15#issuecomment-73419231
 
    Joe,
       Cool, thanks for licensing guidence.  I just pushed my change... but I need to read the licensing stuff you wrote to make sure this is in compliance.  Will do that after lunch.
   
       If merging these two things into one is easier I'm happy to do that.  I didn't originally intend for them to be dependent, and they don't modify the same files.  But at this point the content of the changes of this one reflect changes that have happened in the other.  Let me know whats best and I'll do it.
   
    Dan


---
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 [hidden email] or file a JIRA ticket
with INFRA.
---
Reply | Threaded
Open this post in threaded view
|

[GitHub] incubator-nifi pull request: NIFI-152 Dev guide update

JPercivall
In reply to this post by JPercivall
Github user asfgit closed the pull request at:

    https://github.com/apache/incubator-nifi/pull/15


---
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 [hidden email] or file a JIRA ticket
with INFRA.
---
Reply | Threaded
Open this post in threaded view
|

Re: [GitHub] incubator-nifi pull request: NIFI-152 Dev guide update

Mark Payne
In reply to this post by JPercivall
Dan,


Sorry, I must have messed something up. I just did the pull again and all was good. I wonder if I copied the URL for 280, and then highlighted the URL for this pull but didn’t actually hit copy… then I pulled the 280 pull, perhaps? Not sure, but I think all is okay now. I Pushed this, and all is okay.


Thanks!

-Mark






From: Daniel Bress
Sent: ‎Sunday‎, ‎February‎ ‎8‎, ‎2015 ‎10‎:‎40‎ ‎AM
To: [hidden email]





Mark,
   OK I'm confused.  I'm looking at the pull request for just this piece:
   https://github.com/apache/incubator-nifi/pull/15/files

   and I see only one file changed(developer-guide.adoc)

   Also when I visualize the branch history for this branch, it does not contain any of the NIFI-280 commits.  So I'm not sure how pulling this in is also getting the doc generation stuff.

Dan Bress
Software Engineer
ONYX Consulting Services

________________________________________
From: Daniel Bress <[hidden email]>
Sent: Sunday, February 8, 2015 10:23 AM
To: [hidden email]
Subject: Re: [GitHub] incubator-nifi pull request: NIFI-152 Dev guide update

Mark,
   It was not my intention have the changes from the documentation-generation be part of this as well.  I might have branched off the wrong place.  I'll look now and get back to you.

Dan

Dan Bress
Software Engineer
ONYX Consulting Services

________________________________________
From: Mark Payne <[hidden email]>
Sent: Sunday, February 8, 2015 8:23 AM
To: [hidden email]
Subject: Re: [GitHub] incubator-nifi pull request: NIFI-152 Dev guide update

Joe,


When I tried to do the pull here, it ended up pulling in all of the changes from the other ticket that Dan was working on. So I backed out the pull and decided to just wait until he had finished up his other ticket (which it looks like he may have now).


Dan,


Not sure why exactly it tried to pull in all the other documentation changes -- did you do it on the same branch as the other? May need to do a patch or a diff instead of a pull request? Not sure. We need to get it separated out though, I think.


Thanks

-Mark








From: joewitt
Sent: ‎Sunday‎, ‎February‎ ‎8‎, ‎2015 ‎6‎:‎01‎ ‎AM
To: [hidden email]





Github user joewitt commented on the pull request:

    https://github.com/apache/incubator-nifi/pull/15#issuecomment-73311247

    There is an apparent space between the s and the preceeding word in two cases.  Is that intentional?  I am not sure about the processor to component switch and associated docs.  Is that related to the new doc generation capability?  Mark P: Is this something you're working with Dan on?  Definitely want to help close tickets and accept patches but this one I don't know much about.

    thanks dan


---
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 [hidden email] or file a JIRA ticket
with INFRA.
---
Reply | Threaded
Open this post in threaded view
|

[GitHub] incubator-nifi pull request: NIFI-152 Dev guide update

JPercivall
In reply to this post by JPercivall
Github user joewitt commented on the pull request:

    https://github.com/apache/incubator-nifi/pull/15#issuecomment-73420926
 
    dan - no problem.  I take care of the license adjustment and don't combine
    the tickets unless it makes sense.  I wasn't sure but based on what you
    wrote sounds like you were on the right track already.
   
    thanks
    joe
   
    On Sun, Feb 8, 2015 at 11:53 AM, Dan Bress <[hidden email]> wrote:
   
    > Joe,
    > Cool, thanks for licensing guidence. I just pushed my change... but I need
    > to read the licensing stuff you wrote to make sure this is in compliance.
    > Will do that after lunch.
    >
    > If merging these two things into one is easier I'm happy to do that. I
    > didn't originally intend for them to be dependent, and they don't modify
    > the same files. But at this point the content of the changes of this one
    > reflect changes that have happened in the other. Let me know whats best and
    > I'll do it.
    >
    > Dan
    >
    > —
    > Reply to this email directly or view it on GitHub
    > <https://github.com/apache/incubator-nifi/pull/15#issuecomment-73419231>.
    >



---
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 [hidden email] or file a JIRA ticket
with INFRA.
---