From 16cfffca4dd3ba3d710f457a97b32d00b7000a7a Mon Sep 17 00:00:00 2001 From: "Dennis E. Hamilton" Date: Thu, 17 Aug 2023 08:43:42 -0700 Subject: [PATCH] 0.0.0 index.md Initial Synopsis and placeholder for docs\preservation Need to figure out the recursiveness of all this. --- docs/preservation/index.md | 74 ++++++++++++++++++++++++++++++ docs/preservation/preservation.txt | 43 +++++++++++++---- 2 files changed, 109 insertions(+), 8 deletions(-) create mode 100644 docs/preservation/index.md diff --git a/docs/preservation/index.md b/docs/preservation/index.md new file mode 100644 index 0000000..f087d5e --- /dev/null +++ b/docs/preservation/index.md @@ -0,0 +1,74 @@ + + +# ***docEng** [Preservation Notebook](.)* + +| ***[docEng](../)*** | [preservation](.) | ***[index.html](index.html) 0.0.0 2023-08-17*** | +| :-- | :-: | --: | +| ![docEng](../images/DocEng-2022-10-14-0751-LogoSmall.png) | [Work in Progress](preservation.txt) | ![Hard Hat Area](../images/hardhat-logo.gif) | + +Depending on the purpose for a Document Engineering activity, an important +element is how materials will be preserved and even memorialized in the face +of future contingencies. + +* What arrangements are made to endure changes in +technology and participation of contributors? + +* What provisions protect against +loss of the authored materials and their presentation in the face of altered +relationships and breakdowns in services and products? + +* What allows for +repurposing of materials and transformation to new purposes and development +regimes? + +There is no magic bullet to ensure successful answers to these questions. +However, there is enough material in the orbit of the docEng project to +provide case studies and practical demonstrations. + +The fundamental requirement for a preservable document-engineering result is +anticipation and practical commitment. There needs to be consistency and +avenues to recovery/transposition of created works for their endurance and +even active continuation. In the absence of attention to preservation, +document-engineering projects will be subject to +short-attention-span theatre and accompanying bit rot. + +The use of GitHub and GitHub Pages is an opportunity for preservation, +considering the expected longevity of Git and of the immense GitHub operation. +How one obtains a preservable web presence to authoring/documentation +projects is a matter to be addressed in the context of docEng on GitHub. + +It is also the case that GitHub and GitHub Pages are being used **for** +preservation of materials originally created elsewhere and that are amenable +to preservation/forking/continuation here. That is already happening in the +[nfoTools](https://orcmid.github.io/nfoTools) and +[Miser Project](https://orcmid.github.io/miser) efforts using GitHub project +repositories. + +## Preservation Catalog + +***Everything is work-in-progress at this stage of docEng development in the +open.*** + +*More to Come. Real-soon-now.* + +---- + +Discussion about docEng is welcome at the +[Discussion section](https://github.com/orcmid/docEng/discussions). +Improvements and removal of defects in this particular documentation can be +reported and addressed in the +[Issues section](https://github.com/orcmid/docEng/issues). There are also +relevant [projects](https://github.com/orcmid/docEng/projects?type=classic) +from time to time. + + diff --git a/docs/preservation/preservation.txt b/docs/preservation/preservation.txt index 96ad7b9..8ede1a5 100644 --- a/docs/preservation/preservation.txt +++ b/docs/preservation/preservation.txt @@ -1,4 +1,4 @@ -preservation.txt 0.0.0 UTF-8 2023-08-17 +preservation.txt 0.0.1 UTF-8 2023-08-17 *---|----1----|----2----|----3----|----4----|----5----|----6----|----7----|--* nfoWare/nfoWorks docEng @@ -6,7 +6,7 @@ preservation.txt 0.0.0 UTF-8 2023-08-17 - DOCENG SITE/DOCUMENT PRESERVATION ACTIVITY + DOCENG SITE/DOCUMENT PRESERVATION NOTEBOOK ------------------------------------------ Documentation of preservation activities is housed here. A major @@ -19,6 +19,10 @@ MANIFEST preservation.txt this manifest and job-jar file + index.md + the authored form published as index.html, the front porch + of the preservation notebook web presence. + *---|----1----|----2----|----3----|----4----|----5----|----6----|----7----|--* @@ -41,25 +45,48 @@ preservation.txt ATTRIBUTION Hamilton, Dennis E. docEng Site/Document Preservation Activity. Text file - preservation.txt version 0.0.0 dated 2023-08-17 available on the Internet + preservation.txt version 0.0.1 dated 2023-08-17 available on the Internet at . TODO - * Create a folder of the style employed for nfoTools that identifies a - variety of preservation activities. - * First address preservation of a site maintained with the site-server model as a GitHub pages transposition. - * Rescuing and retargeting web sites is also a thing. I am doing that with the Site Builder scheme for nfoCentrale, exfiltrating wingnut, Orcmid's Lair, Miser, and nfoCentrale at least, along with nfo stuff. + * Use the nfoTools default GitHub markdown treatment for folio structures, + then consider an alternative authoring that involves direct HTML creation + (e.g., via FrontPage) and then via a Markdown authored alternative. This + is about the preservability of the docEng documentation itself, and the + means of transposition through various "framework" efforts. + + * Consider preservation of the nfoCentral common construction/ materials + as a seed construction/ for docEng. This gets a bit too recursive and + I have to figure out where to pinch things off. + + * The scaffolding model goes back to the Software Engineering team project + when I was studying for an M.Sc in Information Technology through an + on-line program conducted by the University of Liverpool. + + * I need to preserve my "What's an Orcmid" page and the related one on the + M.Sc in IT effort. I need to also add something on how much the courses + reminded me of how much I had already learned and absorbed over the course + of my career in software development. + + * I need to update my LinkedIn profile to be retired. I need to preserve it + somewhere too. It is not so much docEng as github.com/orcmid. Maybe that + will be https://orcmid.github.io with no subfolder. Check it out. There + is a page there. I need to see how that works, including remembering how + I created it. + *---|----1----|----2----|----3----|----4----|----5----|----6----|----7----|--* - 0.0.0 2023-08-27T02:56Z Initial placeholder and TODOs from 0.0.6 docs.txt + + 0.0.1 2023-08-17T15:42Z Expanded TODOs and inclusion of index.md + 0.0.0 2023-08-17T02:56Z Initial placeholder and TODOs from 0.0.6 docs.txt boilerplate ***** end of preservation.txt *****