[DOCU-110] Improve WebDAV module article Created: 20/Jan/11  Updated: 27/May/11  Resolved: 27/May/11

Status: Closed
Project: Documentation
Component/s: content
Affects Version/s: None
Fix Version/s: None

Type: Task Priority: Neutral
Reporter: Antti Hietala Assignee: Suzanne Deprez
Resolution: Fixed Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Template:
Acceptance criteria:
Empty
Task DoR:
Empty
Date of First Response:

 Description   

Improve the WebDAV module article:

  • Benefits. How does accessing templates and scripts through the file system help designers and developers? They can use their own tools to edit templates, don't need to work through a Magnolia dialog, copying, pasting, backups etc.
  • Watch the WebDAV video in Screencasts and write what is not yet covered.
  • Write procedures for connecting to Magnolia WebDAV for OS X, Linux and Windows. Search for existing procedures on the Web as this is a standard procedure apart from the server URL. No need to reinvent the procedure.
  • Go through resolved and closed Jira issues in the MGNLWEBDAV project and document any features or enhancements that are not yet covered.
  • The module is in Nexus as magnolia-module-webdav. Fix the link.

Related: MGNLWEBDAV-19



 Comments   
Comment by Zdenek Skodik [ 20/Jan/11 ]

btw on top of that we also have some notes at wiki here (and sub-pages) which might come handy. It's from times when we were about to release the very first mgnl-webdav module.

Comment by Suzanne Deprez [ 04/May/11 ]

Activated rewrite. Note that subpage webdrive-screenshots will need to be deleted when rewrite is published. Could not delete now because there is a link to it from the current published version.

Comment by Boris Kraft [ 05/May/11 ]

there is a video on http://www.magnolia-cms.com/magnolia-cms/evaluation/screencasts.html about webdav. You should link to that video. It shows how the whole thing works.

Comment by Antti Hietala [ 09/May/11 ]

Reviewed article. Feedback:

WebDAV

  • "The WebDAV module implements the protocol for accessing the Magnolia repository on a magnoliaAuthor instance." Write "Magnolia" in lowercase fixed-width font if you are referring to the repository name.
  • Add real-life examples. Who would use the module? To do what? Give users an idea what the module can be used for.
  • Add video as suggested by Boris. Example: Content Translation Support

Download

  • "...in the add-ons folder under your Magnolia installation directory."

Connecting to repository

  • "The module allows access to resources and templates workspaces in the magnolia repository." The link targets don't really help understand what resources and templates are. This is because the target pages don't have good content. Your bullets at the bottom of the page are better. Move them up here.
  • "The client setup...". Noun.
  • "a URL"

Connecting with OS X

Connecting with Windows

  • Turn "Mapping network drive" and "FTP type access" links into bullets. Empty headings look odd.
  • Link title "Mapping network drive" does not match target page title.
  • "...cloud category files can be modified on the client". How does this work? I don't see any categories in my resources. They are in a completely different workspace, correct?

Windows mapping drive

  • "...for which a procedure has been provided in this section." I don't find such meta text very helpful. It just adds noise. Opt for simple sentences instead.

Windows network drive mapping

Windows FTP type access

  • Remove page. Just mention on the main page that it is possible to connect to a WebDAV resource with an FTP client. That is where our responsibility ends.
Comment by Suzanne Deprez [ 23/May/11 ]

Added link to video in introductory text instead of a separate section.

With respect to seeing templates in OS X, I was not able to try this myself since I don't have a OS X system. The procedure came from the link provided in that section. Let me know if the procedure does not work. The video also shows accessing templates in OS X. The templating-kit directory should appear once the link has been established.

With respect to the Windows pages' titles not matching the links on the WebDAV page, the titles were changed to indicate the OS for clarity in the menu on the left. The links' text were kept the same on the WebDAV page to be consistent with the text in that section.

There is an example of seeing categoryCloud.ftl in the DataFreeway procedure on http://docuauthor.magnolia-cms.com/modules/webdav/windows-ftp-type-access.html. The file at that location may have been a result of following the procedure for adding cloud images at http://old.nabble.com/Category-cloud-with-image-td31154527.html so the reference was removed.

Agree providing installation instructions of third-party software is beyond the scope of the documentation. Providing information for initializing software to work with Magnolia (i.e. URL, etc.) may help users to decide on which software to use and if they want to try to use the module as well as ease the effort needed to use the module.

Activated rewrite.

Comment by Antti Hietala [ 27/May/11 ]

Closed. For future reference:

  • Use active voice. "You can also download the module from Nexus" is better than "The module can also be downloaded from Nexus"
  • You don't need to create anchors for headings manually. Headings already are anchors.
Generated at Mon Feb 12 01:06:00 CET 2024 using Jira 9.4.2#940002-sha1:46d1a51de284217efdcb32434eab47a99af2938b.