You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@allura.apache.org by he...@apache.org on 2015/12/15 18:37:11 UTC

[15/15] allura git commit: [#5940] ticket:880 Add documentation

[#5940] ticket:880 Add documentation


Project: http://git-wip-us.apache.org/repos/asf/allura/repo
Commit: http://git-wip-us.apache.org/repos/asf/allura/commit/134c52a0
Tree: http://git-wip-us.apache.org/repos/asf/allura/tree/134c52a0
Diff: http://git-wip-us.apache.org/repos/asf/allura/diff/134c52a0

Branch: refs/heads/master
Commit: 134c52a0c2aa5e5b61ab8574be3b8f52db78ef3a
Parents: e64ab15
Author: Igor Bondarenko <je...@gmail.com>
Authored: Fri Dec 11 13:37:11 2015 +0200
Committer: Heith Seewald <he...@gmail.com>
Committed: Tue Dec 15 11:35:42 2015 -0600

----------------------------------------------------------------------
 Allura/docs/getting_started/administration.rst | 33 +++++++++++++++++++++
 1 file changed, 33 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/allura/blob/134c52a0/Allura/docs/getting_started/administration.rst
----------------------------------------------------------------------
diff --git a/Allura/docs/getting_started/administration.rst b/Allura/docs/getting_started/administration.rst
index 84aa018..c6d23cb 100644
--- a/Allura/docs/getting_started/administration.rst
+++ b/Allura/docs/getting_started/administration.rst
@@ -43,6 +43,39 @@ The admin interface allows you to:
 * Subscribe a user to an artifact
 * Reclone a repository
 
+Customizing appearance
+======================
+
+Global navigation
+-----------------
+
+Allura supports adding global navigation links which will be displayed in the header of every page.
+
+To set up this add :code:`global_nav` option to :code:`[app:main]` section of your :file:`development.ini`. It should be a JSON list of dicts like the following:
+
+.. code-block:: ini
+
+    [app:main]
+    ...
+    global_nav = [{"title": "Example", "url": "http://example.com"}, {"title": "Another", "url": "http://another.com"}]
+
+Site logo
+---------
+
+You can set up logo to be displayed in the top left corner of the site.
+
+Add the following to your :file:`development.ini`:
+
+.. code-block:: ini
+
+    [app:main]
+    ...
+    logo.link = /          ; link to attach to the logo (optional, defaults to "/")
+    logo.path = sf10a.png  ; fs path to the logo image, relative to Allura/allura/public/nf/images/
+    logo.width = 78        ; logo width in pixels (optional)
+    logo.height = 30       ; logo height in pixels (optional)
+
+
 Commands, Scripts, and Tasks
 ============================