Uploaded image for project: 'Documentation'
  1. Documentation
  2. DOCU-1504

Streamline docu section "Development environment"

    XMLWordPrintable

Details

    • Story
    • Resolution: Unresolved
    • Neutral
    • None
    • None
    • None

    Description

      We have the section "Development environment" with its subpages

      • Apache Tomcat
      • Eclipse (and subpages)
      • Git
      • Java Development Kit
      • Maven

      We had (more than one) hipchat discussion to remove some of its pages.
      As ahietala states in hipchat:

      That section was written before light development was a thing. The only way to develop on Magnolia was with Java and we want to guide new developers.

      True!
      Some of the pages are still relevant, actually must be there.
      Others are nearly impossible to maintain and should be removed.
      Some needs improvements or additional links.


      For the time being i propose the following things - but let's discuss this also with support guys such as miruela, rgange.

      Remove

      • Eclipse

      Keep

      • Maven

      Unsure
      Java Development Kit
      we also have the page https://documentation.magnolia-cms.com/display/DOCS56/_Get+Java which is included in other pages; that one is more detailled.
      I propose to slightly change Java Development Kit by reusing the _Get Java
      -
      Apache Tomcat
      Remove or rewrite. If we rewrite:
      Get rid of windows stuff. Mention the Magnolia tomcat-barebone.Maybe mention CLI.
      If the page is for development only - I would propose to hype CLI.
      To setup a prod. env. - this is a different story.
      -
      Git
      Seems fine to keep. To be checked whether the content still makes sense.

       
      Intro page "Development environment"

      • Also mention CLI! (which requires node.js)

      Checklists

        Acceptance criteria

        Attachments

          Issue Links

            Activity

              People

                Unassigned Unassigned
                cmeier Christoph Meier
                Votes:
                0 Vote for this issue
                Watchers:
                2 Start watching this issue

                Dates

                  Created:
                  Updated: