|
a |
|
b/ForgeImporters/docs/index.rst |
|
|
1 |
.. Licensed to the Apache Software Foundation (ASF) under one
|
|
|
2 |
or more contributor license agreements. See the NOTICE file
|
|
|
3 |
distributed with this work for additional information
|
|
|
4 |
regarding copyright ownership. The ASF licenses this file
|
|
|
5 |
to you under the Apache License, Version 2.0 (the
|
|
|
6 |
"License"); you may not use this file except in compliance
|
|
|
7 |
with the License. You may obtain a copy of the License at
|
|
|
8 |
|
|
|
9 |
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
10 |
|
|
|
11 |
Unless required by applicable law or agreed to in writing,
|
|
|
12 |
software distributed under the License is distributed on an
|
|
|
13 |
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
|
|
14 |
KIND, either express or implied. See the License for the
|
|
|
15 |
specific language governing permissions and limitations
|
|
|
16 |
under the License.
|
|
|
17 |
|
|
|
18 |
The *ForgeImporters* Package
|
|
|
19 |
============================
|
|
|
20 |
|
|
|
21 |
This package contains the base framework for project and
|
|
|
22 |
tool importers, as well as the core importers, for the
|
|
|
23 |
Allura platform.
|
|
|
24 |
|
|
|
25 |
Project importers will be available at
|
|
|
26 |
:file:`/{nbhd-prefix}/import_project/{importer-name}/`,
|
|
|
27 |
while individual tool importers will be available under the
|
|
|
28 |
Import sidebar entry on the project admin page.
|
|
|
29 |
|
|
|
30 |
Available Importers
|
|
|
31 |
===================
|
|
|
32 |
|
|
|
33 |
The following importers are available in this package for
|
|
|
34 |
use with an Allura system.
|
|
|
35 |
|
|
|
36 |
.. toctree::
|
|
|
37 |
:maxdepth: 1
|
|
|
38 |
:glob:
|
|
|
39 |
|
|
|
40 |
importers/*
|
|
|
41 |
|
|
|
42 |
Importer Framework
|
|
|
43 |
==================
|
|
|
44 |
|
|
|
45 |
The following classes make up the base framework for
|
|
|
46 |
importers.
|
|
|
47 |
|
|
|
48 |
.. toctree::
|
|
|
49 |
|
|
|
50 |
framework
|