Changeset - 6ed439c835bd
[Not reviewed]
0 2 0
Lance Edgar - 5 years ago 2019-08-14 23:24:49
ledgar@techsupport.coop
Add some inter-doc links
2 files changed with 12 insertions and 5 deletions:
0 comments (0 inline, 0 general)
docs/api/rattail/importing/index.rst
Show inline comments
 
@@ -18,6 +18,9 @@ That way you can reference ``importing.Importer`` as well as
 
``importing.model.ProductImporter`` etc.  The full list of what's available in
 
this ``rattail.importing`` namespace follows.
 

	
 
Please also see :doc:`/narr/importers` for some of the general concepts
 
involved here.
 

	
 
Importers
 
---------
 

	
docs/narr/importers.rst
Show inline comments
 
@@ -3,7 +3,7 @@ Data Importers
 
==============
 

	
 
A frequent need when integrating systems is to import (or export, depending on
 
your perspective) data from one system to another.  Rattail provdes a
 
your perspective) data from one system to another.  Rattail provides a
 
framework for this, which offers the following benefits:
 

	
 
 * "dry run" mode to check things out before committing changes
 
@@ -17,8 +17,7 @@ framework for this, which offers the following benefits:
 
The rest of this document aims to explain the concepts and patterns involved
 
with the Rattail importer framework.
 

	
 
.. todo::
 
   Add link for code / API docs here.
 
See also the API docs for :mod:`rattail.importing` (and sub-modules).
 

	
 

	
 
"Importer" vs. "DataSync"
 
@@ -119,8 +118,13 @@ Note also that to make a new importer, you must have already started a project
 
based on Rattail; this doc will not explain that process.  The examples which
 
follow assume this project is named 'myapp'.
 

	
 
.. todo::
 
   Write docs for starting a new Rattail project / link here.
 
.. note::
 
   For now, we do have a wiki doc for `Creating a New Project`_.  Note that the
 
   wiki uses the name "Poser" to refer to the custom app, whereas the doc
 
   you're currently reading uses "myapp" for the same purpose.  Some day they
 
   both should use "Poser" though...
 

	
 
.. _Creating a New Project: https://rattailproject.org/moin/NewProject
 

	
 

	
 
File / Module Structure
0 comments (0 inline, 0 general)