dox icon indicating copy to clipboard operation
dox copied to clipboard

Define fundamental publishing process

Open mitchell-then opened this issue 6 years ago • 0 comments

As new features are being added to dox, the publishing process has become more complicated and has undergone significant changes. A robust publishing process should be proposed to accommodate current features and new processes.

Currently, dox supports:

  • root page parent of child pages (require root page ID)
  • attaching images to a page (require that page ID)
  • linking to relative pages (requires dependent page IDs)

Current implementation involves a two step process. Create a stub page solely for the purpose of obtaining/creating a page ID. Then update the content of the pages. Process as follows:

  • create stub of root page (obtain root page ID)
  • create stub of ALL pages
    • ensure all pages have IDs for relative linking (inefficient, not all pages relatively link to others)
    • ensure page has been created so attachments can be attached in update content step
    • make pages children of root page, requires root page ID
  • update content for ALL pages

Is the two step process of createStub/updateContent desirable?

On the horizon, some additional concepts to consider:

  • proper page dependency management
    • child pages dependent on root page
    • sibling pages dependent on each other if linked
    • page must exist in order to attach attachments
    • come up with proper order of publishing source files
  • page hierarchies
    • allow pages to be children of other pages, not just the root page
  • page permissions
    • set permissions on a page

With this in mind, a fundamental publishing process should be defined.

mitchell-then avatar Jan 04 '19 19:01 mitchell-then