Permalink
Browse files

ignore _build files

  • Loading branch information...
1 parent 9dae549 commit d92e147240911ba994b949c66ced900a1beb99c6 @evildmp committed Apr 26, 2013
Showing with 2 additions and 7,956 deletions.
  1. +2 −1 .gitignore
  2. BIN docs/_build/doctrees/arkestra_for_users/entities.doctree
  3. BIN docs/_build/doctrees/arkestra_for_users/introduction.doctree
  4. BIN docs/_build/doctrees/arkestra_for_users/things_never_to_do.doctree
  5. BIN docs/_build/doctrees/environment.pickle
  6. BIN docs/_build/doctrees/getting_started/getting_started.doctree
  7. BIN docs/_build/doctrees/getting_started/installation.doctree
  8. BIN docs/_build/doctrees/getting_started/installation_notes.doctree
  9. BIN docs/_build/doctrees/getting_started/starting_your_own_project.doctree
  10. BIN docs/_build/doctrees/how_it_works/arkestra_generic_models.doctree
  11. BIN docs/_build/doctrees/how_it_works/image_sizing_system.doctree
  12. BIN docs/_build/doctrees/how_it_works/links_system.doctree
  13. BIN docs/_build/doctrees/how_it_works/migration.doctree
  14. BIN docs/_build/doctrees/how_it_works/templates.doctree
  15. BIN docs/_build/doctrees/how_it_works/using_news_and_events.doctree
  16. BIN docs/_build/doctrees/how_it_works/video_system.doctree
  17. BIN docs/_build/doctrees/index.doctree
  18. +0 −4 docs/_build/html/.buildinfo
  19. BIN docs/_build/html/_images/entity-change-list.png
  20. BIN docs/_build/html/_images/entity-change-view.png
  21. +0 −144 docs/_build/html/_sources/arkestra_for_users/entities.txt
  22. +0 −76 docs/_build/html/_sources/arkestra_for_users/introduction.txt
  23. +0 −47 docs/_build/html/_sources/arkestra_for_users/things_never_to_do.txt
  24. +0 −45 docs/_build/html/_sources/getting_started/getting_started.txt
  25. +0 −71 docs/_build/html/_sources/getting_started/installation.txt
  26. +0 −82 docs/_build/html/_sources/getting_started/installation_notes.txt
  27. +0 −45 docs/_build/html/_sources/getting_started/starting_your_own_project.txt
  28. +0 −452 docs/_build/html/_sources/how_it_works/arkestra_generic_models.txt
  29. +0 −183 docs/_build/html/_sources/how_it_works/image_sizing_system.txt
  30. +0 −141 docs/_build/html/_sources/how_it_works/links_system.txt
  31. +0 −160 docs/_build/html/_sources/how_it_works/migration.txt
  32. +0 −55 docs/_build/html/_sources/how_it_works/templates.txt
  33. +0 −83 docs/_build/html/_sources/how_it_works/using_news_and_events.txt
  34. +0 −16 docs/_build/html/_sources/how_it_works/video_system.txt
  35. +0 −65 docs/_build/html/_sources/index.txt
  36. BIN docs/_build/html/_static/ajax-loader.gif
  37. +0 −540 docs/_build/html/_static/basic.css
  38. BIN docs/_build/html/_static/comment-bright.png
  39. BIN docs/_build/html/_static/comment-close.png
  40. BIN docs/_build/html/_static/comment.png
  41. +0 −256 docs/_build/html/_static/default.css
  42. +0 −247 docs/_build/html/_static/doctools.js
  43. BIN docs/_build/html/_static/down-pressed.png
  44. BIN docs/_build/html/_static/down.png
  45. BIN docs/_build/html/_static/file.png
  46. +0 −154 docs/_build/html/_static/jquery.js
  47. BIN docs/_build/html/_static/minus.png
  48. BIN docs/_build/html/_static/plus.png
  49. +0 −62 docs/_build/html/_static/pygments.css
  50. +0 −560 docs/_build/html/_static/searchtools.js
  51. +0 −151 docs/_build/html/_static/sidebar.js
  52. +0 −23 docs/_build/html/_static/underscore.js
  53. BIN docs/_build/html/_static/up-pressed.png
  54. BIN docs/_build/html/_static/up.png
  55. +0 −808 docs/_build/html/_static/websupport.js
  56. +0 −260 docs/_build/html/arkestra_for_users/entities.html
  57. +0 −179 docs/_build/html/arkestra_for_users/introduction.html
  58. +0 −163 docs/_build/html/arkestra_for_users/things_never_to_do.html
  59. +0 −96 docs/_build/html/genindex.html
  60. +0 −129 docs/_build/html/getting_started/getting_started.html
  61. +0 −178 docs/_build/html/getting_started/installation.html
  62. +0 −198 docs/_build/html/getting_started/installation_notes.html
  63. +0 −151 docs/_build/html/getting_started/starting_your_own_project.html
  64. +0 −499 docs/_build/html/how_it_works/arkestra_generic_models.html
  65. +0 −301 docs/_build/html/how_it_works/image_sizing_system.html
  66. +0 −250 docs/_build/html/how_it_works/links_system.html
  67. +0 −280 docs/_build/html/how_it_works/migration.html
  68. +0 −161 docs/_build/html/how_it_works/templates.html
  69. +0 −238 docs/_build/html/how_it_works/using_news_and_events.html
  70. +0 −132 docs/_build/html/how_it_works/video_system.html
  71. +0 −169 docs/_build/html/index.html
  72. BIN docs/_build/html/objects.inv
  73. +0 −100 docs/_build/html/search.html
  74. +0 −1 docs/_build/html/searchindex.js
View
@@ -37,4 +37,5 @@ _design
_content
_tmp
dist
-build
+build
+_build
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
@@ -1,4 +0,0 @@
-# Sphinx build info version 1
-# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 30564d2d9d9b2ee309d8f7951e50770d
-tags: fbb0d17656682115ca4d033fb2f83ba1
Deleted file not rendered
Deleted file not rendered
@@ -1,144 +0,0 @@
-####################
-Entities
-####################
-
-**************************************************
-What exactly is an entity?
-**************************************************
-An *entity* could be:
-
-an organisation:
- *Cardiff University School of Medicine*
-a part of a larger organisation:
- *Institute of Infection & Immunity*
- *Research Office*
-a group of other entities:
- *Research institutes*

- *Administrative & support offices*
-a collection of people:
- *Web editors*
- *School IT liaison officers*
-
-Entities exist in a *hierarchy*, which might look like:
-
-* Cardiff University
-
- * Cardiff University School of Medicine
-
- * Institutes
-
- * Institute of Infection & Immunity
- * Institute of Cancer Genetics
- * Institute of Medical Education
-
- * Admissions
- * Assessments
- * Administrative offices
-
- * Finance
- * Personnel
-
-**************************************************
-Managing entities
-**************************************************
-
-Let's start by getting to work on an entity.
-
-The Entities change list
-************************
-
-In the Arkestra admin site, find `Contacts & people` > `Entities`. They are arranged in a tree reflecting the hierarchy of entities.
-
-.. figure:: entity-change-list.png
- :width: 100%
- :alt: map to buried treasure
-
- The **Entities** change list
-
-You can:
-
-* **search** the list of Entities
-* **filter** the list according to various criteria
-* **expand and collapse** sections of the hiearchy using the controls in the window
-* **move** entites by dragging them around within the tree
-
-Either select an existing entity to edit, or create a new one if none exist.
-
-Editing an entity
-*****************
-
-.. figure:: entity-change-view.png
- :width: 100%
- :alt: map to buried treasure
-
- The **Entity** change view - you'll find many of the same controls and
- features throughout Arkestra's adminstration interface.
-
-This is where we tell Arkestra what it needs to know about our entity.
-
-Basic information
-=================
-
-Name
- its official title, in full
-
-Short name for menus
- a shorter version, if required
-
-Image
- an image (for example a logo)
-
-Home page
- The entity will likely have a number of pages associated with it in the
- **Pages** system that; select the root page of that section. Arkestra will
- know that *all* the pages in that section belong to this entity.
-
-Parent
- The entity's parent in the hierarchy. You can also change this by dragging the entity around in the change list, but if the hierarchy contains hundreds of items, this is a more efficient way to do it.
-
-Include parent entity's name in address
- Arkestra builds an entity's address automatically, and will include its parent's name in that automatically. Usually that makes sense (*IT Office, School of Medicine*, but sometimes it might look silly (*Cardiff University School of Medicine, Cardiff University*), so this allows us to turn it off.
-
-Abstract
- Some entities are actual organisational entities, like the University or the Research Office. Others are just useful groupings, or *abstract entities*.
-
-Location
-========
-
-Address
- This is there to show you how Arkestra will render the entity's address
-
-Building
- where the entity is based
-
-Building recapitulates entity name
- Sometimes, the building name and the entity name are so similar it would be silly to have them both in the address. If so, this field allows Arkestra to know that it shouldn't include them both in addresses
-
-Precise location
- the place *inside* the building - floor, room number, etc
-
-Precise location
- any note for potential visitors
-
-Contact
-========
-
-Email address
- if the entity has its own email address
-
-Phone contacts
- choose or add a suitable label; don't try to format numbers
-
-Contacts & people, News & Events, Vacancies & Studentships
-==========================================================
-
-Arkestra will publish pages of various types automatically if required. The
-controls are very similar for them all, and also for other modules that might
-be added by other applications, and will look much like:
-
-Publish a contacts and people page for this entity automatically
- if this entity should have its own contacts and people page
-
-Title
- what the page should be called
-
@@ -1,76 +0,0 @@
-#######################
-The concept of Arkestra
-#######################
-
-Arkestra was conceived as an answer to the problem: **what is the best way for
-an organisation to publish information on the web?**
-
-**************************************************
-The shortcomings of web content management systems
-**************************************************
-
-**Content management systems rarely work very well**, especially when
-organisations use them, and the bigger the organisation and the site, the
-worse the problems.
-
-Web content management systems waste users' time, and their work, and produce
-sites full of inconsistent content, inconsistently presented.
-
-They don't offer users enough freedom to do what they need, and they offer too
-much, so they can do things they shouldn't - both at the same time.
-
-Arkestra is an attempt to avoid these pitfalls, by taking a different
-approach.
-
-**************************************************
-Arkestra's approach
-**************************************************
-
-Arkestra **models the real world**, building meaningful real-world relationships
-into its structures.
-
-It's a **semantic publishing system** rather than a *content management system*;
-it handles **meaningful information**, rather than mere content or data, and makes
-as much use as possible of this information as possible.
-
-Arkestra has been designed around a single key imperative: **don't waste
-people’s time.**
-
-Wherever possible, Arkestra should:
-
-* make it easy to capture and manage useful information
-* make the information easily re-usable
-* re-use it automatically and appropriately whenever possible
-
-**************************************************
-Arkestra's model of the world
-**************************************************
-
-Arkestra begins by modelling the basic concept of an organisation. An
-organisation - an **Entity** in Arkestra's terminology - might:
-
-* contain other sub-entities within it
-* occupy a number of buildings across different sites
-* have people who have various different roles in it, and engage in different
- activities
-* hold events of various kinds
-* need to publish news about its activities
-
-... amongst numerous other things.
-
-Arkestra models all of these, and their relationships to each other.
-
-If an entity is a based in a certain building, and that building has a postal
-address, Arkestra can work out the correct postal address for the entity. If a
-person works in that entity, Arkestra can infer the person's address.
-
-If a particular set of web pages is associated with a particular entity, then
-Arkestra will be able to associate other relevant things with those pages -
-people, events, news and so on - automatically.
-
-These things can will also be associated with each other in various important
-ways in the real world: an event might feature particular people, and take
-place at a particular date and time, in a particular location; Arkestra models
-and makes use of these relationships too.
-
-The next section will examine entities more closely.
@@ -1,47 +0,0 @@
-##########################
-Things you should never do
-##########################
-
-Arkestra has been deisgned to guide you towards the right way of doing things, and away from bad practices. As far as it can, it will warn or even reprimand you when necessary, but you still need to be aware of the right and wrong way to do things.
-
-**************************************************
-Warning signs
-**************************************************
-
-If you ever find yourself doing any of these things, it's an excellent sign that you are probably doing something wrong:
-
-Entering information that is already in Arkestra
-************************************************
-
-The whole point of Arkestra is to record, manage and publish information,
-automatically wherever possible. If you find yourself entering the same
-information twice, then you're not allowing Arkestra to help you by re-using
-it (it also means that you now have the information in two places, both of
-which will have to be kept up-to-date).
-
-A good example is address information. You should almost never have to write
-out an address in Arkestra. Arkestra maintains information about places,
-including their addresses.
-
-Inventing new ways of using it
-******************************
-
-Don't be creative with Arkestra. There's no guarantee that the clever new way
-of doing something you've discovered will continue to work in the future. It's
-much safer and more reliable to learn how Arkestra is *supposed* to work.
-
-Finding 'solutions' to apparent problems or shortcomings
-********************************************************
-
-You're almost certain to discover shortcomings and even faults in Arkestra.
-Don't try to work around them. That will only ever produce a second-best, and
-uncertain, solution. It's much better to report them, so that Arkestra can be
-improved, and accommodate whatever need you have for it.
-
-**************************************************
-The worst things you can do
-**************************************************
-
-Some abuses are worse than others...
-
-1. Write "here", or "click here", in link text.
@@ -1,45 +0,0 @@
-#########################
-Starting your own project
-#########################
-
-*********************************
-Using the bundled example project
-*********************************
-
-Arkestra comes with a bundled example project - in the `example` folder - which is ready to go, complete with database and media files.
-
-Once you have the example project running, have a look at the site.
-
-The admin interface is at `/admin`; username and password are both `arkestra`.
-
-Once logged in to the admin, set your `Site` appropriately - `/admin/sites/site/`.
-
-************************
-Running your own project
-************************
-
-The `example` project in Arkestra contains a ready-made `settings.py` file, not to mention the `urls.py` and so on that you'll need.
-
-Either copy these, or if you know what you're doing, copy the relevant parts to the files in your own project.
-
-Start with the Python runserver, and get that going.
-
-In order to make anything work, you'll need to do log in to Admin (username and password are both `arkestra`) and do three things.
-
-* create a Page
-* create an Entity
-* link the Entity to the Page, by selecting the Page as the Entity's /Home page/
-
-And since Arkestra needs to know what the *base entity* of your site is, in your ``arkestra_settings`` file add something like::
-
-ARKESTRA_BASE_ENTITY = 1
-
-where the value corresponds to the id of your base entity.
-
-*************
-In production
-*************
-
-Run `collectstatic` - https://docs.djangoproject.com/en/dev/ref/contrib/staticfiles for media files to get them into the right place.
-
-For deployment, point your web hosting platform not at `settings.py`, but `deployment_settings.py`, which turns off various debug modes.
Oops, something went wrong.

0 comments on commit d92e147

Please sign in to comment.