You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@nifi.apache.org by tasanuma <gi...@git.apache.org> on 2018/03/02 00:54:42 UTC

[GitHub] nifi pull request #2503: NIFI-4855: The layout of NiFi API document is broke...

GitHub user tasanuma opened a pull request:

    https://github.com/apache/nifi/pull/2503

    NIFI-4855: The layout of NiFi API document is broken

    Thank you for submitting a contribution to Apache NiFi.
    
    In order to streamline the review of the contribution we ask you
    to ensure the following steps have been taken:
    
    ### For all changes:
    - [ ] Is there a JIRA ticket associated with this PR? Is it referenced 
         in the commit message?
    
    - [ ] Does your PR title start with NIFI-XXXX where XXXX is the JIRA number you are trying to resolve? Pay particular attention to the hyphen "-" character.
    
    - [ ] Has your PR been rebased against the latest commit within the target branch (typically master)?
    
    - [ ] Is your initial contribution a single, squashed commit?
    
    ### For code changes:
    - [ ] Have you ensured that the full suite of tests is executed via mvn -Pcontrib-check clean install at the root nifi folder?
    - [ ] Have you written or updated unit tests to verify your changes?
    - [ ] If adding new dependencies to the code, are these dependencies licensed in a way that is compatible for inclusion under [ASF 2.0](http://www.apache.org/legal/resolved.html#category-a)? 
    - [ ] If applicable, have you updated the LICENSE file, including the main LICENSE file under nifi-assembly?
    - [ ] If applicable, have you updated the NOTICE file, including the main NOTICE file found under nifi-assembly?
    - [ ] If adding new Properties, have you added .displayName in addition to .name (programmatic access) for each of the new properties?
    
    ### For documentation related changes:
    - [ ] Have you ensured that format looks appropriate for the output in which it is rendered?
    
    ### Note:
    Please ensure that once the PR is submitted, you check travis-ci for build issues and submit an update to your PR as soon as possible.


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

    $ git pull https://github.com/tasanuma/nifi NIFI-4855

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

    https://github.com/apache/nifi/pull/2503.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 #2503
    
----
commit 7f0d090ede5c45c75304c2939b3abe812ad04f1f
Author: Takanobu Asanuma <ta...@...>
Date:   2018-03-01T13:57:21Z

    Fix the layout of NiFi API document

----


---

[GitHub] nifi issue #2503: NIFI-4855: The layout of NiFi API document is broken

Posted by mcgilman <gi...@git.apache.org>.
Github user mcgilman commented on the issue:

    https://github.com/apache/nifi/pull/2503
  
    Thanks @tasanuma! This has been merged to master.


---

[GitHub] nifi pull request #2503: NIFI-4855: The layout of NiFi API document is broke...

Posted by tasanuma <gi...@git.apache.org>.
Github user tasanuma commented on a diff in the pull request:

    https://github.com/apache/nifi/pull/2503#discussion_r172100595
  
    --- Diff: nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/resources/templates/index.html.hbs ---
    @@ -675,6 +676,14 @@
                 </div>
                 <div id="system-diagnostic-endpoints" class="section-endpoints hidden"></div>
             </div>
    +        <div class="section">
    +            <div class="section-header">
    +                <div class="title link">Versions</div>
    +                <div class="sub-title section-description">Versioning</div>
    --- End diff --
    
    Thanks for the review, @zenfenan! Updated the pull-request addressing your comments.


---

[GitHub] nifi pull request #2503: NIFI-4855: The layout of NiFi API document is broke...

Posted by asfgit <gi...@git.apache.org>.
Github user asfgit closed the pull request at:

    https://github.com/apache/nifi/pull/2503


---

[GitHub] nifi issue #2503: NIFI-4855: The layout of NiFi API document is broken

Posted by mcgilman <gi...@git.apache.org>.
Github user mcgilman commented on the issue:

    https://github.com/apache/nifi/pull/2503
  
    Will review...


---

[GitHub] nifi issue #2503: NIFI-4855: The layout of NiFi API document is broken

Posted by tasanuma <gi...@git.apache.org>.
Github user tasanuma commented on the issue:

    https://github.com/apache/nifi/pull/2503
  
    Thanks for reviewing and committing it, @mcgilman!


---

[GitHub] nifi pull request #2503: NIFI-4855: The layout of NiFi API document is broke...

Posted by zenfenan <gi...@git.apache.org>.
Github user zenfenan commented on a diff in the pull request:

    https://github.com/apache/nifi/pull/2503#discussion_r172023117
  
    --- Diff: nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/resources/templates/index.html.hbs ---
    @@ -675,6 +676,14 @@
                 </div>
                 <div id="system-diagnostic-endpoints" class="section-endpoints hidden"></div>
             </div>
    +        <div class="section">
    +            <div class="section-header">
    +                <div class="title link">Versions</div>
    +                <div class="sub-title section-description">Versioning</div>
    --- End diff --
    
    Let's try a different one that's a little descriptive here, like "Control flow versioning" or "Save, delete manage flow versioning" or something better?


---

[GitHub] nifi issue #2503: NIFI-4855: The layout of NiFi API document is broken

Posted by tasanuma <gi...@git.apache.org>.
Github user tasanuma commented on the issue:

    https://github.com/apache/nifi/pull/2503
  
    This pull-request uses _**notes**_ variables instead of _**value**_ variables for long sentences.
    
    Before: https://issues.apache.org/jira/secure/attachment/12909857/broken_ui.png
    After: https://issues.apache.org/jira/secure/attachment/12912700/fixed_ui.001.png


---