Uploaded image for project: 'IGB'
  1. IGB
  2. IGBF-628

Suggestions for Development Guide Improvements

    Details

    • Type: Improvement
    • Status: Closed (View Workflow)
    • Priority: Major
    • Resolution: Done
    • Affects Version/s: None
    • Fix Version/s: None
    • Labels:
      None

      Description

      Tarun recently went through the IGB Development Guide and noted some suggestions for improvement.

      Please see the comments below to review his suggestions.

        Attachments

          Activity

          Hide
          mason Mason Meyer (Inactive) added a comment -

          https://wiki.transvar.org/display/igbdevelopers/Developing+IGB
          The page above contains a sentence that reads, "To clone your fork, use git clone with the address of your remote fork."

          We should add an example code block for the "git clone" command and possibly bold the term "git clone" in the above sentence.

          Show
          mason Mason Meyer (Inactive) added a comment - https://wiki.transvar.org/display/igbdevelopers/Developing+IGB The page above contains a sentence that reads, "To clone your fork, use git clone with the address of your remote fork." We should add an example code block for the "git clone" command and possibly bold the term "git clone" in the above sentence.
          Hide
          tmall Tarun Mall (Inactive) added a comment -

          https://wiki.transvar.org/display/igbdevelopers/Developing+IGB
          In "Keep your fork in sync with the main repository", user might have to push branch to his own fork after pulling from upstream. We should add "git push origin igb_8_4" as a command to do this.

          Show
          tmall Tarun Mall (Inactive) added a comment - https://wiki.transvar.org/display/igbdevelopers/Developing+IGB In "Keep your fork in sync with the main repository", user might have to push branch to his own fork after pulling from upstream. We should add "git push origin igb_8_4" as a command to do this.
          Hide
          tmall Tarun Mall (Inactive) added a comment -

          https://wiki.transvar.org/display/igbdevelopers/Developing+IGB
          In "Make a branch" section after cloning the repository user will be at master branch, we suggested user to switch to igb_8_3. It'll be really helpful for user if we could explain in one line that why he should use igb_8_3 instead of master.

          Show
          tmall Tarun Mall (Inactive) added a comment - https://wiki.transvar.org/display/igbdevelopers/Developing+IGB In "Make a branch" section after cloning the repository user will be at master branch, we suggested user to switch to igb_8_3. It'll be really helpful for user if we could explain in one line that why he should use igb_8_3 instead of master.
          Hide
          tmall Tarun Mall (Inactive) added a comment -

          https://wiki.transvar.org/display/igbdevelopers/Hello+World+IGB+Plugin+Example
          In Hello world example in section "Deploying the Plugin to IGB" 6th step states that "Select the target directory of your maven project and then click submit". Here selecting target directory actually means the target folder generated by maven, user might get confused it with project folder.

          Show
          tmall Tarun Mall (Inactive) added a comment - https://wiki.transvar.org/display/igbdevelopers/Hello+World+IGB+Plugin+Example In Hello world example in section "Deploying the Plugin to IGB" 6th step states that "Select the target directory of your maven project and then click submit". Here selecting target directory actually means the target folder generated by maven, user might get confused it with project folder.
          Hide
          tmall Tarun Mall (Inactive) added a comment -

          Copy pasting pom.xml contents is not working because of some special characters instead of spaces.

          Show
          tmall Tarun Mall (Inactive) added a comment - Copy pasting pom.xml contents is not working because of some special characters instead of spaces.
          Hide
          dcnorris David Norris (Inactive) added a comment -

          I think you found this bug https://jira.atlassian.com/browse/CONF-31446 in confluence related to special characters. A comment on the issue suggests "A workaround is to avoid double clicking, just single click and highlight. I've started putting reminders above my code blocks that are frequently copy/pasted."

          Show
          dcnorris David Norris (Inactive) added a comment - I think you found this bug https://jira.atlassian.com/browse/CONF-31446 in confluence related to special characters. A comment on the issue suggests "A workaround is to avoid double clicking, just single click and highlight. I've started putting reminders above my code blocks that are frequently copy/pasted."
          Hide
          dcnorris David Norris (Inactive) added a comment -

          Thanks for the feedback Tarun!

          Show
          dcnorris David Norris (Inactive) added a comment - Thanks for the feedback Tarun!

            People

            • Assignee:
              dcnorris David Norris (Inactive)
              Reporter:
              mason Mason Meyer (Inactive)
            • Votes:
              0 Vote for this issue
              Watchers:
              Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: