Skip to content

Commit

Permalink
Documentation fixes.
Browse files Browse the repository at this point in the history
  • Loading branch information
Gio Gottardi authored and Gio Gottardi committed Jul 3, 2015
1 parent 91860d4 commit f653899
Show file tree
Hide file tree
Showing 4 changed files with 17 additions and 24 deletions.
24 changes: 10 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,15 @@
Notice!
------------------------------------------------------------

**This application is still being developed! Major components are still in an
unfinished state!**

Django Major Event Log App [![Build Status](https://travis-ci.org/unt-libraries/django-major-event-log.svg?branch=master)](https://travis-ci.org/unt-libraries/django-major-event-log)
============================================================

About
--------------------------

This Django appplication is designed to keep track of major PREMIS events.
The app takes care of both creating and viewing these events. The admin site is
responsible for managing the actual events, which includes creating them as well
as making modifications to the event date, contact info, description, etc. The
other pages are responsible for displaying events with various levels of
detail.
This Django application is designed to keep track of major events in the PREMIS
format. The app takes care of both creating and viewing these events. The
admin site is responsible for managing the actual events, which includes
creating them as well as making modifications to the event date, contact info,
description, etc. The other pages are responsible for displaying events with
various levels of detail.


Requirements
Expand Down Expand Up @@ -78,5 +72,7 @@ Contributors:
* [Damon Kelley](https://github.com/damonkelley)


[Developing/Testing](http://django-major-event-log.readthedocs.org/en/latest/developing.html)
--------------------
Developing/Testing
------------------

Read the latest documentation [here](http://django-major-event-log.readthedocs.org/en/latest/developing.html).
11 changes: 4 additions & 7 deletions docs/developing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,9 @@ Install the requirements

::

$ pip install -r requirements.txt
$ pip install -r requirements-dev.txt

(note that lxml, used in the tests, requires that libxslt and libxml2 be
installed on the system)
.. note:: lxml, used in the tests, requires that libxslt and libxml2 be installed on the system.

Clone the git repository:

Expand All @@ -35,10 +34,8 @@ Start the development server

$ python manage.py runserver

(press Ctrl-c to stop the development server)

You should now be able to access both the admin portion of the app at
127.0.0.1:8000/admin/, or the public-facing side of the app at
You should now be able to access the admin portion of the app at
127.0.0.1:8000/admin/ and the public-facing side of the app at
127.0.0.1:8000/major-event-log/.

Testing
Expand Down
4 changes: 2 additions & 2 deletions docs/model.rst
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,9 @@ event, or which is responsible for managing the events.
Methods
^^^^^^^

``get_absolute_url()`` - This method simply returns the absolute url which
``get_absolute_url()`` - This method returns the absolute url which

This comment has been minimized.

Copy link
@ldko

ldko Jul 3, 2015

Member

url --> URL

points to the event's own details page, minus the domain.

``is_success()`` - This method returns a boolean (True or False) which
``is_success()`` - This method returns a Boolean (True or False) which
indicates if the chosen value for ``outcome`` was success. So, if the event
outcome was a success, then this method would return ``True``.
2 changes: 1 addition & 1 deletion major_event_log/templates/major-event-log/about.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,6 @@
<h1>About</h1>
</div>
<p>This application serves to document major events related to the UNT Libraries` digital preservation projects. These events are not tied to specific objects, but rather affect all preserved objects or major subsets of objects.</p>
<p>The events themselves can be viewed collectively on the home page or individually by clicking on the appropriate event's ID, which will take you to the details page. This page can present the details in HTML, PREMIS XML, or the Atom format. Additionally, the Atom feed will always show the 10 most recent events.</p>
<p>The events themselves can be viewed collectively on the home page or individually by clicking on the appropriate event's ID, which will take you to the details page. This page can present the details in HTML, PREMIS XML, or the Atom format. Additionally, the Atom feed shows 10 events per page, ordered by creation date, newest first.</p>

{% endblock %}

0 comments on commit f653899

Please sign in to comment.