incubator-allura-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From brond...@apache.org
Subject git commit: Add a "Using Allura" section in our docs
Date Tue, 07 Jan 2014 15:19:00 GMT
Updated Branches:
  refs/heads/master d2baf30fc -> 8c9de147d


Add a "Using Allura" section in our docs


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

Branch: refs/heads/master
Commit: 8c9de147df7e4c68ef5c180411f6c0285e46770d
Parents: d2baf30
Author: Dave Brondsema <dave@brondsema.net>
Authored: Tue Jan 7 10:16:02 2014 -0500
Committer: Dave Brondsema <dave@brondsema.net>
Committed: Tue Jan 7 10:16:02 2014 -0500

----------------------------------------------------------------------
 Allura/docs/index.rst |  8 +++++++
 Allura/docs/using.rst | 58 ++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 66 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-allura/blob/8c9de147/Allura/docs/index.rst
----------------------------------------------------------------------
diff --git a/Allura/docs/index.rst b/Allura/docs/index.rst
index 7d8b82f..98fc5cb 100644
--- a/Allura/docs/index.rst
+++ b/Allura/docs/index.rst
@@ -39,6 +39,14 @@ Running Allura
    scm_host
    migration
 
+Using Allura
+=====================================================================
+
+.. toctree::
+   :maxdepth: 2
+
+   using
+
 Developing Allura
 =====================================================================
 

http://git-wip-us.apache.org/repos/asf/incubator-allura/blob/8c9de147/Allura/docs/using.rst
----------------------------------------------------------------------
diff --git a/Allura/docs/using.rst b/Allura/docs/using.rst
new file mode 100644
index 0000000..d9be6fe
--- /dev/null
+++ b/Allura/docs/using.rst
@@ -0,0 +1,58 @@
+..     Licensed to the Apache Software Foundation (ASF) under one
+       or more contributor license agreements.  See the NOTICE file
+       distributed with this work for additional information
+       regarding copyright ownership.  The ASF licenses this file
+       to you under the Apache License, Version 2.0 (the
+       "License"); you may not use this file except in compliance
+       with the License.  You may obtain a copy of the License at
+
+         http://www.apache.org/licenses/LICENSE-2.0
+
+       Unless required by applicable law or agreed to in writing,
+       software distributed under the License is distributed on an
+       "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+       KIND, either express or implied.  See the License for the
+       specific language governing permissions and limitations
+       under the License.
+
+We don't have much end-user help for Allura yet.  SourceForge projects use Allura,
+though, so their support documentation may be useful to anyone using Allura:
+
+Configuring your project
+------------------------
+
+See SourceForge help page: https://sourceforge.net/p/forge/documentation/Create%20a%20New%20Project/
+
+Note there are some SourceForge-specific references that don't apply to other Allura instances.
+
+
+Using tickets
+-------------
+
+See SourceForge help page: https://sourceforge.net/p/forge/documentation/Tickets/
+
+
+Using the wiki
+--------------
+
+See SourceForge help page: https://sourceforge.net/p/forge/documentation/Wiki/
+
+
+Using a discussion forum
+------------------------
+
+See SourceForge help page: https://sourceforge.net/p/forge/documentation/Discussion/
+
+
+Adding an external link
+-----------------------
+
+See SourceForge help page: https://sourceforge.net/p/forge/documentation/External%20Link/
+
+
+Using markdown syntax
+---------------------
+
+Everything in Allura uses Markdown formatting, with several customizations and macros
+specifically for Allura.  There are "Formatting Help" buttons throughout Allura for
+easy reference to the Markdown syntax.  One such page is https://forge-allura.apache.org/p/allura/wiki/markdown_syntax/
\ No newline at end of file


Mime
View raw message