Project

General

Profile

Bug #5516

continue updating user documentation

Added by Matt Jones almost 8 years ago. Updated over 6 years ago.

Status:
Resolved
Priority:
Normal
Category:
metacat
Target version:
Start date:
10/26/2011
Due date:
% Done:

0%

Estimated time:
Bugzilla-Id:
5516

Description

Documentation needs editing to describe new 2.0.0 features, including support for new DataONE APIs, deprecation of older servlet APIs, and general cleanup.

If possible, moving the admin guide to the sphinx system now would be good.

MetacatOaipmh.doc (111 KB) MetacatOaipmh.doc Matt Jones, 12/13/2011 02:58 PM
intro_mgb.rst (6.43 KB) intro_mgb.rst gastil gastil, 06/05/2012 04:14 PM
diff_intro.txt (2.15 KB) diff_intro.txt gastil gastil, 06/05/2012 04:27 PM
diff_configuration.txt (1.64 KB) diff_configuration.txt gastil gastil, 06/05/2012 05:46 PM
diff_submitting.txt (7.55 KB) diff_submitting.txt gastil gastil, 06/06/2012 08:40 PM

History

#1 Updated by Matt Jones almost 8 years ago

Also add in the OAI-PMH documentation contributed by Duane Costa.

#2 Updated by Matt Jones almost 8 years ago

The Metacat Administrator's Guide has now been completely ported to Sphinx/ReST format, and I've written new chapters for several of the new features, including DataONE and OAI-PMH (from Duane Costa). I've also included the Javadoc API directly in the Admin Guide now. Your revisions would be appreciated.

I also updated the Metacat build so that the documentation can be built automatically when building Metacat (assuming that you have Sphinx installed on your local build machine). Running:

ant documentation war

will produce a war file with the documentation (including both Sphinx docs and Javadoc) shipping inside the knb.war file, so any given metacat deployment that is built this way will have the docs available at:

http://<somehost.org>/knb/docs

I also modified the Hudson build on dev-testing so that the docs would build automatically with each change in Metacat, and so a common place to be able to find the current documentation build is via Hudson, here:

http://dev-testing.dataone.org:8080/hudson/job/Metacat/javadoc/

I changed the hudson build configuration fairly significantly to get it all to run (path problems under hudson), so let me know if the knb.war produced by hudson has any problems. I'm sure there is more editing to be done on the admin guide, especially updated screenshots in a variety of places, but I think we're now in a pretty good place to maintain it well. Your comments in particular on the draft DataONE chapter would be great.

#3 Updated by gastil gastil over 7 years ago

Edits to metacat/trunk/docs/user/metacat/metacat/source/intro.rst

The edited version is attached. Matt said to provide a diff of my changes.
Only changes are the chapters have different numbers and the API is a link now, not an appendix.

diff b intro.rst intro_mgb.rst
72c72
< Chapter Two contains instructions for downloading and installing Metacat and the
--

Chapter Four contains instructions for downloading and installing Metacat and the

74,75c74,75
< Chapter Three covers how to configure Metacat, both for new and upgraded
< installations. Chapter Four details the ways in which you can customize the
---

Chapter Five covers how to configure Metacat, both for new and upgraded
installations. Chapter Seven details the ways in which you can customize the

78,79c78,79
< and creating your own desktop client (like Morpho). Chapter Five discusses how
< to work with Metacat's embedded Geoserver. Chapter Six describes how to set up the
---

and creating your own desktop client (like Morpho). Chapter Eight discusses how
to work with Metacat's embedded Geoserver. Chapter Nine describes how to set up the

81c81
< each other, effectively backing up metadata and data files. Chapter Seven looks
---

each other, effectively backing up metadata and data files. Chapter Ten looks

84c84
< to Metacat. Chapter Eight discusses logging, Chapter Nine contains instructions
---

to Metacat. Chapter Twelve discusses logging, Chapter Thirteen contains instructions

86,87c86,88
< Web searches. Metacat's Java API is included as an appendix at the end of the
< guide.
---

Web searches. Metacat's Java API is `available`_ for developers.

.. _API documentation: ./api/index.html

#5 Updated by gastil gastil over 7 years ago

diff u intro.rst intro_mgb.rst
--
intro.rst 2012-06-05 13:15:16.000000000 0700
++ intro_mgb.rst 2012-06-05 16:04:48.000000000 -0700
@ -69,22 +69,23 @
-------------------

This Administrator's guide includes information for installing, configuring,
managing and extending Metacat for both Linux, Mac OS, and Windows systems.
-Chapter Two contains instructions for downloading and installing Metacat and the
+Chapter Four contains instructions for downloading and installing Metacat and the
applications required to run the software on Linux and Microsoft platforms.
-Chapter Three covers how to configure Metacat, both for new and upgraded
-installations. Chapter Four details the ways in which you can customize the
+Chapter Five covers how to configure Metacat, both for new and upgraded
+installations. Chapter Seven details the ways in which you can customize the
Metacat interface so users can access and submit information easily: using
Metacat's generic web-interface (the Registry), creating your own HTML forms,
-and creating your own desktop client (like Morpho). Chapter Five discusses how
-to work with Metacat's embedded Geoserver. Chapter Six describes how to set up the
+and creating your own desktop client (like Morpho). Chapter Eight discusses how
+to work with Metacat's embedded Geoserver. Chapter Nine describes how to set up the
Metacat's replication service, which permits Metacat servers to share data with
-each other, effectively backing up metadata and data files. Chapter Seven looks
+each other, effectively backing up metadata and data files. Chapter Ten looks
at the Metacat Harvester, a program that automates the retrieval of EML
documents from one or more sites and their subsequent upload (insert or update)
-to Metacat. Chapter Eight discusses logging, Chapter Nine contains instructions
+to Metacat. Chapter Twelve discusses logging, Chapter Thirteen contains instructions
for creating a site map, which makes individual metadata entries available via
-Web searches. Metacat's Java API is included as an appendix at the end of the
-guide.
+Web searches. Metacat's Java API is `available`_ for developers.

+.. _API documentation: ./api/index.html

Metacat Features
----------------

#7 Updated by gastil gastil over 7 years ago

Section 4. Downloading and Installing
Just a presentation issue.
NOT IMPORTANT.
In Firefox, Safari, and chrome, http://dev-testing.dataone.org:8080/hudson/job/Metacat-unstable/javadoc/install.html
displays with the light-grey background div.side-bar overlapping the text of the main part of the page when that text is in a

.  

This section is hands-down the best ever instructions Ive seen for such complex installation.

#8 Updated by gastil gastil over 7 years ago

Minor edits to configuration page: two same-page links and one word change.

#9 Updated by ben leinfelder over 7 years ago

Applied Gastil's edits to intro.rst and configuration.rst

#10 Updated by gastil gastil over 7 years ago

one important edit is the description of the "delete" behavior.

The other edits are just references to Figures and an updated pathQuery example.

I have not finished revising this section 7 but wanted to be sure the "delete" edit gets in.

thank you.

#11 Updated by ben leinfelder over 6 years ago

Gastil, are there any more modifications you want to get into the user docs? Thanks!

#12 Updated by ben leinfelder over 6 years ago

Spoke with Gastil -- we're good for this round of edits.

#13 Updated by Redmine Admin over 6 years ago

Original Bugzilla ID was 5516

Also available in: Atom PDF