uDIG
  1. uDIG
  2. UDIG-1631

Move public documentation to public svn

    Details

      Description

      The SDKQuickstart is getting to be a bit of a pain for me to update each release; since it included in the commercial training material (ie private repository). It is nice of Refractions to make this material available to the development community; however now that we are maintaining each and every release it makes sense to have this documentation in the public repository.

      In order for the udig training repository to still read correctly an svn externals link can be used to pull the documentation to a udig_training checkout enjoyed by those who have taken the training course.

      With that in mind:

      This will also allow us to "republish" the documentation for the previous releases; please note this documentation is in open office format; although we could publish pdfs out to the tags?

        Activity

        Hide
        Jody Garnett added a comment -
        Initial round of documents is committed:

        The root folder contains templates for creating new documents and some instructions for their use:
        - http://svn.refractions.net/udig/docs/trunk/

        The developer docs are in a subfolder:
        - http://svn.refractions.net/udig/docs/trunk/devel/

        I lumped all the docs into one folder; and decided to commit the zip archives (icons etc...) as they are.

        The alternative is to create a folder for each set of documentation; and that gets a bit messy but scales better as more docs are added.

        Feedback? What approach would people list to see?

        One folder for devel docs:
        - trunk/devel/CustomApplication.odt
        - trunk/devel/SDKQuickstart.odt
        - trunk/devel/ToolPluginTutorial.odt
        - trunk/devel/WorkbenchSelection.odt
        - trunk/devel/distance_icons.zip
        - trunk/devel/rcp_branding.zip
        - trunk/devel/workbench_icons.zip

        Or one folder for each devel doc:
        - trunk/devel/app/CustomApplication.odt
        - trunk/devel/app/nl (formally part of rcp_branding.zip)
        - trunk/devel/app/icons (formally part of rcp_branding.zip)
        - trunk/devel/quickstart/SDKQuickstart.odt
        - trunk/devel/tool/ToolPluginTutorial.odt
        - trunk/devel/tool/icons (the contents of distance_icons.zip)
        - trunk/devel/workbench/WorkbenchSelection.odt
        - trunk/devel/workbench/icons

        Show
        Jody Garnett added a comment - Initial round of documents is committed: The root folder contains templates for creating new documents and some instructions for their use: - http://svn.refractions.net/udig/docs/trunk/ The developer docs are in a subfolder: - http://svn.refractions.net/udig/docs/trunk/devel/ I lumped all the docs into one folder; and decided to commit the zip archives (icons etc...) as they are. The alternative is to create a folder for each set of documentation; and that gets a bit messy but scales better as more docs are added. Feedback? What approach would people list to see? One folder for devel docs: - trunk/devel/CustomApplication.odt - trunk/devel/SDKQuickstart.odt - trunk/devel/ToolPluginTutorial.odt - trunk/devel/WorkbenchSelection.odt - trunk/devel/distance_icons.zip - trunk/devel/rcp_branding.zip - trunk/devel/workbench_icons.zip Or one folder for each devel doc: - trunk/devel/app/CustomApplication.odt - trunk/devel/app/nl (formally part of rcp_branding.zip) - trunk/devel/app/icons (formally part of rcp_branding.zip) - trunk/devel/quickstart/SDKQuickstart.odt - trunk/devel/tool/ToolPluginTutorial.odt - trunk/devel/tool/icons (the contents of distance_icons.zip) - trunk/devel/workbench/WorkbenchSelection.odt - trunk/devel/workbench/icons
        Hide
        Jesse Eichar added a comment -
        I think this is a great idea.

        Ideally we could have it in a format where code examples etc... could be tested (IE not in a openoffice doc) But the realiity is that we probably don't have the resources to do that. So +1.

        I do have one request though. Is there a way that we can commit exploded zips. If I remember right odt files are just zips as well. This will reduce the speed at which the repo grows.

        Show
        Jesse Eichar added a comment - I think this is a great idea. Ideally we could have it in a format where code examples etc... could be tested (IE not in a openoffice doc) But the realiity is that we probably don't have the resources to do that. So +1. I do have one request though. Is there a way that we can commit exploded zips. If I remember right odt files are just zips as well. This will reduce the speed at which the repo grows.
        Hide
        Jody Garnett added a comment -
        I do not know the details Jesse; let me try 7zip.

        You are correct it opens up the "document" and shows:
        - Pictures
        - Thumbnails
        - META-INF
        - Configurations2
        - context.xml
        - styles.xml
        - settings.xml
        - meta.xml
        - mimetype

        So how could we accomplish this on the practical side of things? Some script you call to explode an odp file; and another to gather it back up again?

        Can I assume you want to explode the distance_icons.zip as well?
        Show
        Jody Garnett added a comment - I do not know the details Jesse; let me try 7zip. You are correct it opens up the "document" and shows: - Pictures - Thumbnails - META-INF - Configurations2 - context.xml - styles.xml - settings.xml - meta.xml - mimetype So how could we accomplish this on the practical side of things? Some script you call to explode an odp file; and another to gather it back up again? Can I assume you want to explode the distance_icons.zip as well?
        Hide
        Jody Garnett added a comment -
        Marking as fixed; the docs are available. Committing an exploded version seems a might bit complicated for today.
        Show
        Jody Garnett added a comment - Marking as fixed; the docs are available. Committing an exploded version seems a might bit complicated for today.

          People

          • Assignee:
            Jody Garnett
            Reporter:
            Jody Garnett
          • Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved: