rattail-project/rattail Changeset

Changeset - 6ed439c835bd

Parent rev.

Child rev.

[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:

docs/api/rattail/importing/index.rst

docs/narr/importers.rst

0 comments (0 inline, 0 general)

docs/api/rattail/importing/index.rst

➞

Show inline comments

@@ @@ -15,12 +15,15 @@ However it's more typical to do this instead:: @@
    from rattail import importing
 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
 ---------
  * :class:`rattail.importing.importers.Importer`
  * :class:`rattail.importing.importers.FromQuery`
  * :class:`rattail.importing.importers.BulkImporter`

docs/narr/importers.rst

➞

Show inline comments

 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
  * "warnings" mode which sends email with data diffs, e.g. when you expect no changes
  * adjustable "batch size" for grouping changes when submitting to local system
  * full command line support for above, plus "max" changes to apply, show progress, etc.
@@ @@ -14,14 +14,13 @@ framework for this, which offers the following benefits: @@
  * new importers may be created simply / cleanly / according to existing patterns
  * new importers may extend / replace core functionality as needed
 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"
 -------------------------
 Perhaps the first thing to clear up, is that while Rattail also has a
 "MyPOS" within these docs) to your "local" Rattail system.
 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
 ^^^^^^^^^^^^^^^^^^^^^^^
 With the host and local systems identified, you can now start writing

0 comments (0 inline, 0 general)