Difference between revisions of "Dev: Development home"

From Memento Database Wiki
Jump to: navigation, search
(Created page with "This is the home page for shared development of the Memento Wiki. It contains links for launching into development areas (the "Index"), info for developers, etc. = ''Index''...")
 
m
 
(32 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
This is the home page for shared development of the Memento Wiki. It contains links for launching into development areas (the "Index"), info for developers, etc.
 
This is the home page for shared development of the Memento Wiki. It contains links for launching into development areas (the "Index"), info for developers, etc.
 +
<br/>
 +
= ''Work Migration Index'' =
 +
Work goes through these phases:
 +
* ''Drafts'' - Not really a phase. Drafts of new wiki pages may be created in any way. Nothing is tracked. When they are ready to be tested, they will be entered into Authoring.
 +
* '''[[Dev: Authoring|The Authoring phase]]''' - Each author has their own workspace to work on pages from either Drafts or Production and are submitted for Review from here.
 +
* '''[[Dev: Review|The Review phase]]''' - Pages & resources submitted by authors will be reviewed by the admin team in the Review phase. Once the team approves of the page & its resources, it will be moved into the Staging phase.
  
= ''Index'' =
+
* '''''Regarding the remaining phases,<small>''''' how they operate depends on the number of admins that are tending to the wiki.
 +
**If there is only one admin, that admin should update the wiki very carefully, preserving master copies of the new & updated pages & resources and making all updates in one action or at least very quickly, so the wiki never appears inconsistent to readers.
 +
**If two or three admins exist, the procedure to update the wiki with the new or updated pages & resources should be coordinated for the same reason as above, but this can be done informally if there is agreement between them as to steps to be performed.
 +
**If there are more than three admins, the steps mentioned above & detailed below should be formally in place, so that all are coordinated & in agreement as the process takes place.
 +
</small>
 +
* '''[[Dev: Staging|The Staging phase]]''' - In this phase, the admins archive these master copies of wiki pages & resources.
 +
:Then they will prepare them for releasing them to group pages & their resources such that interdependent pages will later be deployed as a unit; the information for this will come mainly from the authors, but maybe also from reviewers. It's not necessary for pages that are not interdependent with other pages to be grouped.
 +
<!--
 +
* '''Deployment''' - This phase is basically scheduling modifications to the wiki, if necessary, and then updating the wiki. As the pages are deployed, the version of each page will be named to correlate then as a release on a date. This phase is also where backups are taken of the changing files. This may not require any action if backups taken by Memento are determined to be adequate to the task of being able to result individual or groups of pages on the event that the wiki's main store is lost or rendered unusable.
 +
* ''Production''- Not a development phase, but the phase or state of being ready for readers to access by being in place in the wiki.
 +
-->
  
This index contains the following sections (Page - Description (Nickname)):
+
{| {{Table1}} Phases of development
 +
! Page !! Nickname !! About
 +
|- {{Row1}}
 +
| style="width:20%;" | [[Dev: Authoring]]
 +
| style="width:10%;" | [[Dev: Authoring|Authoring]]
 +
| style="width:70%;text-align:left;" | The space for development by individual authors
 +
|-
 +
| style="width:20%;" | [[Dev: Review]]
 +
| style="width:10%;" | [[Dev: Review|Review]]
 +
| style="width:70%; text-align:left;" | The space for work submitted by authors to be reviewed for approval by the team
 +
|-
 +
| style="width:20%;" | [[Dev: Staging]]
 +
| style="width:10%;" | [[Dev: Staging|Staging]]
 +
| style="width:70%; text-align:left;" | The space for team-approved work to be staged for deployment to production
 +
|}
  
* [[WikiDev: Development work]] - The space for development by individual authors (Dev)
+
=== Internal links ===
  
* [[Dev: Review]] - The space for work submitted by authors to be reviewed for approval by the team (Review)
+
* [[Dev: Scratchpad 1]] -- Scratchpads for authors
 
+
* [[Dev: Development standards]] -- Standards, guidelines, glossary
* [[Dev: Staging]] - The space for team-approved work to be staged for deployment to production (Staging)
+
* [[Dev: Authoring tips for the Memento wiki]] -- Tips for authors
 
+
* [[Dev: Getting started as a wiki author]] -- Step-by-step guide for beginners
= ''Info for developers/authors'' =
+
* [[Template: Table1]] - Begin a table
 
+
* [[Template: Row1]] - Begin a row
== Tips: Authoring in WikiMedia for the Memento wiki ==
+
* [[Template: Cell1]] - Begin a cell
 
+
:'''''Memento Wiki standards'''''
+
 
+
::;Internal references: The symbol &ordm; is used to refer to another term, phrase, or sentence within the current page. For example:
+
::::'''[[BUG JUST BELOW]]'''
+
::::; A funny term; See the term Xyzzy&ordm;
+
:::::...
+
::::; Xyzzy: A "magic" word from the video game ADVENT that had been popular long ago. It became popular as a nonsense word and is now found all around the Internet especially among the gaming and software development communities, but among other communities as well.
+
 
+
== Page development glossary ==
+
 
+
:'''''Abbreviations & acronyms'''''
+
 
+
::; DevEnv: Development Environment&ordm;
+
::; JS: JavaScript
+
::; MJ: Memento JavaScript
+
::; MJL: The Memento JavaScript Library
+
::; MW: The Memento Wiki
+
 
+
:'''''Terms'''''
+
 
+
::; Development Environment:A set of procedures & tools that work together to help development teams accomplish their joint mission of managing phases&ordm; including development, testing and/or review, acceptance by users (if appropriate), and deployment into a production environment along with the process of migrating&ordm; the software or other items being developed from phase to phase. ''(A sentence from hell, no? No, for one thing, it isn't a sentence.)''
+
 
+
::; Development phase: A phase of the development process
+
 
+
::; Work Migration: The movement of software, Web pages, or other items being developed from one phase to the next
+
  
 
[[Category: Dev]]
 
[[Category: Dev]]

Latest revision as of 20:51, 9 September 2020

This is the home page for shared development of the Memento Wiki. It contains links for launching into development areas (the "Index"), info for developers, etc.

Work Migration Index

Work goes through these phases:

  • Drafts - Not really a phase. Drafts of new wiki pages may be created in any way. Nothing is tracked. When they are ready to be tested, they will be entered into Authoring.
  • The Authoring phase - Each author has their own workspace to work on pages from either Drafts or Production and are submitted for Review from here.
  • The Review phase - Pages & resources submitted by authors will be reviewed by the admin team in the Review phase. Once the team approves of the page & its resources, it will be moved into the Staging phase.
  • Regarding the remaining phases, how they operate depends on the number of admins that are tending to the wiki.
    • If there is only one admin, that admin should update the wiki very carefully, preserving master copies of the new & updated pages & resources and making all updates in one action or at least very quickly, so the wiki never appears inconsistent to readers.
    • If two or three admins exist, the procedure to update the wiki with the new or updated pages & resources should be coordinated for the same reason as above, but this can be done informally if there is agreement between them as to steps to be performed.
    • If there are more than three admins, the steps mentioned above & detailed below should be formally in place, so that all are coordinated & in agreement as the process takes place.

  • The Staging phase - In this phase, the admins archive these master copies of wiki pages & resources.
Then they will prepare them for releasing them to group pages & their resources such that interdependent pages will later be deployed as a unit; the information for this will come mainly from the authors, but maybe also from reviewers. It's not necessary for pages that are not interdependent with other pages to be grouped.
Page Nickname About
Dev: Authoring Authoring The space for development by individual authors
Dev: Review Review The space for work submitted by authors to be reviewed for approval by the team
Dev: Staging Staging The space for team-approved work to be staged for deployment to production

Internal links