From 9c502973b4a03051482573cd9aa800301d402ba7 Mon Sep 17 00:00:00 2001 From: kordwarshuis Date: Wed, 21 Aug 2024 08:54:13 +0000 Subject: [PATCH] deploy: 6ef3281e146221eaaedb73115b98facbc7c1d18e --- 404.html | 2 +- ...3fca0.e887744b.js => 08e3fca0.04208da2.js} | 2 +- assets/js/0e384e19.d4e462f7.js | 1 + assets/js/0e384e19.f97a11a3.js | 1 - assets/js/36846233.3ffff24f.js | 1 + assets/js/36846233.54eff54f.js | 1 - ...5055f.82a871e2.js => 4d95055f.78e2c969.js} | 2 +- assets/js/53ef7a94.33996c6d.js | 1 - assets/js/53ef7a94.dd6100b5.js | 1 + assets/js/c4a0550b.a0067fad.js | 1 - assets/js/c4a0550b.e68848bc.js | 1 + assets/js/dff1e1e9.b389e276.js | 1 + assets/js/dff1e1e9.bf109279.js | 1 - assets/js/e2c9a94b.afd75d60.js | 1 - assets/js/e2c9a94b.ff55a273.js | 1 + assets/js/f049f840.79e434da.js | 1 + assets/js/f049f840.7af0889a.js | 1 - ...n.6eb5d3dc.js => runtime~main.f7818cd5.js} | 2 +- blog/archive/index.html | 2 +- blog/index.html | 2 +- blog/welcome/index.html | 2 +- .../category/content-authors-guide/index.html | 2 +- docs/category/curators-guide/index.html | 4 +- .../glossary-maintainers-guide/index.html | 4 +- docs/category/readers-guide/index.html | 2 +- docs/category/roles/index.html | 4 +- .../terminology-author-guide/index.html | 2 +- docs/glossary/index.html | 2 +- docs/how-it-came-to-be/index.html | 86 +++++++++---------- docs/intro/index.html | 16 ++-- docs/q-and-a/index.html | 2 +- docs/spec-up-t-demo-site/index.html | 2 +- docs/this-site-maintainers/index.html | 2 +- docs/troubleshooting/index.html | 2 +- docs/various-roles/admins-guide/index.html | 59 +++++-------- .../introduction/index.html | 2 +- .../curators-guide/introduction/index.html | 18 ++-- .../various-roles/developers-guide/index.html | 2 +- docs/various-roles/general-guide/index.html | 30 +++---- .../introduction/index.html | 2 +- docs/various-roles/intro/index.html | 8 +- .../readers-guide/introduction/index.html | 2 +- .../technical-skills-needed/index.html | 2 +- .../external-term-references/index.html | 2 +- .../introduction/index.html | 2 +- .../term-references/index.html | 2 +- index.html | 2 +- markdown-page/index.html | 2 +- 48 files changed, 141 insertions(+), 152 deletions(-) rename assets/js/{08e3fca0.e887744b.js => 08e3fca0.04208da2.js} (72%) create mode 100644 assets/js/0e384e19.d4e462f7.js delete mode 100644 assets/js/0e384e19.f97a11a3.js create mode 100644 assets/js/36846233.3ffff24f.js delete mode 100644 assets/js/36846233.54eff54f.js rename assets/js/{4d95055f.82a871e2.js => 4d95055f.78e2c969.js} (58%) delete mode 100644 assets/js/53ef7a94.33996c6d.js create mode 100644 assets/js/53ef7a94.dd6100b5.js delete mode 100644 assets/js/c4a0550b.a0067fad.js create mode 100644 assets/js/c4a0550b.e68848bc.js create mode 100644 assets/js/dff1e1e9.b389e276.js delete mode 100644 assets/js/dff1e1e9.bf109279.js delete mode 100644 assets/js/e2c9a94b.afd75d60.js create mode 100644 assets/js/e2c9a94b.ff55a273.js create mode 100644 assets/js/f049f840.79e434da.js delete mode 100644 assets/js/f049f840.7af0889a.js rename assets/js/{runtime~main.6eb5d3dc.js => runtime~main.f7818cd5.js} (62%) diff --git a/404.html b/404.html index 4a1c4557..cd858ab2 100644 --- a/404.html +++ b/404.html @@ -5,7 +5,7 @@ Page Not Found | Spec-Up-T - + diff --git a/assets/js/08e3fca0.e887744b.js b/assets/js/08e3fca0.04208da2.js similarity index 72% rename from assets/js/08e3fca0.e887744b.js rename to assets/js/08e3fca0.04208da2.js index 494d8396..22404f50 100644 --- a/assets/js/08e3fca0.e887744b.js +++ b/assets/js/08e3fca0.04208da2.js @@ -1 +1 @@ -"use strict";(self.webpackChunkmy_website=self.webpackChunkmy_website||[]).push([[9561],{9477:e=>{e.exports=JSON.parse('{"categoryGeneratedIndex":{"title":"Curators Guide","description":"Curators Guide.","slug":"/category/curators-guide","permalink":"/spec-up-t-website/docs/category/curators-guide","sidebar":"tutorialSidebar","navigation":{"previous":{"title":"External Term References","permalink":"/spec-up-t-website/docs/various-roles/terminology-authors-guide/external-term-references"},"next":{"title":"Curators Guide","permalink":"/spec-up-t-website/docs/various-roles/curators-guide/introduction"}}}}')}}]); \ No newline at end of file +"use strict";(self.webpackChunkmy_website=self.webpackChunkmy_website||[]).push([[9561],{9477:e=>{e.exports=JSON.parse('{"categoryGeneratedIndex":{"title":"Curators Guide","description":"Curators Guide.","slug":"/category/curators-guide","permalink":"/spec-up-t-website/docs/category/curators-guide","sidebar":"tutorialSidebar","navigation":{"previous":{"title":"External Term References","permalink":"/spec-up-t-website/docs/various-roles/terminology-authors-guide/external-term-references"},"next":{"title":"introduction","permalink":"/spec-up-t-website/docs/various-roles/curators-guide/introduction"}}}}')}}]); \ No newline at end of file diff --git a/assets/js/0e384e19.d4e462f7.js b/assets/js/0e384e19.d4e462f7.js new file mode 100644 index 00000000..dd297ca1 --- /dev/null +++ b/assets/js/0e384e19.d4e462f7.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkmy_website=self.webpackChunkmy_website||[]).push([[3976],{619:(i,t,e)=>{e.r(t),e.d(t,{assets:()=>s,contentTitle:()=>g,default:()=>o,frontMatter:()=>n,metadata:()=>I,toc:()=>c});var M=e(4848),j=e(8453);const n={sidebar_position:1},g="Introduction",I={id:"intro",title:"Introduction",description:"Intro",source:"@site/docs/intro.md",sourceDirName:".",slug:"/intro",permalink:"/spec-up-t-website/docs/intro",draft:!1,unlisted:!1,editUrl:"https://github.com/blockchainbird/spec-up-t-website/tree/main/docs/intro.md",tags:[],version:"current",sidebarPosition:1,frontMatter:{sidebar_position:1},sidebar:"tutorialSidebar",next:{title:"Roles",permalink:"/spec-up-t-website/docs/category/roles"}},s={},c=[{value:"Intro",id:"intro",level:2},{value:"History",id:"history",level:2},{value:"Spec-Up-T",id:"spec-up-t",level:2}];function u(i){const t={a:"a",admonition:"admonition",code:"code",em:"em",h1:"h1",h2:"h2",img:"img",li:"li",ol:"ol",p:"p",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,j.R)(),...i.components};return(0,M.jsxs)(M.Fragment,{children:[(0,M.jsx)(t.h1,{id:"introduction",children:"Introduction"}),"\n",(0,M.jsx)(t.h2,{id:"intro",children:"Intro"}),"\n",(0,M.jsxs)(t.p,{children:[(0,M.jsx)(t.em,{children:"Spec-Up-T"})," is a tool that helps you write specifications. It is a tool for writing in Markdown and creates ",(0,M.jsx)(t.em,{children:"one"})," ",(0,M.jsx)(t.code,{children:"index.html"})," file."]}),"\n",(0,M.jsx)(t.p,{children:(0,M.jsxs)(t.strong,{children:["This ",(0,M.jsx)(t.code,{children:"index.html"})," file is the actual specification file that is the goal of it all."]})}),"\n",(0,M.jsxs)(t.p,{children:["This ",(0,M.jsx)(t.code,{children:"index.html"})," file is stand-alone and can be hosted on any web server. Or double-click it, and it will open.\nThe code is available ",(0,M.jsx)(t.a,{href:"https://github.com/blockchainbird/spec-up-t",children:"on Github"}),"."]}),"\n",(0,M.jsxs)(t.p,{children:[(0,M.jsx)(t.strong,{children:"Spec-Up-T"})," is based on ",(0,M.jsx)(t.strong,{children:"Spec-Up"}),", and some of the content on this website is taken from the ",(0,M.jsx)(t.a,{href:"https://identity.foundation/spec-up/",children:"Spec-Up website"}),"."]}),"\n",(0,M.jsx)(t.admonition,{type:"tip",children:(0,M.jsxs)(t.p,{children:["You will have to install Spec-Up-T to start using it. Go straight to the ",(0,M.jsx)(t.a,{href:"/spec-up-t-website/docs/various-roles/admins-guide",children:"admin section"})," for instructions."]})}),"\n",(0,M.jsx)(t.h2,{id:"history",children:"History"}),"\n",(0,M.jsxs)(t.p,{children:["Spec-Up-T is based on Spec-Up (",(0,M.jsx)(t.a,{href:"https://github.com/decentralized-identity/spec-up",children:"Spec-Up on Github"}),")."]}),"\n",(0,M.jsxs)(t.p,{children:["Spec-Up is a tool provided by ",(0,M.jsx)(t.a,{href:"https://github.com/decentralized-identity",children:"DIF"})," (Decentralized Identity Foundation) and created by ",(0,M.jsx)(t.a,{href:"https://github.com/csuwildcat",children:"Daniel Buchner"}),"."]}),"\n",(0,M.jsx)("div",{class:"image-medium center",children:(0,M.jsx)(t.p,{children:(0,M.jsx)(t.img,{alt:"Logo ToIP and DIF combined",src:e(1415).A+"",width:"243",height:"108"})})}),"\n",(0,M.jsxs)(t.p,{children:["From the Spec-Up documentation: \u201c",(0,M.jsx)(t.em,{children:"Spec-Up"})," is a technical specification development tool that enables you to create rich specification documents for standards bodies and engineering projects by writing in an extended version of markdown that features all the bells and whistles - for example, advanced syntax highlighting, notice blocks, complex tables, charts, UML diagrams, and more.\u201d"]}),"\n",(0,M.jsxs)(t.table,{children:[(0,M.jsx)(t.thead,{children:(0,M.jsxs)(t.tr,{children:[(0,M.jsx)(t.th,{children:"Spec-Up"}),(0,M.jsx)(t.th,{children:"Spec-Up-T"})]})}),(0,M.jsxs)(t.tbody,{children:[(0,M.jsxs)(t.tr,{children:[(0,M.jsxs)(t.td,{children:[(0,M.jsx)("div",{class:"image-small",children:(0,M.jsx)(t.img,{alt:"DIF Logo",src:e(1833).A+"",width:"320",height:"108"})}),"Decentralized Identity Foundation"]}),(0,M.jsxs)(t.td,{children:[(0,M.jsx)("div",{class:"image-small",children:(0,M.jsx)(t.img,{alt:"ToIP Logo",src:e(8512).A+"",width:"985",height:"406"})}),"Trust over IP"]})]}),(0,M.jsxs)(t.tr,{children:[(0,M.jsx)(t.td,{children:"\u201cTogether we're building a new identity ecosystem\u201d"}),(0,M.jsx)(t.td,{children:"\u201cDeveloping a complete architecture for Internet Digital Trust. And a better Internet for everyone.\u201d"})]}),(0,M.jsxs)(t.tr,{children:[(0,M.jsx)(t.td,{children:(0,M.jsx)(t.a,{href:"https://github.com/decentralized-identity/spec-up",children:"Spec-Up on Github"})}),(0,M.jsx)(t.td,{children:(0,M.jsx)(t.a,{href:"https://github.com/blockchainbird/spec-up-t",children:"Spec-Up-T on Github"})})]}),(0,M.jsxs)(t.tr,{children:[(0,M.jsx)(t.td,{children:(0,M.jsx)(t.a,{href:"https://identity.foundation/",children:"DIF website"})}),(0,M.jsx)(t.td,{children:(0,M.jsx)(t.a,{href:"https://trustoverip.org/",children:"ToIP website"})})]})]})]}),"\n",(0,M.jsxs)(t.p,{children:[(0,M.jsx)(t.em,{children:"Spec-Up-T"})," is an expansion of ",(0,M.jsx)(t.a,{href:"https://github.com/decentralized-identity/spec-up",children:"DIF's Spec-Up"})," specifically for the needs of the Trust-over-IP foundation. Read more in the elaborate motivation in this technical article: ",(0,M.jsx)(t.a,{href:"/spec-up-t-website/docs/how-it-came-to-be",children:"How it came to be"}),"."]}),"\n",(0,M.jsx)(t.h2,{id:"spec-up-t",children:"Spec-Up-T"}),"\n",(0,M.jsx)(t.p,{children:"Spec-Up-T stays in sync with Spec-Up and currently adds the following extra functionality:"}),"\n",(0,M.jsxs)(t.ol,{children:["\n",(0,M.jsx)(t.li,{children:"Search & Find (not the same as the browser search)"}),"\n",(0,M.jsxs)(t.li,{children:["Splitter for Terms and Definition section following the ",(0,M.jsx)(t.a,{href:"https://trustoverip.github.io/ctwg-terminology-governance-guide/",children:"Termininology Governance Guide"})," and various meeting reports since ",(0,M.jsx)(t.a,{href:"https://wiki.trustoverip.org/display/HOME/2024-04-22+CTWG+Meeting+Notes",children:"CTWG April 2024"})]}),"\n",(0,M.jsx)(t.li,{children:"External Reference (xref) functionality (To Do: add link)"}),"\n",(0,M.jsx)(t.li,{children:"Small User Interface enhancements (back-to-top button, automatic copying of urls when clicking on anchors (\u201c$\u201d), menu-item highlighting)"}),"\n"]}),"\n",(0,M.jsxs)(t.p,{children:[(0,M.jsx)(t.em,{children:"Spec-Up"})," and ",(0,M.jsx)(t.em,{children:"Spec-Up-T"})," work on ",(0,M.jsx)(t.em,{children:"Github"}),". The specification is stored in a Github repo. Editing can be done locally in a suitable editor (Visual Studio Code is widely used), or can be done web-based via the editor provided by Github if you are logged in."]}),"\n",(0,M.jsxs)(t.p,{children:[(0,M.jsx)(t.em,{children:(0,M.jsx)(t.a,{href:"glossary#github-actions",children:"Github Actions"})})," is a convenient way to automate things within Github by creating ",(0,M.jsx)(t.em,{children:"workflows"}),". For example, you can create a workflow that generates an updated version of the specification."]})]})}function o(i={}){const{wrapper:t}={...(0,j.R)(),...i.components};return t?(0,M.jsx)(t,{...i,children:(0,M.jsx)(u,{...i})}):u(i)}},1833:(i,t,e)=>{e.d(t,{A:()=>M});const M=e.p+"assets/images/logo-dif-ffce17bbeaba42a53d74faba6badd3ac.svg"},8512:(i,t,e)=>{e.d(t,{A:()=>M});const M="data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHhtbDpzcGFjZT0icHJlc2VydmUiIGlkPSJMYXllcl8xIiB4PSIwIiB5PSIwIgogICAgc3R5bGU9ImVuYWJsZS1iYWNrZ3JvdW5kOm5ldyAwIDAgOTg0LjcgNDA1LjYiIHZlcnNpb249IjEuMSIgdmlld0JveD0iMCAwIDk4NC43IDQwNS42Ij4KICAgIDxzdHlsZT4KICAgICAgICAuc3QwIHsKICAgICAgICAgICAgZmlsbDogIzMwNDk5ZgogICAgICAgIH0KCiAgICAgICAgLnN0MSB7CiAgICAgICAgICAgIGZpbGw6ICNhOWRkZTAKICAgICAgICB9CgogICAgICAgIC5zdDIgewogICAgICAgICAgICBmaWxsOiAjMjU4OWNhCiAgICAgICAgfQoKICAgICAgICAuc3QzIHsKICAgICAgICAgICAgZmlsbDogIzM2NTNhNAogICAgICAgIH0KICAgIDwvc3R5bGU+CiAgICA8cGF0aAogICAgICAgIGQ9Ik01NDEuNSAxNDkuOUg1MTZ2LTgwaC0zNC41VjQ3LjFINTc2djIyLjhoLTM0LjV6TTYyMi41IDEyMC40aC0xMC43djI5LjVoLTI1LjRWNDcuMWMxMC42LS40IDI3LjItLjkgNDEuMy0uOSAyNi42IDAgNDMuMiAxMi43IDQzLjIgMzYuNiAwIDEzLjgtNi42IDI0LjgtMTcuOCAzMS4xbDI0LjYgMzZoLTMwLjJsLTE4LjktMjkuNWgtNi4xem01LjYtMjEuNWMxMC40IDAgMTcuNC02LjUgMTcuNC0xNS45IDAtMTAuMy03LTE1LTE4LjQtMTUtNC43IDAtMTAuMS4yLTE1LjMuMnYzMC43aDE2LjN6TTc4MS43IDEwMy41YzAgMzAuNS0xOC42IDQ4LjctNDguMiA0OC43LTI5LjUgMC00Ny45LTE4LjEtNDcuOS00OC43VjQ3LjFoMjUuN3Y1Ni40YzAgMTUuNyA4LjYgMjQuOCAyMi4yIDI0LjhzMjIuNS05LjEgMjIuNS0yNC44VjQ3LjFoMjUuN3Y1Ni40ek04NzUuNyA3NC42Yy0xNC40LTQuNC0yNy4yLTYuOC0zNi02LjgtOC45IDAtMTQuNCAyLjctMTQuNCA5LjEgMCA2LjkgOC4zIDguMiAyMi44IDExLjIgMjEuMiA0LjUgMzUuMiAxMS4yIDM1LjIgMzEgMCAyMS45LTE3LjEgMzMuMS00Mi45IDMzLjEtMTMuMiAwLTI5LjgtMi45LTQ1LjgtOC45bDUuNy0yMi41YzE2LjUgNi4yIDI5LjkgOC42IDM5IDguOCAxMC45LjIgMTYuNi0yLjkgMTYuNi04LjggMC04LjMtMTEuNi05LjctMjQuNi0xMi40LTIzLTQuOC0zMy43LTEyLjItMzMuNy0zMC4yIDAtMjAuMyAxNi4yLTMyLjUgNDEuOS0zMi41IDE0LjIgMCAzMC44IDMuMiA0MS42IDdsLTUuNCAyMS45ek05NDkuMyAxNDkuOWgtMjUuNnYtODBoLTM0LjRWNDcuMWg5NC40djIyLjhoLTM0LjR6TTU4OC42IDIzNC43YzAgMzIuMi0yMi4xIDUzLjctNTQuMSA1My43cy01NC0yMS41LTU0LTUzLjcgMjEuOS01My43IDU0LTUzLjdjMzIgMCA1NC4xIDIxLjUgNTQuMSA1My43bS0xMS4yIDBjMC0yNi4xLTE3LjUtNDMuNS00Mi45LTQzLjUtMjUuMiAwLTQyLjggMTcuNC00Mi44IDQzLjVzMTcuNSA0My43IDQyLjggNDMuN2MyNS40IDAgNDIuOS0xNy42IDQyLjktNDMuN002MzIuNiAyODYuMWwtMzIuNy02OS45aDExLjVsMjYuOCA1Ny44IDI2LjYtNTcuOGgxMS4zbC0zMi41IDY5Ljl6TTc1MC45IDI0Ny4xYzAgMy41LS4yIDQuNy0uNiA4aC01OC4yYzEuNyAxNC40IDExLjYgMjMuOSAyNy4xIDIzLjkgOC45IDAgMTYuMi0xLjUgMjUuNy0zLjlsMS43IDguNWMtOS4xIDIuNy0xNi45IDQuOC0yNy43IDQuOC0yMy45IDAtMzcuOC0xNS42LTM3LjgtMzcuMyAwLTIyLjQgMTUuMS0zNyAzNi4zLTM3IDE5LjYtLjEgMzMuNCAxMi42IDMzLjUgMzNtLTU5LjEtLjJoNDkuNmMtLjItMTUuMy05LjctMjQuNS0yMy43LTI0LjUtMTUgMC0yNC43IDkuNy0yNS45IDI0LjVNODA3LjYgMjI0LjdjLTEwLjEgMC0xOC4zLjMtMjguNiAxLjV2NTkuOWgtMTAuNHYtNjcuOWMxMi43LTIuMyAyNS44LTMuNiAzOS0zLjZ2MTAuMXpNODU0LjkgMTgzLjNoMjUuNXYxMDIuOGgtMjUuNXpNOTg0LjcgMjIwYzAgMjMuNC0xNy41IDM4LjItNDQuNyAzOC4yaC0xNC4yVjI4NmgtMjUuNFYxODMuM2MxMi4xLS42IDI1LjUtMS4yIDM5LjYtMS4yIDI3LjIgMCA0NC43IDEzLjkgNDQuNyAzNy45bS00My4yIDE2YzEwLjQgMCAxNy44LTUuOSAxNy44LTE1LjkgMC0xMC4zLTcuNC0xNS45LTE3LjgtMTUuOS01LjMgMC0xMC42LjItMTUuNy4zVjIzNmgxNS43ek01MTUuMSAzNDAuN3YxMS42aC0yMS42djE3LjRoLTEyLjd2LTUxLjRoMzcuN3YxMS4zaC0yNXYxMS4xek01NzcuOSAzNDRjMCAxNi4xLTExLjMgMjYuOC0yNy42IDI2LjhzLTI3LjYtMTAuNy0yNy42LTI2LjggMTEuMy0yNi44IDI3LjYtMjYuOGMxNi4yIDAgMjcuNiAxMC43IDI3LjYgMjYuOG0tMTMuMiAwYzAtOS4xLTYtMTUtMTQuNC0xNXMtMTQuNCA2LTE0LjQgMTVjMCA5LjEgNiAxNS4xIDE0LjQgMTUuMXMxNC40LTYgMTQuNC0xNS4xTTYzMyAzNDYuNWMwIDE1LjMtOS4zIDI0LjMtMjQuMSAyNC4zLTE0LjcgMC0yNC05LjEtMjQtMjQuM3YtMjguMmgxMi44djI4LjJjMCA3LjkgNC4zIDEyLjQgMTEuMSAxMi40czExLjMtNC41IDExLjMtMTIuNHYtMjguMkg2MzN2MjguMnpNNjkwIDM2OS43aC0xMS42bC0yMy45LTI5Ljh2MjkuOGgtMTIuN3YtNTEuNGgxMS43bDIzLjggMzAuMXYtMzAuMUg2OTB6TTc0Ny4yIDM0My45YzAgMTYuMi0xMS4zIDI2LjQtMjYuNyAyNi40LTcuNiAwLTE0LjgtLjMtMjAuNC0uNnYtNTEuNGM1LjYtLjMgMTItLjYgMTkuMS0uNiAxNi43IDAgMjggMTAuMSAyOCAyNi4ybS0xMy4xIDBjMC05LTUuOS0xNC43LTE0LjMtMTQuNy0yLjIgMC00LjYgMC03IC4ydjI5LjVjMi42LjIgNS40LjIgOCAuMiA3LjQtLjIgMTMuMy02LjEgMTMuMy0xNS4yTTc2MS42IDM2OS43aC0xMy45bDIyLjktNTEuN2gxMS45bDIyLjggNTEuN2gtMTMuOGwtMy42LTguNWgtMjIuOGwtMy41IDguNXptNy45LTE5LjNoMTQuMWwtNy4xLTE3LjItNyAxNy4yek04MzAuNCAzNjkuN2gtMTIuOHYtNDBoLTE3LjJ2LTExLjRoNDcuMnYxMS40aC0xNy4yek04NTIuNyAzMTguM2gxMi44djUxLjRoLTEyLjh6TTkyOC40IDM0NGMwIDE2LjEtMTEuMyAyNi44LTI3LjYgMjYuOHMtMjcuNi0xMC43LTI3LjYtMjYuOCAxMS4zLTI2LjggMjcuNi0yNi44IDI3LjYgMTAuNyAyNy42IDI2LjhtLTEzLjEgMGMwLTkuMS02LTE1LTE0LjQtMTVzLTE0LjQgNi0xNC40IDE1YzAgOS4xIDYgMTUuMSAxNC40IDE1LjEgOC4zIDAgMTQuNC02IDE0LjQtMTUuMU05ODQuNSAzNjkuN2gtMTEuN0w5NDkgMzM5Ljl2MjkuOGgtMTIuN3YtNTEuNEg5NDhsMjMuOCAzMC4xdi0zMC4xaDEyLjd6IgogICAgICAgIGNsYXNzPSJzdDAiIC8+CiAgICA8cGF0aAogICAgICAgIGQ9Ik0yNzIgMTAuM2MxMy42LTcuOCAyNS45LTguNSAzNC43LTMuMWw5OC42IDU3LjRjLjIuMS4zLjIuNS4zLTguOC01LjItMjEuMS00LjYtMzQuNiAzLjJsLTE3NyAxMDEuOEwyMC41IDY4LjhjLTI3LjMtMTUuOC0yNy4zLTQxLjMgMC01N0M0Ny44LTQgOTItMy45IDExOS4zIDExLjhsNzUuNiA0My4xTDI3MiAxMC4zIgogICAgICAgIGNsYXNzPSJzdDEiIC8+CiAgICA8cGF0aAogICAgICAgIGQ9Ik05OS41IDU3LjRjLTE2LjQgOS40LTQyLjkgOS40LTU5LjMgMC0xNi40LTkuNS0xNi40LTI0LjggMC0zNC4yIDE2LjQtOS40IDQyLjktOS40IDU5LjMgMCAxNi40IDkuNSAxNi40IDI0LjggMCAzNC4yIgogICAgICAgIGNsYXNzPSJzdDIiIC8+CiAgICA8cGF0aAogICAgICAgIGQ9Ik0yOTUuMiAzMTIuMWMwIDE1LjgtNS41IDI3LTE0LjMgMzIuMmwtMTAwLjggNTcuOXMtLjEgMC0uMS4xYzguOC01LjMgMTQuMy0xNi40IDE0LjMtMzIuMlYxNjkuOWwxNzctMTAxLjhjMjctMTUuNiA0OC45LTIuNiA0OC45IDI5cy0yMS45IDY5LjktNDguOSA4NS41bC03Ni4xIDQzLjl2ODUuNnoiCiAgICAgICAgY2xhc3M9InN0MyIgLz4KICAgIDxwYXRoCiAgICAgICAgZD0iTTM0MS45IDE0Mi4zYzAgMTkgMTMuMSAyNi44IDI5LjMgMTcuNCAxNi4yLTkuNCAyOS4zLTMyLjMgMjkuMy01MS4zUzM4Ny40IDgxLjYgMzcxLjIgOTFjLTE2LjEgOS4zLTI5LjMgMzIuMy0yOS4zIDUxLjMiCiAgICAgICAgY2xhc3M9InN0MSIgLz4KICAgIDxwYXRoCiAgICAgICAgZD0iTTk2LjUgMzEzLjVjMCAzMS42IDIxLjkgNjkuOSA0OC45IDg1LjUgMjcgMTUuNiA0OC45IDIuNiA0OC45LTI5VjE2OS45TDIwLjUgNjguOEM2LjggNjEgMCA1MC42IDAgNDAuM1YxNTZjMCAxMC4zIDYuOCAyMC42IDIwLjUgMjguNWw3NiA0My44djg1LjJ6IgogICAgICAgIGNsYXNzPSJzdDIiIC8+CiAgICA8cGF0aAogICAgICAgIGQ9Ik0xNzQuNyAzNTguN2MwIDE5LTEzLjEgMjYuOC0yOS4zIDE3LjQtMTYuMi05LjQtMjkuMy0zMi4zLTI5LjMtNTEuM3MxMy4xLTI2LjggMjkuMy0xNy40YzE2LjIgOS4zIDI5LjMgMzIuMyAyOS4zIDUxLjMiCiAgICAgICAgY2xhc3M9InN0MyIgLz4KPC9zdmc+"},1415:(i,t,e)=>{e.d(t,{A:()=>M});const M=e.p+"assets/images/logo-3285df06c3ca44eedd8668ae78c78be3.svg"},8453:(i,t,e)=>{e.d(t,{R:()=>g,x:()=>I});var M=e(6540);const j={},n=M.createContext(j);function g(i){const t=M.useContext(n);return M.useMemo((function(){return"function"==typeof i?i(t):{...t,...i}}),[t,i])}function I(i){let t;return t=i.disableParentContext?"function"==typeof i.components?i.components(j):i.components||j:g(i.components),M.createElement(n.Provider,{value:t},i.children)}}}]); \ No newline at end of file diff --git a/assets/js/0e384e19.f97a11a3.js b/assets/js/0e384e19.f97a11a3.js deleted file mode 100644 index e4fdaec6..00000000 --- a/assets/js/0e384e19.f97a11a3.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkmy_website=self.webpackChunkmy_website||[]).push([[3976],{619:(i,t,e)=>{e.r(t),e.d(t,{assets:()=>s,contentTitle:()=>g,default:()=>o,frontMatter:()=>n,metadata:()=>I,toc:()=>c});var M=e(4848),j=e(8453);const n={sidebar_position:1},g="Introduction",I={id:"intro",title:"Introduction",description:"Intro",source:"@site/docs/intro.md",sourceDirName:".",slug:"/intro",permalink:"/spec-up-t-website/docs/intro",draft:!1,unlisted:!1,editUrl:"https://github.com/blockchainbird/spec-up-t-website/tree/main/docs/intro.md",tags:[],version:"current",sidebarPosition:1,frontMatter:{sidebar_position:1},sidebar:"tutorialSidebar",next:{title:"Roles",permalink:"/spec-up-t-website/docs/category/roles"}},s={},c=[{value:"Intro",id:"intro",level:2},{value:"History",id:"history",level:2},{value:"Spec-Up-T",id:"spec-up-t",level:2}];function u(i){const t={a:"a",admonition:"admonition",code:"code",em:"em",h1:"h1",h2:"h2",img:"img",li:"li",ol:"ol",p:"p",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,j.R)(),...i.components};return(0,M.jsxs)(M.Fragment,{children:[(0,M.jsx)(t.h1,{id:"introduction",children:"Introduction"}),"\n",(0,M.jsx)(t.h2,{id:"intro",children:"Intro"}),"\n",(0,M.jsxs)(t.p,{children:[(0,M.jsx)(t.em,{children:"Spec-Up-T"})," is a tool that helps you write specifications. It is a tool for writing in Markdown and creates ",(0,M.jsx)(t.em,{children:"one"})," ",(0,M.jsx)(t.code,{children:"index.html"})," file."]}),"\n",(0,M.jsx)(t.p,{children:(0,M.jsxs)(t.strong,{children:["This ",(0,M.jsx)(t.code,{children:"index.html"})," file is the actual specification file that is the goal of it all."]})}),"\n",(0,M.jsxs)(t.p,{children:["This ",(0,M.jsx)(t.code,{children:"index.html"})," file is stand-alone and can be hosted on any webserver. Or double click it and it will open.\nThe code is available ",(0,M.jsx)(t.a,{href:"https://github.com/blockchainbird/spec-up-t",children:"on Github"}),"."]}),"\n",(0,M.jsxs)(t.p,{children:[(0,M.jsx)(t.strong,{children:"Spec-Up-T"})," is based on ",(0,M.jsx)(t.strong,{children:"Spec-Up"})," and some of the content on this website is taken from the ",(0,M.jsx)(t.a,{href:"https://identity.foundation/spec-up/",children:"Spec-Up website"}),"."]}),"\n",(0,M.jsx)(t.admonition,{type:"tip",children:(0,M.jsxs)(t.p,{children:["In order to start using Spec-Up-T you will have to install it. Go straight to the ",(0,M.jsx)(t.a,{href:"/spec-up-t-website/docs/various-roles/admins-guide",children:"admin section"})," for instructions."]})}),"\n",(0,M.jsx)(t.h2,{id:"history",children:"History"}),"\n",(0,M.jsxs)(t.p,{children:["Spec-Up-T is based on Spec-Up (",(0,M.jsx)(t.a,{href:"https://github.com/decentralized-identity/spec-up",children:"Spec-Up on Github"}),")."]}),"\n",(0,M.jsxs)(t.p,{children:["Spec-Up is a tool provided by ",(0,M.jsx)(t.a,{href:"https://github.com/decentralized-identity",children:"DIF"})," (Decentralized Identity Foundation) and created by ",(0,M.jsx)(t.a,{href:"https://github.com/csuwildcat",children:"Daniel Buchner"}),"."]}),"\n",(0,M.jsx)("div",{class:"image-medium center",children:(0,M.jsx)(t.p,{children:(0,M.jsx)(t.img,{alt:"Logo ToIP and DIF combined",src:e(1415).A+"",width:"243",height:"108"})})}),"\n",(0,M.jsxs)(t.p,{children:["From the Spec-Up documentation: \u201c",(0,M.jsx)(t.em,{children:"Spec-Up"})," is a technical specification development tool that enables you to create rich specification documents for standards bodies and engineering projects by writing in an extended version of markdown that features all the bells and whistles - for example: advanced syntax highlighting, notice blocks, complex tables, charts, UML diagrams, and more.\u201d"]}),"\n",(0,M.jsxs)(t.table,{children:[(0,M.jsx)(t.thead,{children:(0,M.jsxs)(t.tr,{children:[(0,M.jsx)(t.th,{children:"Spec-Up"}),(0,M.jsx)(t.th,{children:"Spec-Up-T"})]})}),(0,M.jsxs)(t.tbody,{children:[(0,M.jsxs)(t.tr,{children:[(0,M.jsxs)(t.td,{children:[(0,M.jsx)("div",{class:"image-small",children:(0,M.jsx)(t.img,{alt:"DIF Logo",src:e(1833).A+"",width:"320",height:"108"})}),"Decentralized Identity Foundation"]}),(0,M.jsxs)(t.td,{children:[(0,M.jsx)("div",{class:"image-small",children:(0,M.jsx)(t.img,{alt:"ToIP Logo",src:e(8512).A+"",width:"985",height:"406"})}),"Trust over IP"]})]}),(0,M.jsxs)(t.tr,{children:[(0,M.jsx)(t.td,{children:"\u201cTogether we're building a new identity ecosystem\u201d"}),(0,M.jsx)(t.td,{children:"\u201cDeveloping a complete architecture for Internet Digital Trust. And a better Internet for everyone.\u201d"})]}),(0,M.jsxs)(t.tr,{children:[(0,M.jsx)(t.td,{children:(0,M.jsx)(t.a,{href:"https://github.com/decentralized-identity/spec-up",children:"Spec-Up on Github"})}),(0,M.jsx)(t.td,{children:(0,M.jsx)(t.a,{href:"https://github.com/blockchainbird/spec-up-t",children:"Spec-Up-T on Github"})})]}),(0,M.jsxs)(t.tr,{children:[(0,M.jsx)(t.td,{children:(0,M.jsx)(t.a,{href:"https://identity.foundation/",children:"DIF website"})}),(0,M.jsx)(t.td,{children:(0,M.jsx)(t.a,{href:"https://trustoverip.org/",children:"ToIP website"})})]})]})]}),"\n",(0,M.jsxs)(t.p,{children:[(0,M.jsx)(t.em,{children:"Spec-Up-T"})," is an expansion of ",(0,M.jsx)(t.a,{href:"https://github.com/decentralized-identity/spec-up",children:"DIF's Spec-Up"})," specifically for the needs of the Trust-over-IP foundation. Read more in the elaborate motivation in this technical article: ",(0,M.jsx)(t.a,{href:"/spec-up-t-website/docs/how-it-came-to-be",children:"How it came to be"}),"."]}),"\n",(0,M.jsx)(t.h2,{id:"spec-up-t",children:"Spec-Up-T"}),"\n",(0,M.jsx)(t.p,{children:"Spec-Up-T stays in sync with Spec-Up, and currently adds the following extra functionality:"}),"\n",(0,M.jsxs)(t.ol,{children:["\n",(0,M.jsx)(t.li,{children:"Search & Find (not the same as the browser search)"}),"\n",(0,M.jsxs)(t.li,{children:["Splitter for Terms and Definition section following the ",(0,M.jsx)(t.a,{href:"https://trustoverip.github.io/ctwg-terminology-governance-guide/",children:"Termininology Governance Guide"})," and various meeting report since ",(0,M.jsx)(t.a,{href:"https://wiki.trustoverip.org/display/HOME/2024-04-22+CTWG+Meeting+Notes",children:"CTWG April 2024"})]}),"\n",(0,M.jsx)(t.li,{children:"External Reference (xref) functionality (To Do: add link)"}),"\n",(0,M.jsx)(t.li,{children:"Small User Interface enhancements (back to top button, automatic copying of urls when clicking on anchors (\u201c$\u201d), menu-item highlighting)"}),"\n"]}),"\n",(0,M.jsxs)(t.p,{children:[(0,M.jsx)(t.em,{children:"Spec-Up"})," and ",(0,M.jsx)(t.em,{children:"Spec-Up-T"})," work on ",(0,M.jsx)(t.em,{children:"Github"}),". The specification is stored in a Github repo. Editing can be done locally in a suitable editor (Visual Studio Code is widely used), or can be done web-based via the editor provided by Github if you are logged in."]}),"\n",(0,M.jsxs)(t.p,{children:[(0,M.jsx)(t.em,{children:(0,M.jsx)(t.a,{href:"glossary#github-actions",children:"Github Actions"})})," is a convenient way to automate things within Github by creating ",(0,M.jsx)(t.em,{children:"workflows"}),". For example, you can create a workflow that generates an updated version of the specification."]})]})}function o(i={}){const{wrapper:t}={...(0,j.R)(),...i.components};return t?(0,M.jsx)(t,{...i,children:(0,M.jsx)(u,{...i})}):u(i)}},1833:(i,t,e)=>{e.d(t,{A:()=>M});const M=e.p+"assets/images/logo-dif-ffce17bbeaba42a53d74faba6badd3ac.svg"},8512:(i,t,e)=>{e.d(t,{A:()=>M});const M="data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHhtbDpzcGFjZT0icHJlc2VydmUiIGlkPSJMYXllcl8xIiB4PSIwIiB5PSIwIgogICAgc3R5bGU9ImVuYWJsZS1iYWNrZ3JvdW5kOm5ldyAwIDAgOTg0LjcgNDA1LjYiIHZlcnNpb249IjEuMSIgdmlld0JveD0iMCAwIDk4NC43IDQwNS42Ij4KICAgIDxzdHlsZT4KICAgICAgICAuc3QwIHsKICAgICAgICAgICAgZmlsbDogIzMwNDk5ZgogICAgICAgIH0KCiAgICAgICAgLnN0MSB7CiAgICAgICAgICAgIGZpbGw6ICNhOWRkZTAKICAgICAgICB9CgogICAgICAgIC5zdDIgewogICAgICAgICAgICBmaWxsOiAjMjU4OWNhCiAgICAgICAgfQoKICAgICAgICAuc3QzIHsKICAgICAgICAgICAgZmlsbDogIzM2NTNhNAogICAgICAgIH0KICAgIDwvc3R5bGU+CiAgICA8cGF0aAogICAgICAgIGQ9Ik01NDEuNSAxNDkuOUg1MTZ2LTgwaC0zNC41VjQ3LjFINTc2djIyLjhoLTM0LjV6TTYyMi41IDEyMC40aC0xMC43djI5LjVoLTI1LjRWNDcuMWMxMC42LS40IDI3LjItLjkgNDEuMy0uOSAyNi42IDAgNDMuMiAxMi43IDQzLjIgMzYuNiAwIDEzLjgtNi42IDI0LjgtMTcuOCAzMS4xbDI0LjYgMzZoLTMwLjJsLTE4LjktMjkuNWgtNi4xem01LjYtMjEuNWMxMC40IDAgMTcuNC02LjUgMTcuNC0xNS45IDAtMTAuMy03LTE1LTE4LjQtMTUtNC43IDAtMTAuMS4yLTE1LjMuMnYzMC43aDE2LjN6TTc4MS43IDEwMy41YzAgMzAuNS0xOC42IDQ4LjctNDguMiA0OC43LTI5LjUgMC00Ny45LTE4LjEtNDcuOS00OC43VjQ3LjFoMjUuN3Y1Ni40YzAgMTUuNyA4LjYgMjQuOCAyMi4yIDI0LjhzMjIuNS05LjEgMjIuNS0yNC44VjQ3LjFoMjUuN3Y1Ni40ek04NzUuNyA3NC42Yy0xNC40LTQuNC0yNy4yLTYuOC0zNi02LjgtOC45IDAtMTQuNCAyLjctMTQuNCA5LjEgMCA2LjkgOC4zIDguMiAyMi44IDExLjIgMjEuMiA0LjUgMzUuMiAxMS4yIDM1LjIgMzEgMCAyMS45LTE3LjEgMzMuMS00Mi45IDMzLjEtMTMuMiAwLTI5LjgtMi45LTQ1LjgtOC45bDUuNy0yMi41YzE2LjUgNi4yIDI5LjkgOC42IDM5IDguOCAxMC45LjIgMTYuNi0yLjkgMTYuNi04LjggMC04LjMtMTEuNi05LjctMjQuNi0xMi40LTIzLTQuOC0zMy43LTEyLjItMzMuNy0zMC4yIDAtMjAuMyAxNi4yLTMyLjUgNDEuOS0zMi41IDE0LjIgMCAzMC44IDMuMiA0MS42IDdsLTUuNCAyMS45ek05NDkuMyAxNDkuOWgtMjUuNnYtODBoLTM0LjRWNDcuMWg5NC40djIyLjhoLTM0LjR6TTU4OC42IDIzNC43YzAgMzIuMi0yMi4xIDUzLjctNTQuMSA1My43cy01NC0yMS41LTU0LTUzLjcgMjEuOS01My43IDU0LTUzLjdjMzIgMCA1NC4xIDIxLjUgNTQuMSA1My43bS0xMS4yIDBjMC0yNi4xLTE3LjUtNDMuNS00Mi45LTQzLjUtMjUuMiAwLTQyLjggMTcuNC00Mi44IDQzLjVzMTcuNSA0My43IDQyLjggNDMuN2MyNS40IDAgNDIuOS0xNy42IDQyLjktNDMuN002MzIuNiAyODYuMWwtMzIuNy02OS45aDExLjVsMjYuOCA1Ny44IDI2LjYtNTcuOGgxMS4zbC0zMi41IDY5Ljl6TTc1MC45IDI0Ny4xYzAgMy41LS4yIDQuNy0uNiA4aC01OC4yYzEuNyAxNC40IDExLjYgMjMuOSAyNy4xIDIzLjkgOC45IDAgMTYuMi0xLjUgMjUuNy0zLjlsMS43IDguNWMtOS4xIDIuNy0xNi45IDQuOC0yNy43IDQuOC0yMy45IDAtMzcuOC0xNS42LTM3LjgtMzcuMyAwLTIyLjQgMTUuMS0zNyAzNi4zLTM3IDE5LjYtLjEgMzMuNCAxMi42IDMzLjUgMzNtLTU5LjEtLjJoNDkuNmMtLjItMTUuMy05LjctMjQuNS0yMy43LTI0LjUtMTUgMC0yNC43IDkuNy0yNS45IDI0LjVNODA3LjYgMjI0LjdjLTEwLjEgMC0xOC4zLjMtMjguNiAxLjV2NTkuOWgtMTAuNHYtNjcuOWMxMi43LTIuMyAyNS44LTMuNiAzOS0zLjZ2MTAuMXpNODU0LjkgMTgzLjNoMjUuNXYxMDIuOGgtMjUuNXpNOTg0LjcgMjIwYzAgMjMuNC0xNy41IDM4LjItNDQuNyAzOC4yaC0xNC4yVjI4NmgtMjUuNFYxODMuM2MxMi4xLS42IDI1LjUtMS4yIDM5LjYtMS4yIDI3LjIgMCA0NC43IDEzLjkgNDQuNyAzNy45bS00My4yIDE2YzEwLjQgMCAxNy44LTUuOSAxNy44LTE1LjkgMC0xMC4zLTcuNC0xNS45LTE3LjgtMTUuOS01LjMgMC0xMC42LjItMTUuNy4zVjIzNmgxNS43ek01MTUuMSAzNDAuN3YxMS42aC0yMS42djE3LjRoLTEyLjd2LTUxLjRoMzcuN3YxMS4zaC0yNXYxMS4xek01NzcuOSAzNDRjMCAxNi4xLTExLjMgMjYuOC0yNy42IDI2LjhzLTI3LjYtMTAuNy0yNy42LTI2LjggMTEuMy0yNi44IDI3LjYtMjYuOGMxNi4yIDAgMjcuNiAxMC43IDI3LjYgMjYuOG0tMTMuMiAwYzAtOS4xLTYtMTUtMTQuNC0xNXMtMTQuNCA2LTE0LjQgMTVjMCA5LjEgNiAxNS4xIDE0LjQgMTUuMXMxNC40LTYgMTQuNC0xNS4xTTYzMyAzNDYuNWMwIDE1LjMtOS4zIDI0LjMtMjQuMSAyNC4zLTE0LjcgMC0yNC05LjEtMjQtMjQuM3YtMjguMmgxMi44djI4LjJjMCA3LjkgNC4zIDEyLjQgMTEuMSAxMi40czExLjMtNC41IDExLjMtMTIuNHYtMjguMkg2MzN2MjguMnpNNjkwIDM2OS43aC0xMS42bC0yMy45LTI5Ljh2MjkuOGgtMTIuN3YtNTEuNGgxMS43bDIzLjggMzAuMXYtMzAuMUg2OTB6TTc0Ny4yIDM0My45YzAgMTYuMi0xMS4zIDI2LjQtMjYuNyAyNi40LTcuNiAwLTE0LjgtLjMtMjAuNC0uNnYtNTEuNGM1LjYtLjMgMTItLjYgMTkuMS0uNiAxNi43IDAgMjggMTAuMSAyOCAyNi4ybS0xMy4xIDBjMC05LTUuOS0xNC43LTE0LjMtMTQuNy0yLjIgMC00LjYgMC03IC4ydjI5LjVjMi42LjIgNS40LjIgOCAuMiA3LjQtLjIgMTMuMy02LjEgMTMuMy0xNS4yTTc2MS42IDM2OS43aC0xMy45bDIyLjktNTEuN2gxMS45bDIyLjggNTEuN2gtMTMuOGwtMy42LTguNWgtMjIuOGwtMy41IDguNXptNy45LTE5LjNoMTQuMWwtNy4xLTE3LjItNyAxNy4yek04MzAuNCAzNjkuN2gtMTIuOHYtNDBoLTE3LjJ2LTExLjRoNDcuMnYxMS40aC0xNy4yek04NTIuNyAzMTguM2gxMi44djUxLjRoLTEyLjh6TTkyOC40IDM0NGMwIDE2LjEtMTEuMyAyNi44LTI3LjYgMjYuOHMtMjcuNi0xMC43LTI3LjYtMjYuOCAxMS4zLTI2LjggMjcuNi0yNi44IDI3LjYgMTAuNyAyNy42IDI2LjhtLTEzLjEgMGMwLTkuMS02LTE1LTE0LjQtMTVzLTE0LjQgNi0xNC40IDE1YzAgOS4xIDYgMTUuMSAxNC40IDE1LjEgOC4zIDAgMTQuNC02IDE0LjQtMTUuMU05ODQuNSAzNjkuN2gtMTEuN0w5NDkgMzM5Ljl2MjkuOGgtMTIuN3YtNTEuNEg5NDhsMjMuOCAzMC4xdi0zMC4xaDEyLjd6IgogICAgICAgIGNsYXNzPSJzdDAiIC8+CiAgICA8cGF0aAogICAgICAgIGQ9Ik0yNzIgMTAuM2MxMy42LTcuOCAyNS45LTguNSAzNC43LTMuMWw5OC42IDU3LjRjLjIuMS4zLjIuNS4zLTguOC01LjItMjEuMS00LjYtMzQuNiAzLjJsLTE3NyAxMDEuOEwyMC41IDY4LjhjLTI3LjMtMTUuOC0yNy4zLTQxLjMgMC01N0M0Ny44LTQgOTItMy45IDExOS4zIDExLjhsNzUuNiA0My4xTDI3MiAxMC4zIgogICAgICAgIGNsYXNzPSJzdDEiIC8+CiAgICA8cGF0aAogICAgICAgIGQ9Ik05OS41IDU3LjRjLTE2LjQgOS40LTQyLjkgOS40LTU5LjMgMC0xNi40LTkuNS0xNi40LTI0LjggMC0zNC4yIDE2LjQtOS40IDQyLjktOS40IDU5LjMgMCAxNi40IDkuNSAxNi40IDI0LjggMCAzNC4yIgogICAgICAgIGNsYXNzPSJzdDIiIC8+CiAgICA8cGF0aAogICAgICAgIGQ9Ik0yOTUuMiAzMTIuMWMwIDE1LjgtNS41IDI3LTE0LjMgMzIuMmwtMTAwLjggNTcuOXMtLjEgMC0uMS4xYzguOC01LjMgMTQuMy0xNi40IDE0LjMtMzIuMlYxNjkuOWwxNzctMTAxLjhjMjctMTUuNiA0OC45LTIuNiA0OC45IDI5cy0yMS45IDY5LjktNDguOSA4NS41bC03Ni4xIDQzLjl2ODUuNnoiCiAgICAgICAgY2xhc3M9InN0MyIgLz4KICAgIDxwYXRoCiAgICAgICAgZD0iTTM0MS45IDE0Mi4zYzAgMTkgMTMuMSAyNi44IDI5LjMgMTcuNCAxNi4yLTkuNCAyOS4zLTMyLjMgMjkuMy01MS4zUzM4Ny40IDgxLjYgMzcxLjIgOTFjLTE2LjEgOS4zLTI5LjMgMzIuMy0yOS4zIDUxLjMiCiAgICAgICAgY2xhc3M9InN0MSIgLz4KICAgIDxwYXRoCiAgICAgICAgZD0iTTk2LjUgMzEzLjVjMCAzMS42IDIxLjkgNjkuOSA0OC45IDg1LjUgMjcgMTUuNiA0OC45IDIuNiA0OC45LTI5VjE2OS45TDIwLjUgNjguOEM2LjggNjEgMCA1MC42IDAgNDAuM1YxNTZjMCAxMC4zIDYuOCAyMC42IDIwLjUgMjguNWw3NiA0My44djg1LjJ6IgogICAgICAgIGNsYXNzPSJzdDIiIC8+CiAgICA8cGF0aAogICAgICAgIGQ9Ik0xNzQuNyAzNTguN2MwIDE5LTEzLjEgMjYuOC0yOS4zIDE3LjQtMTYuMi05LjQtMjkuMy0zMi4zLTI5LjMtNTEuM3MxMy4xLTI2LjggMjkuMy0xNy40YzE2LjIgOS4zIDI5LjMgMzIuMyAyOS4zIDUxLjMiCiAgICAgICAgY2xhc3M9InN0MyIgLz4KPC9zdmc+"},1415:(i,t,e)=>{e.d(t,{A:()=>M});const M=e.p+"assets/images/logo-3285df06c3ca44eedd8668ae78c78be3.svg"},8453:(i,t,e)=>{e.d(t,{R:()=>g,x:()=>I});var M=e(6540);const j={},n=M.createContext(j);function g(i){const t=M.useContext(n);return M.useMemo((function(){return"function"==typeof i?i(t):{...t,...i}}),[t,i])}function I(i){let t;return t=i.disableParentContext?"function"==typeof i.components?i.components(j):i.components||j:g(i.components),M.createElement(n.Provider,{value:t},i.children)}}}]); \ No newline at end of file diff --git a/assets/js/36846233.3ffff24f.js b/assets/js/36846233.3ffff24f.js new file mode 100644 index 00000000..04db6b45 --- /dev/null +++ b/assets/js/36846233.3ffff24f.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkmy_website=self.webpackChunkmy_website||[]).push([[4274],{5999:(e,t,o)=>{o.r(t),o.d(t,{assets:()=>a,contentTitle:()=>s,default:()=>l,frontMatter:()=>i,metadata:()=>c,toc:()=>u});var r=o(4848),n=o(8453);const i={},s=void 0,c={id:"various-roles/curators-guide/introduction",title:"introduction",description:"---",source:"@site/docs/various-roles/curators-guide/introduction.md",sourceDirName:"various-roles/curators-guide",slug:"/various-roles/curators-guide/introduction",permalink:"/spec-up-t-website/docs/various-roles/curators-guide/introduction",draft:!1,unlisted:!1,editUrl:"https://github.com/blockchainbird/spec-up-t-website/tree/main/docs/various-roles/curators-guide/introduction.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Curators Guide",permalink:"/spec-up-t-website/docs/category/curators-guide"},next:{title:"Glossary Maintainers Guide",permalink:"/spec-up-t-website/docs/category/glossary-maintainers-guide"}},a={},u=[{value:"sidebar_position: 1",id:"sidebar_position-1",level:2}];function d(e){const t={h1:"h1",h2:"h2",hr:"hr",p:"p",...(0,n.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.hr,{}),"\n",(0,r.jsx)(t.h2,{id:"sidebar_position-1",children:"sidebar_position: 1"}),"\n",(0,r.jsx)(t.h1,{id:"curators-guide",children:"Curators Guide"}),"\n",(0,r.jsx)(t.p,{children:"Uses an IDE and git and browser extensions to check the overall content of a specification and logical consistency & meaning of term definition in a particular context."}),"\n",(0,r.jsx)(t.p,{children:"The curator uses browser extensions to harvest a personal collection of term definitions based on those recommended by the specification authors."}),"\n",(0,r.jsx)(t.p,{children:"A curator can:\nFork a Spec-Up-T repo to his/her user account on GitHub.com\nOptionally fetch and merge this repo to an IDE on a local computer.\nConfigure the user account to publish the GitHub pages generated by Spec-Up-T\nPush change to the user account of the curator to show the admin role\nOffer a PR with changes and compare them across forks."})]})}function l(e={}){const{wrapper:t}={...(0,n.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}},8453:(e,t,o)=>{o.d(t,{R:()=>s,x:()=>c});var r=o(6540);const n={},i=r.createContext(n);function s(e){const t=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:s(e.components),r.createElement(i.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/36846233.54eff54f.js b/assets/js/36846233.54eff54f.js deleted file mode 100644 index 236c467b..00000000 --- a/assets/js/36846233.54eff54f.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkmy_website=self.webpackChunkmy_website||[]).push([[4274],{5999:(e,t,o)=>{o.r(t),o.d(t,{assets:()=>a,contentTitle:()=>r,default:()=>l,frontMatter:()=>s,metadata:()=>c,toc:()=>u});var n=o(4848),i=o(8453);const s={sidebar_position:1},r="Curators Guide",c={id:"various-roles/curators-guide/introduction",title:"Curators Guide",description:"Uses an IDE and git and browser extensions, to check logical consistency & meaning of term definition in a certain context.",source:"@site/docs/various-roles/curators-guide/introduction.md",sourceDirName:"various-roles/curators-guide",slug:"/various-roles/curators-guide/introduction",permalink:"/spec-up-t-website/docs/various-roles/curators-guide/introduction",draft:!1,unlisted:!1,editUrl:"https://github.com/blockchainbird/spec-up-t-website/tree/main/docs/various-roles/curators-guide/introduction.md",tags:[],version:"current",sidebarPosition:1,frontMatter:{sidebar_position:1},sidebar:"tutorialSidebar",previous:{title:"Curators Guide",permalink:"/spec-up-t-website/docs/category/curators-guide"},next:{title:"Glossary Maintainers Guide",permalink:"/spec-up-t-website/docs/category/glossary-maintainers-guide"}},a={},u=[];function d(e){const t={h1:"h1",p:"p",...(0,i.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(t.h1,{id:"curators-guide",children:"Curators Guide"}),"\n",(0,n.jsx)(t.p,{children:"Uses an IDE and git and browser extensions, to check logical consistency & meaning of term definition in a certain context."}),"\n",(0,n.jsx)(t.p,{children:"Uses browser extensions to harvest a personal collection of term definitions, based on those recommended by the specification authors."})]})}function l(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(d,{...e})}):d(e)}},8453:(e,t,o)=>{o.d(t,{R:()=>r,x:()=>c});var n=o(6540);const i={},s=n.createContext(i);function r(e){const t=n.useContext(s);return n.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:r(e.components),n.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/4d95055f.82a871e2.js b/assets/js/4d95055f.78e2c969.js similarity index 58% rename from assets/js/4d95055f.82a871e2.js rename to assets/js/4d95055f.78e2c969.js index 4345fb19..3dd448c9 100644 --- a/assets/js/4d95055f.82a871e2.js +++ b/assets/js/4d95055f.78e2c969.js @@ -1 +1 @@ -"use strict";(self.webpackChunkmy_website=self.webpackChunkmy_website||[]).push([[6685],{8160:e=>{e.exports=JSON.parse('{"categoryGeneratedIndex":{"title":"Glossary Maintainers Guide","description":"Glossary Maintainers Guide.","slug":"/category/glossary-maintainers-guide","permalink":"/spec-up-t-website/docs/category/glossary-maintainers-guide","sidebar":"tutorialSidebar","navigation":{"previous":{"title":"Curators Guide","permalink":"/spec-up-t-website/docs/various-roles/curators-guide/introduction"},"next":{"title":"Glossary Maintainers Guide","permalink":"/spec-up-t-website/docs/various-roles/glossary-maintainers-guide/introduction"}}}}')}}]); \ No newline at end of file +"use strict";(self.webpackChunkmy_website=self.webpackChunkmy_website||[]).push([[6685],{8160:e=>{e.exports=JSON.parse('{"categoryGeneratedIndex":{"title":"Glossary Maintainers Guide","description":"Glossary Maintainers Guide.","slug":"/category/glossary-maintainers-guide","permalink":"/spec-up-t-website/docs/category/glossary-maintainers-guide","sidebar":"tutorialSidebar","navigation":{"previous":{"title":"introduction","permalink":"/spec-up-t-website/docs/various-roles/curators-guide/introduction"},"next":{"title":"Glossary Maintainers Guide","permalink":"/spec-up-t-website/docs/various-roles/glossary-maintainers-guide/introduction"}}}}')}}]); \ No newline at end of file diff --git a/assets/js/53ef7a94.33996c6d.js b/assets/js/53ef7a94.33996c6d.js deleted file mode 100644 index 8ee344a0..00000000 --- a/assets/js/53ef7a94.33996c6d.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkmy_website=self.webpackChunkmy_website||[]).push([[9121],{4421:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>c,contentTitle:()=>d,default:()=>a,frontMatter:()=>r,metadata:()=>o,toc:()=>l});var t=n(4848),i=n(8453);const r={sidebar_position:0},d="Intro",o={id:"various-roles/intro",title:"Intro",description:"The following roles can be distinguished:",source:"@site/docs/various-roles/intro.md",sourceDirName:"various-roles",slug:"/various-roles/intro",permalink:"/spec-up-t-website/docs/various-roles/intro",draft:!1,unlisted:!1,editUrl:"https://github.com/blockchainbird/spec-up-t-website/tree/main/docs/various-roles/intro.md",tags:[],version:"current",sidebarPosition:0,frontMatter:{sidebar_position:0},sidebar:"tutorialSidebar",previous:{title:"Roles",permalink:"/spec-up-t-website/docs/category/roles"},next:{title:"Admins Guide",permalink:"/spec-up-t-website/docs/various-roles/admins-guide"}},c={},l=[];function h(e){const s={a:"a",h1:"h1",p:"p",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,i.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(s.h1,{id:"intro",children:"Intro"}),"\n",(0,t.jsx)(s.p,{children:"The following roles can be distinguished:"}),"\n",(0,t.jsxs)(s.table,{children:[(0,t.jsx)(s.thead,{children:(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.th,{children:"Role"}),(0,t.jsx)(s.th,{children:"Description"}),(0,t.jsx)(s.th,{children:"Guide Link"}),(0,t.jsx)(s.th,{children:"Skills"})]})}),(0,t.jsxs)(s.tbody,{children:[(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:"Content Author"}),(0,t.jsx)(s.td,{children:"Focusses on content and concepts of the group he/she belongs to."}),(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/spec-up-t-website/docs/various-roles/content-authors-guide/introduction",children:"Content Author Guide"})}),(0,t.jsxs)(s.td,{children:[(0,t.jsx)(s.a,{href:"technical-skills-needed#3",children:"Understand JSON"}),", ",(0,t.jsx)(s.a,{href:"technical-skills-needed#4",children:"Understand Markdown"})]})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:"Terminology Author"}),(0,t.jsx)(s.td,{children:"Focusses on term definitions covering concepts of the group he/she belongs to."}),(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/spec-up-t-website/docs/various-roles/terminology-authors-guide/introduction",children:"Terminology Author Guide"})}),(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"technical-skills-needed#4",children:"Understand Markdown"})})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:"Curator"}),(0,t.jsx)(s.td,{children:"Checks logical consistency & meaning of term definition in a certain context."}),(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/spec-up-t-website/docs/various-roles/curators-guide/introduction",children:"Curator Guide"})}),(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"technical-skills-needed#4",children:"Understand Markdown"})})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:"Reader"}),(0,t.jsx)(s.td,{children:"Reads concepts in text and terminology in glossaries."}),(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/spec-up-t-website/docs/various-roles/readers-guide/introduction",children:"Reader Guide"})}),(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"technical-skills-needed#5",children:"Understand the web"})})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:"Admin"}),(0,t.jsx)(s.td,{children:"Installs, updates and maintains Spec-Up-T."}),(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/spec-up-t-website/docs/various-roles/admins-guide",children:"Admin Guide"})}),(0,t.jsxs)(s.td,{children:[(0,t.jsx)(s.a,{href:"technical-skills-needed#1",children:"Understand Node and NPM"}),", ",(0,t.jsx)(s.a,{href:"technical-skills-needed#2",children:"Understand file system"}),", ",(0,t.jsx)(s.a,{href:"technical-skills-needed#7",children:"Understand debugging"})]})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:"Developer"}),(0,t.jsx)(s.td,{children:"Adds new functionality to Spec-Up-T."}),(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/spec-up-t-website/docs/various-roles/developers-guide",children:"Developer Guide"})}),(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"technical-skills-needed#6",children:"Understand Git and Github"})})]})]})]})]})}function a(e={}){const{wrapper:s}={...(0,i.R)(),...e.components};return s?(0,t.jsx)(s,{...e,children:(0,t.jsx)(h,{...e})}):h(e)}},8453:(e,s,n)=>{n.d(s,{R:()=>d,x:()=>o});var t=n(6540);const i={},r=t.createContext(i);function d(e){const s=t.useContext(r);return t.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function o(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:d(e.components),t.createElement(r.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/53ef7a94.dd6100b5.js b/assets/js/53ef7a94.dd6100b5.js new file mode 100644 index 00000000..36313628 --- /dev/null +++ b/assets/js/53ef7a94.dd6100b5.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkmy_website=self.webpackChunkmy_website||[]).push([[9121],{4421:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>c,contentTitle:()=>d,default:()=>h,frontMatter:()=>r,metadata:()=>o,toc:()=>l});var t=n(4848),i=n(8453);const r={sidebar_position:0},d="Intro",o={id:"various-roles/intro",title:"Intro",description:"Spec-Up-T implementations can distinguish the following roles:",source:"@site/docs/various-roles/intro.md",sourceDirName:"various-roles",slug:"/various-roles/intro",permalink:"/spec-up-t-website/docs/various-roles/intro",draft:!1,unlisted:!1,editUrl:"https://github.com/blockchainbird/spec-up-t-website/tree/main/docs/various-roles/intro.md",tags:[],version:"current",sidebarPosition:0,frontMatter:{sidebar_position:0},sidebar:"tutorialSidebar",previous:{title:"Roles",permalink:"/spec-up-t-website/docs/category/roles"},next:{title:"Admins Guide",permalink:"/spec-up-t-website/docs/various-roles/admins-guide"}},c={},l=[];function a(e){const s={a:"a",h1:"h1",p:"p",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,i.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(s.h1,{id:"intro",children:"Intro"}),"\n",(0,t.jsx)(s.p,{children:"Spec-Up-T implementations can distinguish the following roles:"}),"\n",(0,t.jsxs)(s.table,{children:[(0,t.jsx)(s.thead,{children:(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.th,{children:"Role"}),(0,t.jsx)(s.th,{children:"Description"}),(0,t.jsx)(s.th,{children:"Guide Link"}),(0,t.jsx)(s.th,{children:"Skills"})]})}),(0,t.jsxs)(s.tbody,{children:[(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:"Content Author"}),(0,t.jsx)(s.td,{children:"Focusses on content and concepts of the group he/she belongs to."}),(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/spec-up-t-website/docs/various-roles/content-authors-guide/introduction",children:"Content Author Guide"})}),(0,t.jsxs)(s.td,{children:[(0,t.jsx)(s.a,{href:"technical-skills-needed#3",children:"Understand JSON"}),", ",(0,t.jsx)(s.a,{href:"technical-skills-needed#4",children:"Understand Markdown"})]})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:"Terminology Author"}),(0,t.jsx)(s.td,{children:"Focusses on term definitions covering concepts of the group he/she belongs to."}),(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/spec-up-t-website/docs/various-roles/terminology-authors-guide/introduction",children:"Terminology Author Guide"})}),(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"technical-skills-needed#4",children:"Understand Markdown"})})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:"Curator"}),(0,t.jsx)(s.td,{children:"Checks overall content and logical consistency & meaning of term definition in a certain context."}),(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/spec-up-t-website/docs/various-roles/curators-guide/introduction",children:"Curator Guide"})}),(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"technical-skills-needed#4",children:"Understand Markdown"})})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:"Reader"}),(0,t.jsx)(s.td,{children:"Reads concepts in text and terminology in glossaries."}),(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/spec-up-t-website/docs/various-roles/readers-guide/introduction",children:"Reader Guide"})}),(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"technical-skills-needed#5",children:"Understand the web"})})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:"Admin"}),(0,t.jsx)(s.td,{children:"Installs, updates, and maintains Spec-Up-T."}),(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/spec-up-t-website/docs/various-roles/admins-guide",children:"Admin Guide"})}),(0,t.jsxs)(s.td,{children:[(0,t.jsx)(s.a,{href:"technical-skills-needed#1",children:"Understand Node and NPM"}),", ",(0,t.jsx)(s.a,{href:"technical-skills-needed#2",children:"Understand file system"}),", ",(0,t.jsx)(s.a,{href:"technical-skills-needed#7",children:"Understand debugging"})]})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:"Developer"}),(0,t.jsx)(s.td,{children:"Adds new functionality to Spec-Up-T."}),(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/spec-up-t-website/docs/various-roles/developers-guide",children:"Developer Guide"})}),(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"technical-skills-needed#6",children:"Understand Git and Github"})})]})]})]})]})}function h(e={}){const{wrapper:s}={...(0,i.R)(),...e.components};return s?(0,t.jsx)(s,{...e,children:(0,t.jsx)(a,{...e})}):a(e)}},8453:(e,s,n)=>{n.d(s,{R:()=>d,x:()=>o});var t=n(6540);const i={},r=t.createContext(i);function d(e){const s=t.useContext(r);return t.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function o(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:d(e.components),t.createElement(r.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/c4a0550b.a0067fad.js b/assets/js/c4a0550b.a0067fad.js deleted file mode 100644 index 7d4e3b58..00000000 --- a/assets/js/c4a0550b.a0067fad.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkmy_website=self.webpackChunkmy_website||[]).push([[8509],{4028:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>a,default:()=>h,frontMatter:()=>s,metadata:()=>r,toc:()=>d});var i=t(4848),o=t(8453);const s={sidebar_position:17},a="How it came to be",r={id:"how-it-came-to-be",title:"How it came to be",description:"The ToIP Terms extension of Spec-Up",source:"@site/docs/how-it-came-to-be.md",sourceDirName:".",slug:"/how-it-came-to-be",permalink:"/spec-up-t-website/docs/how-it-came-to-be",draft:!1,unlisted:!1,editUrl:"https://github.com/blockchainbird/spec-up-t-website/tree/main/docs/how-it-came-to-be.md",tags:[],version:"current",sidebarPosition:17,frontMatter:{sidebar_position:17},sidebar:"tutorialSidebar",previous:{title:"Spec-Up-T demo",permalink:"/spec-up-t-website/docs/spec-up-t-demo-site"},next:{title:"Q & A",permalink:"/spec-up-t-website/docs/q-and-a"}},c={},d=[{value:"The ToIP Terms extension of Spec-Up",id:"the-toip-terms-extension-of-spec-up",level:2},{value:"What's different?",id:"whats-different",level:3},{value:"A rock and a hard place",id:"a-rock-and-a-hard-place",level:3},{value:"Versioning of terms and interactive use of specifications",id:"versioning-of-terms-and-interactive-use-of-specifications",level:3},{value:"No-go solo",id:"no-go-solo",level:3},{value:"How do we stay in sync?",id:"how-do-we-stay-in-sync",level:3},{value:"Charting territories",id:"charting-territories",level:3},{value:"Perspective: Authors",id:"perspective-authors",level:3},{value:"What's the meaning of this? ->",id:"whats-the-meaning-of-this--",level:4},{value:"What's the meaning of this? ->",id:"whats-the-meaning-of-this---1",level:4},{value:"What's the meaning of this? ->",id:"whats-the-meaning-of-this---2",level:4},{value:"Important note",id:"important-note",level:4},{value:"Perspective: Coders",id:"perspective-coders",level:3},{value:"Legend",id:"legend",level:3},{value:"Preparatory code organization and Git configuration in current DIF Spec-Up",id:"preparatory-code-organization-and-git-configuration-in-current-dif-spec-up",level:3}];function l(e){const n={blockquote:"blockquote",code:"code",em:"em",h1:"h1",h2:"h2",h3:"h3",h4:"h4",img:"img",li:"li",ol:"ol",p:"p",strong:"strong",ul:"ul",...(0,o.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"how-it-came-to-be",children:"How it came to be"}),"\n",(0,i.jsx)(n.h2,{id:"the-toip-terms-extension-of-spec-up",children:"The ToIP Terms extension of Spec-Up"}),"\n",(0,i.jsx)(n.p,{children:"This article is meant for technical experts in Spec-Up and git."}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"What is Spec-Up, what is Spec-Up-T and why do we need a fork? Could we move faster by creating our own? Do objectives diverge? Is it possible to work together in a better and more productive way?\nA brief answer to all of these questions is \u2018yes\u2019. This article elaborates on the details and comes up with an elegant, yet simple and practical, git governance proposal that will keep the ties between Spec-Up and Spec-Up-T in tact."})}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsx)(n.p,{children:"\u201cSpec-Up is a technical specification development tool that enables you to create rich specification documents for standards bodies and engineering projects by writing in an extended version of markdown that features all the bells and whistles - for example: advanced syntax highlighting, notice blocks, complex tables, charts, UML diagrams, and more.\u201d\nBy: Spec-Up creator Daniel Buchner, at Decentralised Identity Foundation (DIF)."}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Spec-Up is a great tool for creating online standardization specifications. We use it a lot at TrustoverIP. Recently, we also started contributing to DIF\u2019s Spec-Up code."}),"\n",(0,i.jsx)(n.p,{children:"At ToIP we support the original objective of DIF with Spec-Up. Spec-Up, as it is at present, gives us a base that we want to stay in sync with. Why do we want to merge changes to and fro DIF's spec-up?"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"To acknowledge the great work accomplished by DIF"}),"\n",(0,i.jsx)(n.li,{children:"Support a common specification tool in the SSI field that overarches the active umbrella organisations"}),"\n",(0,i.jsx)(n.li,{children:"last but not least: to combine current and future efforts."}),"\n"]}),"\n",(0,i.jsx)(n.h3,{id:"whats-different",children:"What's different?"}),"\n",(0,i.jsx)(n.p,{children:"At ToIP we do more with concepts and terminology than has been foreseen with Spec-Up. For example: versioning of individual terms, and versioning of who references them and when, has been proven a key to success of building consensus within ToIP."}),"\n",(0,i.jsx)(n.p,{children:"To offer ToIP-specific Spec-Up functionality we need to extent the code. Happily, we are able to extend Spec-Up with specific front-end and back-end functionality. As we did before, we could offer those extensions as a PR to DIF\u2019s Spec-Up. In practise this means: and ask Daniel Buchner to have a look at it and ask him to consider merging the new code into the main code repository of Spec-Up."}),"\n",(0,i.jsx)(n.h3,{id:"a-rock-and-a-hard-place",children:"A rock and a hard place"}),"\n",(0,i.jsxs)(n.p,{children:["What could be problematic for ToIP about the approach to present PRs regarding our ",(0,i.jsx)(n.em,{children:"specific"})," ToIP code to DIF's Spec-Up:"]}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsx)(n.li,{children:"We put Daniel Buchner / DIF on the critical path for ToIP development"}),"\n",(0,i.jsx)(n.li,{children:"We ask DIF to accept bolt-ons to a lean and mean Spec-Up"}),"\n",(0,i.jsx)(n.li,{children:"We trigger discussions about objectives of Spec-Up, where we want to implement Spec-Up right away.\nThis leaves us between a rock and a hard place if we were to proceed as before."}),"\n"]}),"\n",(0,i.jsx)(n.h3,{id:"versioning-of-terms-and-interactive-use-of-specifications",children:"Versioning of terms and interactive use of specifications"}),"\n",(0,i.jsx)(n.p,{children:"At ToIP we have a need for a Spec-Up tool that has a slightly different angle to static site generation for specification-documents:"}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsx)(n.li,{children:"because we have a ToIP-specific fine-grained view on concepts and terminology."}),"\n",(0,i.jsx)(n.li,{children:"we might want to have a few front-end amendments that would not match the lean and mean Spec-Up at DIF with the vision to have a compact simple solution for standards documents."}),"\n",(0,i.jsxs)(n.li,{children:["We might want to extend the layout capabilities to adhere to standards of specific target audiences.\nThe last reason is that we want to move faster with as little \u201cdesks to go for a stamp\u201d as possible.\nWe call this extended Spec-Up ",(0,i.jsx)(n.em,{children:"Spec-Up-T"}),", where \u2019T\u2019 can both cover - or refer to - \u2018Terms\u2019 and \u2018ToIP\u2019."]}),"\n"]}),"\n",(0,i.jsx)(n.h3,{id:"no-go-solo",children:"No-go solo"}),"\n",(0,i.jsxs)(n.p,{children:["What if we were to declare a part of the code in the DIF Spec-Up repository a ",(0,i.jsx)(n.em,{children:"no-go area"}),"? More specifically, within a common shared area we only change code under consensus by offering PRs to be accepted and merged by DIF. That would make coding easier and offer a clear division in feature sets of Spec-Up and Spec-Up-T."]}),"\n",(0,i.jsx)(n.p,{children:"Due to the reasons listed above, we need to partly develop solo in a fork (Spec-Up-T), and then we could offer our work to DIF. If they merge our code in their repo, that\u2019d be great because it would confirm consensus about objectives behind Spec-Up. But this mutual merge is optional for DIF."}),"\n",(0,i.jsx)(n.h3,{id:"how-do-we-stay-in-sync",children:"How do we stay in sync?"}),"\n",(0,i.jsx)(n.p,{children:'We propose a "bi-directional sync" or "mutual synchronization" model. In this model, both repositories are equally important, and changes are synced between them at will to ensure they both contain the same information or updates.'}),"\n",(0,i.jsx)(n.h3,{id:"charting-territories",children:"Charting territories"}),"\n",(0,i.jsx)(n.p,{children:"For clarity, there are three main perspectives on Spec-Up(-T) publicly AND on your local computer:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Authors"})," look at ready-to-use Spec-Up github.com version (after running Starter-pack)"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Coders"})," look at the NPM Spec-Up libraries"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Users"})," see the generated end-product on github.io (index.html)"]}),"\n"]}),"\n",(0,i.jsx)(n.h3,{id:"perspective-authors",children:"Perspective: Authors"}),"\n",(0,i.jsxs)(n.p,{children:["Authors of a new Specification start with an empty directory on their local machine. After the command ",(0,i.jsx)(n.code,{children:"npm install spec-up-T"})," the spec directory and all the files mentioned will be present. The grey files are not to be touched because they are generated results. The green files can be altered to fill and configure the new Specification. A Spec-Up-T install will typically include all DIF Spec-Up code."]}),"\n",(0,i.jsx)(n.h4,{id:"whats-the-meaning-of-this--",children:"What's the meaning of this? ->"}),"\n",(0,i.jsx)(n.p,{children:"After this an author can start filling the project, and configuring Spec-Up(-T)."}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.img,{alt:"image",src:t(7081).A+"",width:"1730",height:"878"})}),"\n",(0,i.jsxs)(n.p,{children:["Next is the",(0,i.jsx)(n.code,{children:"Npm install"})," command that actually populates the authors local Specification repo with the Spec-Up(-T) code."]}),"\n",(0,i.jsxs)(n.p,{children:["Mind you, it's no different on github.com: a ",(0,i.jsx)(n.code,{children:"push"})," will invoke a github action that generates a branch called ",(0,i.jsx)(n.code,{children:"gh-pages"})," with the same files."]}),"\n",(0,i.jsx)(n.h4,{id:"whats-the-meaning-of-this---1",children:"What's the meaning of this? ->"}),"\n",(0,i.jsx)(n.p,{children:"Both a local and remote version of an author's specification can be generated, can be monitored and curated."}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.img,{alt:"image",src:t(6569).A+"",width:"1744",height:"910"})}),"\n",(0,i.jsxs)(n.p,{children:["The static site generation result in a one page ",(0,i.jsx)(n.code,{children:"index.html"})," file."]}),"\n",(0,i.jsx)(n.h4,{id:"whats-the-meaning-of-this---2",children:"What's the meaning of this? ->"}),"\n",(0,i.jsx)(n.p,{children:"An author can develop and test the Specification locally and then push it to production."}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.img,{alt:"image",src:t(9251).A+"",width:"1750",height:"1010"})}),"\n",(0,i.jsx)(n.h4,{id:"important-note",children:"Important note"}),"\n",(0,i.jsxs)(n.p,{children:["To get the github page online a few configuration steps must follow on github.com repo, branche ",(0,i.jsx)(n.code,{children:"master"})]}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsx)(n.p,{children:"Go to 'Settings' -> 'Pages' (you need administrator-rights)"}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"to publish the Specification as a one pager on github.io."}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.img,{alt:"image",src:t(1724).A+"",width:"1588",height:"456"})}),"\n",(0,i.jsx)(n.h3,{id:"perspective-coders",children:"Perspective: Coders"}),"\n",(0,i.jsx)(n.p,{children:"Suppose DIF's Spec-Up is stable and not actively enhanced further. Spec-Up still can merge PRs from others. In time Spec-Up-T libraries will grow (second circle pair) and with this development and through merges Spec-Up can cherry pick whatever it wants to incorporate from Spec-Up-T and grow too, without diverging (third circle pair)."}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.img,{alt:"image",src:t(4606).A+"",width:"1746",height:"972"})}),"\n",(0,i.jsx)(n.p,{children:"The image below shows the github.com repo and its NPM library section op the in green, red and orange. and in below. We won\u2019t touch the red and orange sections in our repo \u2018Spec-Up-T\u2019 without making a separate branche and offer the changes as a PR to DIF."}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.img,{alt:"image",src:t(4419).A+"",width:"349",height:"811"})}),"\n",(0,i.jsxs)(n.p,{children:["Mind you, the ",(0,i.jsx)(n.code,{children:"Spec"})," directory regularly holds the authors' markdown, but it's crossed out because this is a configurable location."]}),"\n",(0,i.jsx)(n.h3,{id:"legend",children:"Legend"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"Red: definitely do not touch anything, because of the red files and red directories are generated and some are core components"}),"\n",(0,i.jsx)(n.li,{children:"Orange: may touch, but in consultation via PRs with DIF / Daniel Buchner"}),"\n",(0,i.jsx)(n.li,{children:"Green: these are the files to freely alter under Spec-Up-T."}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"In the orange sections, we could make amendments for ToIP concepts and terminology. By doing so, we can move forward without having to wait for DIF to accept or reject these changes."}),"\n",(0,i.jsx)(n.p,{children:"Other Spec-Up-based repos could come over to Spec-Up-T and pull the amendments that we've made to their repo. We\u2019ll branch off per feature. Because we stay in sync with the latest Spec-Up, a clean merge with little or no merge conflicts should be possible. Of course, for this to happen, the target repo needs to be in sync with the latest Spec-Up too."}),"\n",(0,i.jsx)(n.h3,{id:"preparatory-code-organization-and-git-configuration-in-current-dif-spec-up",children:"Preparatory code organization and Git configuration in current DIF Spec-Up"}),"\n",(0,i.jsx)(n.p,{children:"To have a clean start we suggest to offer a PR to Daniel Buchner. This PR doesn't change any feature nor outcome at the front-end side of a Spec-Up generated site, but only alters the code organisation. Thesse are the points of interest:"}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsx)(n.p,{children:"Maintain a Clean Division: Currently, our Node.js scripts are placed in the root directory, while client-side JavaScript and CSS have their own directory under /assets. We should aim for a similar clean separation of all Node.js (and server side code in general) for all new developments. By organizing new features and code into separate files within a dedicated directory, we can ensure that code and content is even more manageable and even better organized."}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsx)(n.p,{children:"Minimize Changes to Existing Code: To facilitate smoother updates and reduce the burden of acceptance checks, it's crucial to keep modifications to existing code to a minimum. By placing new code in distinct files and directories, we allow ongoing work without significant disruption. This approach respects the existing codebase while permitting necessary extensions and bug fixes."}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:["Exclude Generated Files from Git. In our case it is about node_modules, generated files (e.g., everything in /compiled). It should not be included in our Git repositories. These files are the result of compilation commands like ",(0,i.jsx)(n.code,{children:"$ gulp compile"})," and can be recreated from source, making their inclusion in version control redundant and cluttering."]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsx)(n.p,{children:"Maintenance issues:"}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"main and master branch?! What's the use of keeping both?"}),"\n",(0,i.jsx)(n.li,{children:".gitignore revision (fonts in ignore? other stuff in .gitignore?)"}),"\n"]})]})}function h(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},9251:(e,n,t)=>{t.d(n,{A:()=>i});const i=t.p+"assets/images/H1Gk-UiEA-97a120088f597f6f5f1ddb5d7772f5b8.png"},6569:(e,n,t)=>{t.d(n,{A:()=>i});const i=t.p+"assets/images/H1aQg8iNC-b028d205236d10965fbcabc35d149332.png"},4419:(e,n,t)=>{t.d(n,{A:()=>i});const i=t.p+"assets/images/Hy_mVl1rR-1a9da3ed9a251db88a872dd9f4929b21.png"},7081:(e,n,t)=>{t.d(n,{A:()=>i});const i=t.p+"assets/images/HymBy8j4A-c9b711f6978646294903a1e0dd551303.png"},4606:(e,n,t)=>{t.d(n,{A:()=>i});const i=t.p+"assets/images/SyxaaHsEC-d9b66475d3ca9e96adc9f581a07d0098.png"},1724:(e,n,t)=>{t.d(n,{A:()=>i});const i=t.p+"assets/images/rJAWXLsNR-db4adf83c1c5837e170ab3af738d1e50.png"},8453:(e,n,t)=>{t.d(n,{R:()=>a,x:()=>r});var i=t(6540);const o={},s=i.createContext(o);function a(e){const n=i.useContext(s);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:a(e.components),i.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/c4a0550b.e68848bc.js b/assets/js/c4a0550b.e68848bc.js new file mode 100644 index 00000000..4829e2c9 --- /dev/null +++ b/assets/js/c4a0550b.e68848bc.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkmy_website=self.webpackChunkmy_website||[]).push([[8509],{4028:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>a,default:()=>l,frontMatter:()=>s,metadata:()=>r,toc:()=>d});var i=t(4848),o=t(8453);const s={sidebar_position:17},a="How it came to be",r={id:"how-it-came-to-be",title:"How it came to be",description:"The ToIP Terms extension of Spec-Up",source:"@site/docs/how-it-came-to-be.md",sourceDirName:".",slug:"/how-it-came-to-be",permalink:"/spec-up-t-website/docs/how-it-came-to-be",draft:!1,unlisted:!1,editUrl:"https://github.com/blockchainbird/spec-up-t-website/tree/main/docs/how-it-came-to-be.md",tags:[],version:"current",sidebarPosition:17,frontMatter:{sidebar_position:17},sidebar:"tutorialSidebar",previous:{title:"Spec-Up-T demo",permalink:"/spec-up-t-website/docs/spec-up-t-demo-site"},next:{title:"Q & A",permalink:"/spec-up-t-website/docs/q-and-a"}},c={},d=[{value:"The ToIP Terms extension of Spec-Up",id:"the-toip-terms-extension-of-spec-up",level:2},{value:"What's different?",id:"whats-different",level:3},{value:"A rock and a hard place",id:"a-rock-and-a-hard-place",level:3},{value:"Versioning of terms and interactive use of specifications",id:"versioning-of-terms-and-interactive-use-of-specifications",level:3},{value:"No-go solo",id:"no-go-solo",level:3},{value:"How do we stay in sync?",id:"how-do-we-stay-in-sync",level:3},{value:"Charting territories",id:"charting-territories",level:3},{value:"Perspective: Authors",id:"perspective-authors",level:3},{value:"What's the meaning of this? ->",id:"whats-the-meaning-of-this--",level:4},{value:"What's the meaning of this? ->",id:"whats-the-meaning-of-this---1",level:4},{value:"What's the meaning of this? ->",id:"whats-the-meaning-of-this---2",level:4},{value:"Important note",id:"important-note",level:4},{value:"Perspective: Coders",id:"perspective-coders",level:3},{value:"Legend",id:"legend",level:3},{value:"Preparatory code organization and Git configuration in current DIF Spec-Up",id:"preparatory-code-organization-and-git-configuration-in-current-dif-spec-up",level:3}];function h(e){const n={blockquote:"blockquote",code:"code",em:"em",h1:"h1",h2:"h2",h3:"h3",h4:"h4",img:"img",li:"li",ol:"ol",p:"p",strong:"strong",ul:"ul",...(0,o.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"how-it-came-to-be",children:"How it came to be"}),"\n",(0,i.jsx)(n.h2,{id:"the-toip-terms-extension-of-spec-up",children:"The ToIP Terms extension of Spec-Up"}),"\n",(0,i.jsx)(n.p,{children:"This article is meant for technical experts in Spec-Up and git."}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"What is Spec-Up, what is Spec-Up-T, and why do we need a fork? Could we move faster by creating our own? Do objectives diverge? Is it possible to work together in a better and more productive way?\nA brief answer to all of these questions is 'yes'. This article elaborates on the details and comes up with an elegant yet simple and practical git governance proposal that will keep the ties between Spec-Up and Spec-Up-T intact."})}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsx)(n.p,{children:'"Spec-Up is a technical specification development tool that enables you to create rich specification documents for standards bodies and engineering projects by writing in an extended version of markdown that features all the bells and whistles - for example, advanced syntax highlighting, notice blocks, complex tables, charts, UML diagrams, and more."\nBy Spec-Up creator Daniel Buchner at Decentralised Identity Foundation (DIF).'}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Spec-Up is a great tool for creating online standardization specifications. We use it a lot at TrustoverIP. Recently, we also started contributing to DIF's Spec-Up code."}),"\n",(0,i.jsx)(n.p,{children:"At ToIP, we support the original objective of DIF with Spec-Up. Spec-Up, as it is now, gives us a base with which we want to stay in sync. Why do we want to merge changes to and from DIF's spec-up?"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"To acknowledge the great work accomplished by DIF"}),"\n",(0,i.jsx)(n.li,{children:"Support a standard specification tool in the SSI field that overarches the active umbrella organizations\nLast but not least, we need to combine current and future efforts."}),"\n"]}),"\n",(0,i.jsx)(n.h3,{id:"whats-different",children:"What's different?"}),"\n",(0,i.jsx)(n.p,{children:"At ToIP, we do more with concepts and terminology than Spec-Up has foreseen. An example of this work is versioning individual terms and versioning who references them and when have been proven critical to building consensus within ToIP."}),"\n",(0,i.jsx)(n.p,{children:"To offer ToIP-specific Spec-Up functionality, we need to extend the code. Happily, we are able to extend Spec-Up with specific front-end and back-end functionality. As we did before, we could offer those extensions as a PR to DIF's Spec-Up. In practice, this means asking Daniel Buchner to have a look at it and asking him to consider merging the new code into the main code repository of Spec-Up."}),"\n",(0,i.jsx)(n.h3,{id:"a-rock-and-a-hard-place",children:"A rock and a hard place"}),"\n",(0,i.jsxs)(n.p,{children:["What could be problematic for ToIP about the approach to present PRs regarding our ",(0,i.jsx)(n.em,{children:"specific"})," ToIP code to DIF's Spec-Up:"]}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsx)(n.li,{children:"We put Daniel Buchner / DIF on the critical path for ToIP development"}),"\n",(0,i.jsx)(n.li,{children:"We ask DIF to accept bolt-ons to a lean and mean Spec-Up"}),"\n",(0,i.jsx)(n.li,{children:"We trigger discussions about the objectives of Spec-Up, where we want to implement Spec-Up right away.\nThis leaves us between a rock and a hard place if we were to proceed as before."}),"\n"]}),"\n",(0,i.jsx)(n.h3,{id:"versioning-of-terms-and-interactive-use-of-specifications",children:"Versioning of terms and interactive use of specifications"}),"\n",(0,i.jsx)(n.p,{children:"At ToIP, we need a Spec-Up tool that has a slightly different angle to static site generation for specification documents:"}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsx)(n.li,{children:"because we have a ToIP-specific fine-grained view of concepts and terminology."}),"\n",(0,i.jsx)(n.li,{children:"We should have a few front-end amendments that would not match the lean and mean Spec-Up at DIF with the vision of a compact, simple solution for standards documents."}),"\n",(0,i.jsxs)(n.li,{children:['We can extend the layout capabilities to adhere to the standards of specific target audiences.\nThe last reason is that we want to move faster with as few "desks to go for a stamp" as possible.\nWe call this extended Spec-Up ',(0,i.jsx)(n.em,{children:"Spec-Up-T"}),", where' T' can both cover - or refer to - 'Terms' and 'ToIP.'"]}),"\n"]}),"\n",(0,i.jsx)(n.h3,{id:"no-go-solo",children:"No-go solo"}),"\n",(0,i.jsxs)(n.p,{children:["What if we declared a part of the code in the DIF Spec-Up repository a ",(0,i.jsx)(n.em,{children:"no-go area"}),"? More specifically, within a common shared area, we only change code under consensus by offering PRs to be accepted and merged by DIF. That would make coding easier and offer a clear division in feature sets of Spec-Up and Spec-Up-T."]}),"\n",(0,i.jsx)(n.p,{children:"Due to the reasons listed above, we need to partly develop solo in a fork (Spec-Up-T), and then we could offer our work to DIF. If they merge our code in their repo, that'd be great because it would confirm consensus about the objectives behind Spec-Up. But this mutual merge is optional for DIF."}),"\n",(0,i.jsx)(n.h3,{id:"how-do-we-stay-in-sync",children:"How do we stay in sync?"}),"\n",(0,i.jsx)(n.p,{children:'We propose a "bi-directional sync" or "mutual synchronization" model. In this model, both repositories are equally important, and changes are synced between them at will to ensure they both contain the same information or updates.'}),"\n",(0,i.jsx)(n.h3,{id:"charting-territories",children:"Charting territories"}),"\n",(0,i.jsx)(n.p,{children:"For clarity, there are three main perspectives on Spec-Up(-T) publicly AND on your local computer:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Authors"})," look at the ready-to-use Spec-Up github.com version (after running Starter-pack)"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Coders"})," look at the NPM Spec-Up libraries"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Users"})," see the generated end-product on github.io (index.html)"]}),"\n"]}),"\n",(0,i.jsx)(n.h3,{id:"perspective-authors",children:"Perspective: Authors"}),"\n",(0,i.jsxs)(n.p,{children:["Authors of a new Specification start with an empty directory on their local machine. After the command ",(0,i.jsx)(n.code,{children:"npm install spec-up-T"}),", the spec directory and all the files mentioned will be present. The grey files are not to be touched because they are generated results. The green files can be altered to fill and configure the new specification. A Spec-Up-T install will typically include all DIF Spec-Up codes."]}),"\n",(0,i.jsx)(n.h4,{id:"whats-the-meaning-of-this--",children:"What's the meaning of this? ->"}),"\n",(0,i.jsx)(n.p,{children:"After this, an author can start filling the project and configuring Spec-Up(-T)."}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.img,{alt:"image",src:t(7081).A+"",width:"1730",height:"878"})}),"\n",(0,i.jsx)(n.p,{children:"Next is the 'Npm install` command that populates the author's local Specification repo with the Spec-Up(-T) code."}),"\n",(0,i.jsxs)(n.p,{children:["Mind you; it's no different on github.com: a ",(0,i.jsx)(n.code,{children:"push"})," will invoke a github action that generates a branch called ",(0,i.jsx)(n.code,{children:"gh-pages"})," with the same files."]}),"\n",(0,i.jsx)(n.h4,{id:"whats-the-meaning-of-this---1",children:"What's the meaning of this? ->"}),"\n",(0,i.jsx)(n.p,{children:"Both a local and remote version of an author's specification can be generated, monitored, and curated."}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.img,{alt:"image",src:t(6569).A+"",width:"1744",height:"910"})}),"\n",(0,i.jsxs)(n.p,{children:["The static site generation results in a one-page ",(0,i.jsx)(n.code,{children:"index.html"})," file."]}),"\n",(0,i.jsx)(n.h4,{id:"whats-the-meaning-of-this---2",children:"What's the meaning of this? ->"}),"\n",(0,i.jsx)(n.p,{children:"An author can develop and test the specification locally and then push it to production."}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.img,{alt:"image",src:t(9251).A+"",width:"1750",height:"1010"})}),"\n",(0,i.jsx)(n.h4,{id:"important-note",children:"Important note"}),"\n",(0,i.jsxs)(n.p,{children:["In his wish to put the github page online, the implementor must follow a few configuration steps on the github.com repo, branch ",(0,i.jsx)(n.code,{children:"master"}),":"]}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsx)(n.p,{children:"Go to 'Settings' -> 'Pages' (you need administrator rights)"}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"To publish the specification as a one-pager on github.io."}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.img,{alt:"image",src:t(1724).A+"",width:"1588",height:"456"})}),"\n",(0,i.jsx)(n.h3,{id:"perspective-coders",children:"Perspective: Coders"}),"\n",(0,i.jsx)(n.p,{children:"Suppose DIF's Spec-Up is stable and not actively enhanced further. Spec-Up can still merge PRs from others. In time, Spec-Up-T libraries will grow (second circle pair), and with this development and through merges, Spec-Up can cherry-pick whatever it wants to incorporate from Spec-Up-T and grow too, without diverging (third circle pair)."}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.img,{alt:"image",src:t(4606).A+"",width:"1746",height:"972"})}),"\n",(0,i.jsx)(n.p,{children:"The image below shows the github.com repo and its NPM library section in green, red, and orange. We won't touch the red and orange sections in our repo 'Spec-Up-T' without making a separate branch and offering the changes as a PR to DIF."}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.img,{alt:"image",src:t(4419).A+"",width:"349",height:"811"})}),"\n",(0,i.jsxs)(n.p,{children:["Mind you, the ",(0,i.jsx)(n.code,{children:"Spec"})," directory regularly holds the authors' markdown, but it's crossed out because this is a configurable location."]}),"\n",(0,i.jsx)(n.h3,{id:"legend",children:"Legend"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"Red: definitely do not touch anything because the red files and red directories are generated, and some are core components"}),"\n",(0,i.jsx)(n.li,{children:"Orange: may touch, but in consultation via PRs with DIF / Daniel Buchner"}),"\n",(0,i.jsx)(n.li,{children:"Green: These are the files that can freely be altered under Spec-Up-T."}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"In the orange sections, we could make amendments to ToIP concepts and terminology. By doing so, we can move forward without having to wait for DIF to accept or reject these changes."}),"\n",(0,i.jsx)(n.p,{children:"Other Spec-Up-based repos could come over to Spec-Up-T and pull the amendments that we've made to their repo. We'll branch off per feature. Because we stay in sync with the latest Spec-Up, a clean merge with little or no merge conflicts should be possible. Of course, for this to happen, the target repo needs to be in sync with the latest Spec-Up, too."}),"\n",(0,i.jsx)(n.h3,{id:"preparatory-code-organization-and-git-configuration-in-current-dif-spec-up",children:"Preparatory code organization and Git configuration in current DIF Spec-Up"}),"\n",(0,i.jsx)(n.p,{children:"To have a clean start, we suggest offering a PR to Daniel Buchner. This PR doesn't change any feature or outcome at the front-end side of a Spec-Up-generated site but only alters the code organization. These are the points of interest:"}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsx)(n.p,{children:"Maintain a Clean Division: Currently, our Node.js scripts are placed in the root directory, while client-side JavaScript and CSS have their own directory under /assets. We should aim for a similar clean separation of all Node.js (and server-side code in general) for all new developments. By organizing new features and code into separate files within a dedicated directory, we can ensure that code and content are even more manageable and even better organized."}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsx)(n.p,{children:"Minimize Changes to Existing Code: This is done to facilitate smoother updates and reduce the burden of acceptance checks; it's crucial to keep modifications to existing code to a minimum. By placing new code in distinct files and directories, we allow ongoing work without significant disruption. This approach respects the existing codebase while permitting necessary extensions and bug fixes."}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:["Exclude Generated Files from Git. In our case, it is about node_modules and generated files (e.g., everything in /compiled). It should not be included in our Git repositories. These files are the result of compilation commands like ",(0,i.jsx)(n.code,{children:"$ gulp compile"})," and can be recreated from the source, making their inclusion in version control redundant and cluttering."]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsx)(n.p,{children:"Maintenance issues:"}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"main and master branch?! What's the use of keeping both?"}),"\n",(0,i.jsx)(n.li,{children:".gitignore revision (fonts in .ignore? other stuff in .gitignore?)"}),"\n"]})]})}function l(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(h,{...e})}):h(e)}},9251:(e,n,t)=>{t.d(n,{A:()=>i});const i=t.p+"assets/images/H1Gk-UiEA-97a120088f597f6f5f1ddb5d7772f5b8.png"},6569:(e,n,t)=>{t.d(n,{A:()=>i});const i=t.p+"assets/images/H1aQg8iNC-b028d205236d10965fbcabc35d149332.png"},4419:(e,n,t)=>{t.d(n,{A:()=>i});const i=t.p+"assets/images/Hy_mVl1rR-1a9da3ed9a251db88a872dd9f4929b21.png"},7081:(e,n,t)=>{t.d(n,{A:()=>i});const i=t.p+"assets/images/HymBy8j4A-c9b711f6978646294903a1e0dd551303.png"},4606:(e,n,t)=>{t.d(n,{A:()=>i});const i=t.p+"assets/images/SyxaaHsEC-d9b66475d3ca9e96adc9f581a07d0098.png"},1724:(e,n,t)=>{t.d(n,{A:()=>i});const i=t.p+"assets/images/rJAWXLsNR-db4adf83c1c5837e170ab3af738d1e50.png"},8453:(e,n,t)=>{t.d(n,{R:()=>a,x:()=>r});var i=t(6540);const o={},s=i.createContext(o);function a(e){const n=i.useContext(s);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:a(e.components),i.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/dff1e1e9.b389e276.js b/assets/js/dff1e1e9.b389e276.js new file mode 100644 index 00000000..b1511bfb --- /dev/null +++ b/assets/js/dff1e1e9.b389e276.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkmy_website=self.webpackChunkmy_website||[]).push([[8838],{2234:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>l,contentTitle:()=>o,default:()=>h,frontMatter:()=>t,metadata:()=>d,toc:()=>c});var r=i(4848),s=i(8453);const t={sidebar_position:3},o="General Guide",d={id:"various-roles/general-guide",title:"General Guide",description:"These are general instructions for every role involved.",source:"@site/docs/various-roles/general-guide.md",sourceDirName:"various-roles",slug:"/various-roles/general-guide",permalink:"/spec-up-t-website/docs/various-roles/general-guide",draft:!1,unlisted:!1,editUrl:"https://github.com/blockchainbird/spec-up-t-website/tree/main/docs/various-roles/general-guide.md",tags:[],version:"current",sidebarPosition:3,frontMatter:{sidebar_position:3},sidebar:"tutorialSidebar",previous:{title:"Technical skills needed",permalink:"/spec-up-t-website/docs/various-roles/technical-skills-needed"},next:{title:"Content Authors Guide",permalink:"/spec-up-t-website/docs/category/content-authors-guide"}},l={},c=[{value:"Look up xrefs",id:"look-up-xrefs",level:4},{value:"Create index.html",id:"create-indexhtml",level:4},{value:"You are ready",id:"you-are-ready",level:4},{value:"View your specification",id:"view-your-specification",level:4},{value:"Three different modes",id:"three-different-modes",level:4},{value:"Automation",id:"automation",level:4}];function a(e){const n={a:"a",admonition:"admonition",code:"code",h1:"h1",h4:"h4",li:"li",p:"p",pre:"pre",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",ul:"ul",...(0,s.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"general-guide",children:"General Guide"}),"\n",(0,r.jsx)(n.p,{children:"These are general instructions for every role involved."}),"\n",(0,r.jsx)(n.h4,{id:"look-up-xrefs",children:"Look up xrefs"}),"\n",(0,r.jsx)(n.p,{children:"Xrefs are [To Do: write explanation]"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{children:"npm run xrefs\n"})}),"\n",(0,r.jsx)(n.p,{children:"Now, the references to external specs are generated, if any."}),"\n",(0,r.jsx)(n.h4,{id:"create-indexhtml",children:"Create index.html"}),"\n",(0,r.jsxs)(n.p,{children:["The final result will be just one file: ",(0,r.jsx)(n.code,{children:"index.html"}),". This file is rendered or re-rendered with the following command:"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{children:"npm run render\n"})}),"\n",(0,r.jsxs)(n.p,{children:["Now, an index.html file is created in the ",(0,r.jsx)(n.code,{children:"docs"})," directory. This is the default directory specified in the ",(0,r.jsx)(n.code,{children:"specs.json"})," file."]}),"\n",(0,r.jsx)(n.h4,{id:"you-are-ready",children:"You are ready"}),"\n",(0,r.jsxs)(n.p,{children:["Now you have a basic Spec-Up-T specification file (",(0,r.jsx)(n.code,{children:"index.html"}),") with the following content:"]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:["a ",(0,r.jsx)(n.code,{children:"specs.json"})," file"]}),"\n",(0,r.jsxs)(n.li,{children:["a ",(0,r.jsx)(n.code,{children:"spec/"})," directory with sample markdown files"]}),"\n",(0,r.jsxs)(n.li,{children:["a ",(0,r.jsx)(n.code,{children:"docs"})," directory with a sample index.html file"]}),"\n",(0,r.jsxs)(n.li,{children:["a ",(0,r.jsx)(n.code,{children:"node_modules"})," directory, a ",(0,r.jsx)(n.code,{children:"package.json"})," file, and a ",(0,r.jsx)(n.code,{children:"package-lock.json"})," file (these three elements belong to the ",(0,r.jsx)(n.code,{children:"npm"})," system)"]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"view-your-specification",children:"View your specification"}),"\n",(0,r.jsxs)(n.p,{children:["So the ",(0,r.jsx)(n.code,{children:"index.html"})," is the endresult. You should view it in a browser. Er zijn twee manieren om dit te doen:"]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:["via ",(0,r.jsx)(n.code,{children:"http://"})]}),"\n",(0,r.jsxs)(n.li,{children:["via ",(0,r.jsx)(n.code,{children:"file:///"})]}),"\n"]}),"\n",(0,r.jsxs)(n.p,{children:["The simplest way to do so is via ",(0,r.jsx)(n.code,{children:"file:///"}),": go to the ",(0,r.jsx)(n.code,{children:"index.html"})," file with your Explorer, Finder, or other file manager, and double-click on it. Usually, it now opens in your browser."]}),"\n",(0,r.jsx)(n.p,{children:"If not, go to the browser and try to open the file from the browser menu."}),"\n",(0,r.jsxs)(n.p,{children:["This way, you open the ",(0,r.jsx)(n.code,{children:"index.html"})," file via the ",(0,r.jsx)(n.code,{children:"file protocol"})," (\u201c",(0,r.jsx)(n.code,{children:"file:///"}),"\u201d)."]}),"\n",(0,r.jsxs)(n.p,{children:["You can also access it via HTTP. You then need to place the ",(0,r.jsx)(n.code,{children:"index.html"})," file on a web server and access it through a browser using the URL under which the file is accessible."]}),"\n",(0,r.jsx)(n.p,{children:"This way, you can share it with the world by sharing the URL."}),"\n",(0,r.jsx)(n.admonition,{type:"info",children:(0,r.jsx)(n.p,{children:"HTTP stands for HyperText Transfer Protocol. It is the foundation of any data exchange on the Web and a protocol for transmitting hypertext requests and information online. The World Wide Web uses HTTP and defines how messages are formatted and transmitted and how web servers and browsers should respond to various commands."})}),"\n",(0,r.jsx)(n.h4,{id:"three-different-modes",children:"Three different modes"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"npm run render"})," is not the only way to go. There are three different modes for rendering the specification:"]}),"\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:"command"}),(0,r.jsx)(n.th,{children:"behavior"})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"npm run edit"})}),(0,r.jsxs)(n.td,{children:["After rendering, this will stay running, and the ",(0,r.jsx)(n.code,{children:"gulp"})," library will watch the source files in your spec directory/ies for changes and re-render any time you save a file. Opening these rendered files in a browser and refreshing them will keep you up to date."]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"npm run render"})}),(0,r.jsx)(n.td,{children:"This renders the site once and does not keep a gulpy watch on the underlying files."})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"npm run dev"})}),(0,r.jsx)(n.td,{children:"this enables debugging features."})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"automation",children:"Automation"}),"\n",(0,r.jsxs)(n.p,{children:["The above scripts can easily be triggered by ",(0,r.jsx)(n.a,{href:"../glossary#github-actions",children:"github actions"}),". See ",(0,r.jsx)(n.a,{href:"https://github.com/decentralized-identity/spec-up/blob/master/.github/workflows/render-specs.yml",children:"this repo's example"})]})]})}function h(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(a,{...e})}):a(e)}},8453:(e,n,i)=>{i.d(n,{R:()=>o,x:()=>d});var r=i(6540);const s={},t=r.createContext(s);function o(e){const n=r.useContext(t);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function d(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),r.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/dff1e1e9.bf109279.js b/assets/js/dff1e1e9.bf109279.js deleted file mode 100644 index 2f7b5e8d..00000000 --- a/assets/js/dff1e1e9.bf109279.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkmy_website=self.webpackChunkmy_website||[]).push([[8838],{2234:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>l,contentTitle:()=>d,default:()=>h,frontMatter:()=>t,metadata:()=>o,toc:()=>c});var r=i(4848),s=i(8453);const t={sidebar_position:3},d="General Guide",o={id:"various-roles/general-guide",title:"General Guide",description:"These are general instructions.",source:"@site/docs/various-roles/general-guide.md",sourceDirName:"various-roles",slug:"/various-roles/general-guide",permalink:"/spec-up-t-website/docs/various-roles/general-guide",draft:!1,unlisted:!1,editUrl:"https://github.com/blockchainbird/spec-up-t-website/tree/main/docs/various-roles/general-guide.md",tags:[],version:"current",sidebarPosition:3,frontMatter:{sidebar_position:3},sidebar:"tutorialSidebar",previous:{title:"Technical skills needed",permalink:"/spec-up-t-website/docs/various-roles/technical-skills-needed"},next:{title:"Content Authors Guide",permalink:"/spec-up-t-website/docs/category/content-authors-guide"}},l={},c=[{value:"Look up xrefs",id:"look-up-xrefs",level:4},{value:"Create index.html",id:"create-indexhtml",level:4},{value:"You are ready",id:"you-are-ready",level:4},{value:"View your specification",id:"view-your-specification",level:4},{value:"Three different modes",id:"three-different-modes",level:4},{value:"Automation",id:"automation",level:4}];function a(e){const n={a:"a",admonition:"admonition",code:"code",h1:"h1",h4:"h4",li:"li",p:"p",pre:"pre",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",ul:"ul",...(0,s.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"general-guide",children:"General Guide"}),"\n",(0,r.jsx)(n.p,{children:"These are general instructions."}),"\n",(0,r.jsx)(n.h4,{id:"look-up-xrefs",children:"Look up xrefs"}),"\n",(0,r.jsx)(n.p,{children:"Xrefs are [To Do: write explanation]"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{children:"npm run xrefs\n"})}),"\n",(0,r.jsx)(n.p,{children:"Now the references to external specs are generated, if any."}),"\n",(0,r.jsx)(n.h4,{id:"create-indexhtml",children:"Create index.html"}),"\n",(0,r.jsxs)(n.p,{children:["The final result will be just one file: ",(0,r.jsx)(n.code,{children:"index.html"}),". This file is rendered or rerendered with the following command:"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{children:"npm run render\n"})}),"\n",(0,r.jsxs)(n.p,{children:["Now an index.html file is created in the ",(0,r.jsx)(n.code,{children:"docs"})," directory. This is the default directory, specified in the ",(0,r.jsx)(n.code,{children:"specs.json"})," file."]}),"\n",(0,r.jsx)(n.h4,{id:"you-are-ready",children:"You are ready"}),"\n",(0,r.jsxs)(n.p,{children:["Now you have a basic Spec-Up-T specification file (",(0,r.jsx)(n.code,{children:"index.html"}),") with the following content:"]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:["a ",(0,r.jsx)(n.code,{children:"specs.json"})," file"]}),"\n",(0,r.jsxs)(n.li,{children:["a ",(0,r.jsx)(n.code,{children:"spec/"})," directory with a sample markdown files"]}),"\n",(0,r.jsxs)(n.li,{children:["a ",(0,r.jsx)(n.code,{children:"docs"})," directory with a sample index.html file"]}),"\n",(0,r.jsxs)(n.li,{children:["a ",(0,r.jsx)(n.code,{children:"node_modules"})," directory, a ",(0,r.jsx)(n.code,{children:"package.json"})," file and a ",(0,r.jsx)(n.code,{children:"package-lock.json"})," file (these three elements belong to the ",(0,r.jsx)(n.code,{children:"npm"})," system)"]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"view-your-specification",children:"View your specification"}),"\n",(0,r.jsxs)(n.p,{children:["So the ",(0,r.jsx)(n.code,{children:"index.html"})," is the endresult. You should view it in a browser. Er zijn twee manieren om dit te doen:"]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:["via ",(0,r.jsx)(n.code,{children:"http://"})]}),"\n",(0,r.jsxs)(n.li,{children:["via ",(0,r.jsx)(n.code,{children:"file:///"})]}),"\n"]}),"\n",(0,r.jsxs)(n.p,{children:["The simplest way to do so is via ",(0,r.jsx)(n.code,{children:"file:///"}),": go to the ",(0,r.jsx)(n.code,{children:"index.html"})," file with your Explorer, Finder or other file manager, and double-click on it. Usually it now opens in your browser."]}),"\n",(0,r.jsx)(n.p,{children:"If not, go to the browser, and try to open the file from the browser menu."}),"\n",(0,r.jsxs)(n.p,{children:["This way you open the ",(0,r.jsx)(n.code,{children:"index.html"})," file via the ",(0,r.jsx)(n.code,{children:"file protocol"})," (\u201c",(0,r.jsx)(n.code,{children:"file:///"}),"\u201d)."]}),"\n",(0,r.jsxs)(n.p,{children:["What you can also do is access it via ",(0,r.jsx)(n.code,{children:"HTTP"}),". You then need to place the ",(0,r.jsx)(n.code,{children:"index.html"})," file on a web server and access it through a browser using the url under which the file is accessible."]}),"\n",(0,r.jsx)(n.p,{children:"This way you can share it with the world by sharing the url."}),"\n",(0,r.jsx)(n.admonition,{type:"info",children:(0,r.jsx)(n.p,{children:"HTTP stands for HyperText Transfer Protocol. It is the foundation of any data exchange on the Web and it is a protocol used for transmitting hypertext requests and information on the internet. HTTP is used by the World Wide Web and defines how messages are formatted and transmitted, and how web servers and browsers should respond to various commands."})}),"\n",(0,r.jsx)(n.h4,{id:"three-different-modes",children:"Three different modes"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"npm run render"})," is not the only way to go. There are three different modes for rendering the specification:"]}),"\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:"command"}),(0,r.jsx)(n.th,{children:"behavior"})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"npm run edit"})}),(0,r.jsxs)(n.td,{children:["after rendering, this will stay running and the ",(0,r.jsx)(n.code,{children:"gulp"})," library will watch the source files in your spec directory/ies for changes and re-render any time you save a file. Opening these rendered files in a browser and refreshing them will keep you up to date."]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"npm run render"})}),(0,r.jsx)(n.td,{children:"this renders the site once and does not keep a gulpy watch on the underlying files."})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"npm run dev"})}),(0,r.jsx)(n.td,{children:"this enables debugging features."})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"automation",children:"Automation"}),"\n",(0,r.jsxs)(n.p,{children:["The above scripts can easily be triggered by ",(0,r.jsx)(n.a,{href:"../glossary#github-actions",children:"github actions"}),". See ",(0,r.jsx)(n.a,{href:"https://github.com/decentralized-identity/spec-up/blob/master/.github/workflows/render-specs.yml",children:"this repo's example"})]})]})}function h(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(a,{...e})}):a(e)}},8453:(e,n,i)=>{i.d(n,{R:()=>d,x:()=>o});var r=i(6540);const s={},t=r.createContext(s);function d(e){const n=r.useContext(t);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:d(e.components),r.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/e2c9a94b.afd75d60.js b/assets/js/e2c9a94b.afd75d60.js deleted file mode 100644 index ad8b33ad..00000000 --- a/assets/js/e2c9a94b.afd75d60.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkmy_website=self.webpackChunkmy_website||[]).push([[1070],{8294:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>r,default:()=>h,frontMatter:()=>o,metadata:()=>l,toc:()=>c});var i=s(4848),t=s(8453);const o={sidebar_position:2},r="Admins Guide",l={id:"various-roles/admins-guide",title:"Admins Guide",description:"This is the admin guide for the Spec-Up-T system.",source:"@site/docs/various-roles/admins-guide.md",sourceDirName:"various-roles",slug:"/various-roles/admins-guide",permalink:"/spec-up-t-website/docs/various-roles/admins-guide",draft:!1,unlisted:!1,editUrl:"https://github.com/blockchainbird/spec-up-t-website/tree/main/docs/various-roles/admins-guide.md",tags:[],version:"current",sidebarPosition:2,frontMatter:{sidebar_position:2},sidebar:"tutorialSidebar",previous:{title:"Intro",permalink:"/spec-up-t-website/docs/various-roles/intro"},next:{title:"Technical skills needed",permalink:"/spec-up-t-website/docs/various-roles/technical-skills-needed"}},d={},c=[{value:"Installation",id:"installation",level:2},{value:"Short video",id:"short-video",level:3},{value:"Getting Started",id:"getting-started",level:3},{value:"What you'll need",id:"what-youll-need",level:3},{value:"Install a new site",id:"install-a-new-site",level:3},{value:"General info",id:"general-info",level:4},{value:"Install a new Spec-Up-T site",id:"install-a-new-spec-up-t-site",level:4},{value:"Go into the directory",id:"go-into-the-directory",level:4},{value:"Install all dependencies",id:"install-all-dependencies",level:4},{value:"More info",id:"more-info",level:3},{value:"The specs.json file",id:"the-specsjson-file",level:4}];function a(e){const n={a:"a",code:"code",em:"em",h1:"h1",h2:"h2",h3:"h3",h4:"h4",li:"li",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,t.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"admins-guide",children:"Admins Guide"}),"\n",(0,i.jsx)(n.p,{children:"This is the admin guide for the Spec-Up-T system."}),"\n",(0,i.jsxs)(n.p,{children:["The repo can be found ",(0,i.jsx)(n.a,{href:"https://github.com/blockchainbird/spec-up-t",children:"here"})]}),"\n",(0,i.jsx)(n.h2,{id:"installation",children:"Installation"}),"\n",(0,i.jsx)(n.h3,{id:"short-video",children:"Short video"}),"\n",(0,i.jsxs)(n.p,{children:["Let's install ",(0,i.jsx)(n.strong,{children:"Spec-Up-T"}),". This short video shows the process."]}),"\n",(0,i.jsxs)("video",{controls:!0,children:[(0,i.jsx)("source",{src:s(6525).A,type:"video/mp4"}),(0,i.jsx)(n.p,{children:"Your browser does not support the video tag."})]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{target:"_blank","data-noBrokenLinkCheck":!0,href:s(8948).A+"",children:"Link to the video"})}),"\n",(0,i.jsx)(n.h3,{id:"getting-started",children:"Getting Started"}),"\n",(0,i.jsxs)(n.p,{children:["Now let's do it ourselves. Get started by ",(0,i.jsx)(n.strong,{children:"creating a new site"}),"."]}),"\n",(0,i.jsx)(n.h3,{id:"what-youll-need",children:"What you'll need"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.a,{href:"https://nodejs.org/en/download/",children:"Node.js"}),":","\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"When installing Node.js, you are recommended to check all checkboxes related to dependencies."}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["A ",(0,i.jsx)(n.a,{href:"https://en.wikipedia.org/wiki/Web_browser",children:"webbrowser"}),". You are probably reading this in a browser, so you already have one."]}),"\n"]}),"\n",(0,i.jsx)(n.h3,{id:"install-a-new-site",children:"Install a new site"}),"\n",(0,i.jsx)(n.h4,{id:"general-info",children:"General info"}),"\n",(0,i.jsx)(n.p,{children:"Installing Spec-Up-T works similarly to installing any other npm package. You install it locally (not globally) and then you run it."}),"\n",(0,i.jsx)(n.h4,{id:"install-a-new-spec-up-t-site",children:"Install a new Spec-Up-T site"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-bash",children:"npx create-spec-up-t my-spec-up-t-website\n"})}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.em,{children:"my-spec-up-t-website"})," can be anything you want it to be (however it is recommended to not use spaces or special characters in directory names)."]}),"\n",(0,i.jsx)(n.p,{children:"You can also omit the last part:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-bash",children:"npx create-spec-up-t\n"})}),"\n",(0,i.jsxs)(n.p,{children:["If you omit ",(0,i.jsx)(n.code,{children:"my-spec-up-t-website"})," a default directory name is used, namely ",(0,i.jsx)(n.code,{children:"spec-up-t-starterpack"}),"."]}),"\n",(0,i.jsx)(n.p,{children:"Sometimes you want to force the latest version to be installed. Then you can do the following:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-bash",children:"npx create-spec-up-t@latest my-spec-up-t-website\n"})}),"\n",(0,i.jsx)(n.p,{children:"You can type this command into Command Prompt, Powershell, Terminal, or any other integrated terminal of your code editor. It should work on any operating system (not tested yet)."}),"\n",(0,i.jsxs)(n.p,{children:["You should now have a directory called ",(0,i.jsx)(n.code,{children:"my-spec-up-t-website"})," (or ",(0,i.jsx)(n.code,{children:"spec-up-t-starterpack"})," if you did not specify a name)."]}),"\n",(0,i.jsx)(n.h4,{id:"go-into-the-directory",children:"Go into the directory"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"Go into this directory (folder) that was just created:"}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-bash",children:"cd my-spec-up-t-website\n"})}),"\n",(0,i.jsx)(n.p,{children:"You are now in this directory."}),"\n",(0,i.jsx)(n.h4,{id:"install-all-dependencies",children:"Install all dependencies"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"Install all dependencies:"}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:"npm run install\n"})}),"\n",(0,i.jsx)(n.p,{children:"It can take some time, and you should see multiple lines of output during installation."}),"\n",(0,i.jsx)(n.p,{children:"When the prompt is visible again, you should now have a basic Spec-Up-T install:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:["a ",(0,i.jsx)(n.code,{children:"specs.json"})," file"]}),"\n",(0,i.jsxs)(n.li,{children:["a ",(0,i.jsx)(n.code,{children:"spec/"})," directory with a sample markdown files"]}),"\n",(0,i.jsxs)(n.li,{children:["a ",(0,i.jsx)(n.code,{children:"node_modules"})," directory, a ",(0,i.jsx)(n.code,{children:"package.json"})," file and a ",(0,i.jsx)(n.code,{children:"package-lock.json"})," file (these three elements belong to the ",(0,i.jsx)(n.code,{children:"npm"})," system)"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"What you don't have yet is the following:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:["a ",(0,i.jsx)(n.code,{children:"docs"})," directory with a sample ",(0,i.jsx)(n.code,{children:"index.html"})," file (which is the actual specification file that is the goal of it all)."]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["How to do this, go to the ",(0,i.jsx)(n.a,{href:"/spec-up-t-website/docs/various-roles/general-guide",children:"General Instructions"}),"."]}),"\n",(0,i.jsx)(n.h3,{id:"more-info",children:"More info"}),"\n",(0,i.jsxs)(n.h4,{id:"the-specsjson-file",children:["The ",(0,i.jsx)(n.code,{children:"specs.json"})," file"]}),"\n",(0,i.jsxs)(n.p,{children:["The",(0,i.jsx)(n.code,{children:"specs.json"})," file ",(0,i.jsx)(n.strong,{children:"in the root folder of your repository"})," specifies configuration values used in the generation of your spec documents. The values in your ",(0,i.jsx)(n.code,{children:"specs.json"})," file include things like where your spec's markdown files are located, where to output the generated spec document, and various metadata values used in rendering, such as the title, logo, and repo links for each of your specs. The following are the required/optional fields supported in the ",(0,i.jsx)(n.code,{children:"specs.json"})," config file:"]}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"public_root"})})," ",(0,i.jsx)(n.em,{children:"(PATH STRING, optional)"})," - For some platforms and services where you may want to output your rendered spec, the pathing may differ from the directory structure of your local project. To account for this, you can use the ",(0,i.jsx)(n.code,{children:"public_root"})," property to specify the insertion of a path segment to account for the different in pathing between your local renders and wherever you publish your spec to."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"specs"})})," ",(0,i.jsx)(n.em,{children:"(ARRAY, required)"})," - the ",(0,i.jsx)(n.code,{children:"specs"})," array contains descriptor objects for each of the specs you are generating in your project, and are composed of the following required and optional properties:","\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"spec_directory"})})," ",(0,i.jsx)(n.em,{children:"(STRING, required)"})," - You must specify the ",(0,i.jsx)(n.strong,{children:"repo-root-relative"})," location of your spec's markdown file directory. You ",(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.strong,{children:"MUST"})})," name your spec's markdown file ",(0,i.jsx)(n.code,{children:"spec.md"})," and locate it in your ",(0,i.jsx)(n.code,{children:"spec_directory"})," for the tool to automatically find and use it for rendering. If you want to use a different name for the markdown file, or you have multiple markdown files you would like the tool to assemble into one document, you must specify them using the optional",(0,i.jsx)(n.code,{children:"markdown_paths"}),' field described below. See the "multi-file" example in the spec-up repo.']}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"title"})})," ",(0,i.jsx)(n.em,{children:"(STRING, required)"})," - You must add a title for your spec, which will be rendered in the generated document's H1 text and page title."]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"logo"})})," ",(0,i.jsx)(n.em,{children:"(PATH/URI STRING, optional)"})," - You may add a reference to a logo asset, either via a path to the asset or a URI"]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"logo_link"})})," ",(0,i.jsx)(n.em,{children:"(URI STRING, optional)"})," - The URI you want your logo to point to in the rendered page."]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"markdown_paths"})})," ",(0,i.jsx)(n.em,{children:"(ARRAY, optional)"})," - If you want to name your spec's markdown file something other than ",(0,i.jsx)(n.code,{children:"spec.md"}),", or you have multiple files you would like assembled into a single output document, you must specify their paths as array entries in the order you would like them assembled. The paths in this array are assumed to be based on the ",(0,i.jsx)(n.code,{children:"spec_directory"})," you specified, so ",(0,i.jsx)(n.em,{children:"DO NOT"})," repeat the full root relative path."]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"katex"})})," ",(0,i.jsx)(n.em,{children:"(BOOLEAN, optional)"})," - To enable TeX support via KaTeX, set this property to ",(0,i.jsx)(n.code,{children:"true"}),". After rendering, be sure to copy the ",(0,i.jsx)(n.code,{children:"fonts/"})," subdirectory, containing the necessary web fonts."]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"output_path"})})," ",(0,i.jsx)(n.em,{children:"(STRING, optional)"})," - If you want the generated spec document to be output to a different location than the ",(0,i.jsx)(n.code,{children:"spec_directory"})," you specified (e.g. the project root for GitHub Pages publishing) you can specify another root relative path (use ",(0,i.jsx)(n.code,{children:"./"})," for root), and the tool will write the document file there instead."]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"source"})})," ",(0,i.jsx)(n.em,{children:"(OBJECT, optional)"})," - this object allows you to configure where repo-specific data is pulled from to power some of the more advanced repo-related features. To do this, specify the code hosting service by adding a service ID string to ",(0,i.jsx)(n.code,{children:"host"})," (currently Spec-Up only supports ",(0,i.jsx)(n.code,{children:'"github"'}),", but this is extensible), add the account/org the repo is located within via the ",(0,i.jsx)(n.code,{children:"account"})," property, and add the repo name under the ",(0,i.jsx)(n.code,{children:"repo"})," property. Here is an example configuration:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "host": "github",\n "account": "decentralized-identity",\n "repo": "sidetree"\n}\n'})}),"\n"]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"You're ready to start rendering specs as HTML sites locally and/or pushing them to github pages however you see fit to automate."})]})}function h(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(a,{...e})}):a(e)}},8948:(e,n,s)=>{s.d(n,{A:()=>i});const i=s.p+"assets/files/installer-spec-up-t-392cc74350811a36e6a9f89b426fa51b.mp4"},6525:(e,n,s)=>{s.d(n,{A:()=>i});const i=s.p+"assets/medias/installer-spec-up-t-392cc74350811a36e6a9f89b426fa51b.mp4"},8453:(e,n,s)=>{s.d(n,{R:()=>r,x:()=>l});var i=s(6540);const t={},o=i.createContext(t);function r(e){const n=i.useContext(o);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:r(e.components),i.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/e2c9a94b.ff55a273.js b/assets/js/e2c9a94b.ff55a273.js new file mode 100644 index 00000000..7985d0b5 --- /dev/null +++ b/assets/js/e2c9a94b.ff55a273.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkmy_website=self.webpackChunkmy_website||[]).push([[1070],{8294:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>r,default:()=>h,frontMatter:()=>t,metadata:()=>l,toc:()=>c});var i=s(4848),o=s(8453);const t={sidebar_position:2},r="Admins Guide",l={id:"various-roles/admins-guide",title:"Admins Guide",description:"This is the admin guide for the Spec-Up-T system.",source:"@site/docs/various-roles/admins-guide.md",sourceDirName:"various-roles",slug:"/various-roles/admins-guide",permalink:"/spec-up-t-website/docs/various-roles/admins-guide",draft:!1,unlisted:!1,editUrl:"https://github.com/blockchainbird/spec-up-t-website/tree/main/docs/various-roles/admins-guide.md",tags:[],version:"current",sidebarPosition:2,frontMatter:{sidebar_position:2},sidebar:"tutorialSidebar",previous:{title:"Intro",permalink:"/spec-up-t-website/docs/various-roles/intro"},next:{title:"Technical skills needed",permalink:"/spec-up-t-website/docs/various-roles/technical-skills-needed"}},d={},c=[{value:"Installation",id:"installation",level:2},{value:"Short video",id:"short-video",level:3},{value:"Getting Started",id:"getting-started",level:3},{value:"What you'll need",id:"what-youll-need",level:3},{value:"Install a new site",id:"install-a-new-site",level:3},{value:"General info",id:"general-info",level:4},{value:"Install a new Spec-Up-T site",id:"install-a-new-spec-up-t-site",level:4},{value:"Go into the directory",id:"go-into-the-directory",level:4},{value:"Install all dependencies",id:"install-all-dependencies",level:4},{value:"More info",id:"more-info",level:3},{value:"The specs.json file",id:"the-specsjson-file",level:4}];function a(e){const n={a:"a",code:"code",em:"em",h1:"h1",h2:"h2",h3:"h3",h4:"h4",li:"li",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,o.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"admins-guide",children:"Admins Guide"}),"\n",(0,i.jsx)(n.p,{children:"This is the admin guide for the Spec-Up-T system."}),"\n",(0,i.jsxs)(n.p,{children:["The repo can be found ",(0,i.jsx)(n.a,{href:"https://github.com/blockchainbird/spec-up-t",children:"here"})]}),"\n",(0,i.jsx)(n.h2,{id:"installation",children:"Installation"}),"\n",(0,i.jsx)(n.h3,{id:"short-video",children:"Short video"}),"\n",(0,i.jsxs)(n.p,{children:["Let's install ",(0,i.jsx)(n.strong,{children:"Spec-Up-T"}),". This short video shows the process."]}),"\n",(0,i.jsxs)("video",{controls:!0,children:[(0,i.jsx)("source",{src:s(6525).A,type:"video/mp4"}),(0,i.jsx)(n.p,{children:"Your browser does not support video tags."})]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{target:"_blank","data-noBrokenLinkCheck":!0,href:s(8948).A+"",children:"Link to the video"})}),"\n",(0,i.jsx)(n.h3,{id:"getting-started",children:"Getting Started"}),"\n",(0,i.jsxs)(n.p,{children:["Now, let's do it ourselves. Get started by ",(0,i.jsx)(n.strong,{children:"creating a new site"}),"."]}),"\n",(0,i.jsx)(n.h3,{id:"what-youll-need",children:"What you'll need"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.a,{href:"https://nodejs.org/en/download/",children:"Node.js"}),":","\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"When installing Node.js, you are recommended to check all checkboxes related to dependencies."}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["A ",(0,i.jsx)(n.a,{href:"https://en.wikipedia.org/wiki/Web_browser",children:"webbrowser"}),". You are probably reading this in a browser, so you already have one."]}),"\n"]}),"\n",(0,i.jsx)(n.h3,{id:"install-a-new-site",children:"Install a new site"}),"\n",(0,i.jsx)(n.h4,{id:"general-info",children:"General info"}),"\n",(0,i.jsx)(n.p,{children:"Installing Spec-Up-T works similarly to installing any other npm package. You install it locally (not globally), and then you run it."}),"\n",(0,i.jsx)(n.h4,{id:"install-a-new-spec-up-t-site",children:"Install a new Spec-Up-T site"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-bash",children:"npx create-spec-up-t my-spec-up-t-website\n"})}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.em,{children:"my-spec-up-t-website"})," can be anything you want it to be (however, it is recommended to not use spaces or special characters in directory names)."]}),"\n",(0,i.jsx)(n.p,{children:"You can also omit the last part:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-bash",children:"npx create-spec-up-t\n"})}),"\n",(0,i.jsxs)(n.p,{children:["If you omit ",(0,i.jsx)(n.code,{children:"my-spec-up-t-website"}),", a default directory name, namely ",(0,i.jsx)(n.code,{children:"spec-up-t-starterpack,"})," is used."]}),"\n",(0,i.jsx)(n.p,{children:"Sometimes, you want to force the latest version to be installed. Then you can do the following:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-bash",children:"npx create-spec-up-t@latest my-spec-up-t-website\n"})}),"\n",(0,i.jsx)(n.p,{children:"You can type this command into Command Prompt, Powershell, Terminal, or any other integrated terminal of your code editor. It should work on any operating system (not tested yet)."}),"\n",(0,i.jsxs)(n.p,{children:["You should now have a directory called ",(0,i.jsx)(n.code,{children:"my-spec-up-t-website"})," (or ",(0,i.jsx)(n.code,{children:"spec-up-t-starterpack"})," if you did not specify a name)."]}),"\n",(0,i.jsx)(n.h4,{id:"go-into-the-directory",children:"Go into the directory"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"Go into this directory (folder) that was just created:"}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-bash",children:"cd my-spec-up-t-website\n"})}),"\n",(0,i.jsx)(n.p,{children:"You are now in this directory."}),"\n",(0,i.jsx)(n.h4,{id:"install-all-dependencies",children:"Install all dependencies"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"Install all dependencies:"}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:"npm run install\n"})}),"\n",(0,i.jsx)(n.p,{children:"It can take some time, and you should see multiple lines of output during installation."}),"\n",(0,i.jsx)(n.p,{children:"When the prompt is visible again, you should now have a basic Spec-Up-T install:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:["a ",(0,i.jsx)(n.code,{children:"specs.json"})," file"]}),"\n",(0,i.jsxs)(n.li,{children:["a ",(0,i.jsx)(n.code,{children:"spec/"})," directory with sample markdown files"]}),"\n",(0,i.jsxs)(n.li,{children:["a ",(0,i.jsx)(n.code,{children:"node_modules"})," directory, a ",(0,i.jsx)(n.code,{children:"package.json"})," file, and a ",(0,i.jsx)(n.code,{children:"package-lock.json"})," file (these three elements belong to the ",(0,i.jsx)(n.code,{children:"npm"})," system)"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"What you don't have yet is the following:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:["a ",(0,i.jsx)(n.code,{children:"docs"})," directory with a sample ",(0,i.jsx)(n.code,{children:"index.html"})," file (which is the actual specification file that is the goal of it all)."]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["How to do this, go to the ",(0,i.jsx)(n.a,{href:"/spec-up-t-website/docs/various-roles/general-guide",children:"General Instructions"}),"."]}),"\n",(0,i.jsx)(n.h3,{id:"more-info",children:"More info"}),"\n",(0,i.jsxs)(n.h4,{id:"the-specsjson-file",children:["The ",(0,i.jsx)(n.code,{children:"specs.json"})," file"]}),"\n",(0,i.jsxs)(n.p,{children:["The",(0,i.jsx)(n.code,{children:"specs.json"})," file ",(0,i.jsx)(n.strong,{children:"in the root folder of your repository"})," specifies configuration values used in the generation of your spec documents. The values in your ",(0,i.jsx)(n.code,{children:"specs.json"})," file include things like where your spec's markdown files are located, where to output the generated spec document, and various metadata values used in rendering, such as the title, logo, and repo links for each of your specs. The following are the required/optional fields supported in the ",(0,i.jsx)(n.code,{children:"specs.json"})," config file:"]}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"public_root"})})," ",(0,i.jsx)(n.em,{children:"(PATH STRING, optional)"})," - For some platforms and services where you may want to output your rendered spec, the pathing may differ from the directory structure of your local project. To account for this, you can use the ",(0,i.jsx)(n.code,{children:"public_root"})," property to specify the insertion of a path segment to account for the difference in pathing between your local renders and wherever you publish your spec."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"specs"})})," ",(0,i.jsx)(n.em,{children:"(ARRAY, required)"})," - the ",(0,i.jsx)(n.code,{children:"specs"})," array contains descriptor objects for each of the specs you are generating in your project and are composed of the following required and optional properties:"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"spec_directory"})})," ",(0,i.jsx)(n.em,{children:"(STRING, required)"})," - You must specify the ",(0,i.jsx)(n.strong,{children:"repo-root-relative"})," location of your spec's markdown file directory. You ",(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.strong,{children:"MUST"})})," name your spec's markdown file ",(0,i.jsx)(n.code,{children:"spec.md"})," and locate it in your ",(0,i.jsx)(n.code,{children:"spec_directory"})," so the tool can automatically find and use it for rendering. If you want to use a different name for the markdown file, or you have multiple markdown files you would like the tool to assemble into one document, you must specify them using the optional",(0,i.jsx)(n.code,{children:"markdown_paths"}),' field described below. See the "multi-file" example in the spec-up repo.']}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"title"})})," ",(0,i.jsx)(n.em,{children:"(STRING, required)"})," - You must add a title for your spec, which will be rendered in the generated document's H1 text and page title."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"logo"})})," ",(0,i.jsx)(n.em,{children:"(PATH/URI STRING, optional)"})," - You may add a reference to a logo asset, either via a path to the asset or a URI"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"logo_link"})})," ",(0,i.jsx)(n.em,{children:"(URI STRING, optional)"})," - The URI you want your logo to point to on the rendered page."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"markdown_paths"})})," ",(0,i.jsx)(n.em,{children:"(ARRAY, optional)"})," - If you want to name your spec's markdown file something other than ",(0,i.jsx)(n.code,{children:"spec.md"}),", or you have multiple files you would like assembled into a single output document, you must specify their paths as array entries in the order you would like them assembled. The paths in this array are assumed to be based on the ",(0,i.jsx)(n.code,{children:"spec_directory"})," you specified, so ",(0,i.jsx)(n.em,{children:"DO NOT"})," repeat the full root relative path."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"katex"})})," ",(0,i.jsx)(n.em,{children:"(BOOLEAN, optional)"})," - To enable TeX support via KaTeX, set this property to ",(0,i.jsx)(n.code,{children:"true"}),". After rendering, be sure to copy the ",(0,i.jsx)(n.code,{children:"fonts/"})," subdirectory containing the necessary web fonts."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"output_path"})})," ",(0,i.jsx)(n.em,{children:"(STRING, optional)"})," - If you want the generated spec document to be output to a different location than the ",(0,i.jsx)(n.code,{children:"spec_directory"})," you specified (e.g. the project root for GitHub Pages publishing), you can specify another root relative path (use ",(0,i.jsx)(n.code,{children:"./"})," for root), and the tool will write the document file there instead."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"source"})})," ",(0,i.jsx)(n.em,{children:"(OBJECT, optional)"})," - this object allows you to configure where repo-specific data is pulled from to power some of the more advanced repo-related features. To do this, specify the code hosting service by adding a service ID string to ",(0,i.jsx)(n.code,{children:"host"})," (currently Spec-Up only supports ",(0,i.jsx)(n.code,{children:'"github"'}),", but this is extensible), add the account/org the repo is located within via the ",(0,i.jsx)(n.code,{children:"account"})," property, and add the repo name under the ",(0,i.jsx)(n.code,{children:"repo"})," property. Here is an example configuration:"]}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n"host": "github",\n"account": "decentralized-identity",\n"repo": "sidetree"\n}\n'})}),"\n",(0,i.jsx)(n.p,{children:"You're ready to start rendering specs as HTML sites locally and/or pushing them to github pages however you see fit to automate."})]})}function h(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(a,{...e})}):a(e)}},8948:(e,n,s)=>{s.d(n,{A:()=>i});const i=s.p+"assets/files/installer-spec-up-t-392cc74350811a36e6a9f89b426fa51b.mp4"},6525:(e,n,s)=>{s.d(n,{A:()=>i});const i=s.p+"assets/medias/installer-spec-up-t-392cc74350811a36e6a9f89b426fa51b.mp4"},8453:(e,n,s)=>{s.d(n,{R:()=>r,x:()=>l});var i=s(6540);const o={},t=i.createContext(o);function r(e){const n=i.useContext(t);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:r(e.components),i.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/f049f840.79e434da.js b/assets/js/f049f840.79e434da.js new file mode 100644 index 00000000..31123bbc --- /dev/null +++ b/assets/js/f049f840.79e434da.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkmy_website=self.webpackChunkmy_website||[]).push([[6418],{483:e=>{e.exports=JSON.parse('{"version":{"pluginId":"default","version":"current","label":"Next","banner":null,"badge":false,"noIndex":false,"className":"docs-version-current","isLast":true,"docsSidebars":{"tutorialSidebar":[{"type":"link","label":"Introduction","href":"/spec-up-t-website/docs/intro","docId":"intro","unlisted":false},{"type":"category","label":"Roles","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Intro","href":"/spec-up-t-website/docs/various-roles/intro","docId":"various-roles/intro","unlisted":false},{"type":"link","label":"Admins Guide","href":"/spec-up-t-website/docs/various-roles/admins-guide","docId":"various-roles/admins-guide","unlisted":false},{"type":"link","label":"Technical skills needed","href":"/spec-up-t-website/docs/various-roles/technical-skills-needed","docId":"various-roles/technical-skills-needed","unlisted":false},{"type":"link","label":"General Guide","href":"/spec-up-t-website/docs/various-roles/general-guide","docId":"various-roles/general-guide","unlisted":false},{"type":"category","label":"Content Authors Guide","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Content Authors Guide","href":"/spec-up-t-website/docs/various-roles/content-authors-guide/introduction","docId":"various-roles/content-authors-guide/introduction","unlisted":false}],"href":"/spec-up-t-website/docs/category/content-authors-guide"},{"type":"category","label":"Terminology Author Guide","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Terminology Authors Guide","href":"/spec-up-t-website/docs/various-roles/terminology-authors-guide/introduction","docId":"various-roles/terminology-authors-guide/introduction","unlisted":false},{"type":"link","label":"Term References","href":"/spec-up-t-website/docs/various-roles/terminology-authors-guide/term-references","docId":"various-roles/terminology-authors-guide/term-references","unlisted":false},{"type":"link","label":"External Term References","href":"/spec-up-t-website/docs/various-roles/terminology-authors-guide/external-term-references","docId":"various-roles/terminology-authors-guide/external-term-references","unlisted":false}],"href":"/spec-up-t-website/docs/category/terminology-author-guide"},{"type":"category","label":"Curators Guide","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"introduction","href":"/spec-up-t-website/docs/various-roles/curators-guide/introduction","docId":"various-roles/curators-guide/introduction","unlisted":false}],"href":"/spec-up-t-website/docs/category/curators-guide"},{"type":"category","label":"Glossary Maintainers Guide","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Glossary Maintainers Guide","href":"/spec-up-t-website/docs/various-roles/glossary-maintainers-guide/introduction","docId":"various-roles/glossary-maintainers-guide/introduction","unlisted":false}],"href":"/spec-up-t-website/docs/category/glossary-maintainers-guide"},{"type":"category","label":"Readers Guide","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Readers Guide","href":"/spec-up-t-website/docs/various-roles/readers-guide/introduction","docId":"various-roles/readers-guide/introduction","unlisted":false}],"href":"/spec-up-t-website/docs/category/readers-guide"},{"type":"link","label":"Developers Guide","href":"/spec-up-t-website/docs/various-roles/developers-guide","docId":"various-roles/developers-guide","unlisted":false}],"href":"/spec-up-t-website/docs/category/roles"},{"type":"link","label":"Spec-Up-T demo","href":"/spec-up-t-website/docs/spec-up-t-demo-site","docId":"spec-up-t-demo-site","unlisted":false},{"type":"link","label":"How it came to be","href":"/spec-up-t-website/docs/how-it-came-to-be","docId":"how-it-came-to-be","unlisted":false},{"type":"link","label":"Q & A","href":"/spec-up-t-website/docs/q-and-a","docId":"q-and-a","unlisted":false},{"type":"link","label":"Maintaining this site","href":"/spec-up-t-website/docs/this-site-maintainers","docId":"this-site-maintainers","unlisted":false},{"type":"link","label":"Glossary","href":"/spec-up-t-website/docs/glossary","docId":"glossary","unlisted":false},{"type":"link","label":"Troubleshooting","href":"/spec-up-t-website/docs/troubleshooting","docId":"troubleshooting","unlisted":false}]},"docs":{"glossary":{"id":"glossary","title":"Glossary","description":"This is a glossary with some terms that you need to know in order to understand working with Spec-Up-T.","sidebar":"tutorialSidebar"},"how-it-came-to-be":{"id":"how-it-came-to-be","title":"How it came to be","description":"The ToIP Terms extension of Spec-Up","sidebar":"tutorialSidebar"},"intro":{"id":"intro","title":"Introduction","description":"Intro","sidebar":"tutorialSidebar"},"q-and-a":{"id":"q-and-a","title":"Q & A","description":"Questions and answers about Spec-Up-T.","sidebar":"tutorialSidebar"},"spec-up-t-demo-site":{"id":"spec-up-t-demo-site","title":"Spec-Up-T demo","description":"The Demo","sidebar":"tutorialSidebar"},"this-site-maintainers":{"id":"this-site-maintainers","title":"Maintaining this site","description":"Here you will find information about things specific to this site.","sidebar":"tutorialSidebar"},"troubleshooting":{"id":"troubleshooting","title":"Troubleshooting","description":"Some tips in case of problems:","sidebar":"tutorialSidebar"},"various-roles/admins-guide":{"id":"various-roles/admins-guide","title":"Admins Guide","description":"This is the admin guide for the Spec-Up-T system.","sidebar":"tutorialSidebar"},"various-roles/content-authors-guide/introduction":{"id":"various-roles/content-authors-guide/introduction","title":"Content Authors Guide","description":"Uses: an IDE, git and a browser extension, to edit Spec-Up markdown files for his/her specific context (mental model) in a version managed environment, authenticated, to write the concept and specification and offer this as a PR.","sidebar":"tutorialSidebar"},"various-roles/curators-guide/introduction":{"id":"various-roles/curators-guide/introduction","title":"introduction","description":"---","sidebar":"tutorialSidebar"},"various-roles/developers-guide":{"id":"various-roles/developers-guide","title":"Developers Guide","description":"This is the developers guide for the Spec-Up-T system.","sidebar":"tutorialSidebar"},"various-roles/general-guide":{"id":"various-roles/general-guide","title":"General Guide","description":"These are general instructions for every role involved.","sidebar":"tutorialSidebar"},"various-roles/glossary-maintainers-guide/introduction":{"id":"various-roles/glossary-maintainers-guide/introduction","title":"Glossary Maintainers Guide","description":"Uses: Source management tool.","sidebar":"tutorialSidebar"},"various-roles/intro":{"id":"various-roles/intro","title":"Intro","description":"Spec-Up-T implementations can distinguish the following roles:","sidebar":"tutorialSidebar"},"various-roles/readers-guide/introduction":{"id":"various-roles/readers-guide/introduction","title":"Readers Guide","description":"Uses github.io website, reads concepts in text and terminology in glossaries, (for example generated by Spec-Up) with its own tailor-made contextual glossary that generates pop-ups here and there in the text offered.","sidebar":"tutorialSidebar"},"various-roles/technical-skills-needed":{"id":"various-roles/technical-skills-needed","title":"Technical skills needed","description":"Spec-Up-T is a specialized tool designed to facilitate the creation, management, and rendering of technical specifications in a streamlined manner. Users who intend to leverage Spec-Up-T for their projects must possess a foundational level of technical knowledge to navigate the installation, configuration, and utilization of this tool effectively. This article delves into the technical prerequisites necessary for a user to operate Spec-Up-T competently.","sidebar":"tutorialSidebar"},"various-roles/terminology-authors-guide/external-term-references":{"id":"various-roles/terminology-authors-guide/external-term-references","title":"External Term References","description":"It is possible to include references to terms from external spec-up generated specifications. To include a source you would like to pull references from include an external_specs array in your spec config. The value should be a key/value object where the key is used in the external reference below and the value is the URL of the external spec.","sidebar":"tutorialSidebar"},"various-roles/terminology-authors-guide/introduction":{"id":"various-roles/terminology-authors-guide/introduction","title":"Terminology Authors Guide","description":"Focusses on term definitions covering concepts of the group he/she belongs to.","sidebar":"tutorialSidebar"},"various-roles/terminology-authors-guide/term-references":{"id":"various-roles/terminology-authors-guide/term-references","title":"Term References","description":"Definition Lists","sidebar":"tutorialSidebar"}}}}')}}]); \ No newline at end of file diff --git a/assets/js/f049f840.7af0889a.js b/assets/js/f049f840.7af0889a.js deleted file mode 100644 index 734bd294..00000000 --- a/assets/js/f049f840.7af0889a.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkmy_website=self.webpackChunkmy_website||[]).push([[6418],{483:e=>{e.exports=JSON.parse('{"version":{"pluginId":"default","version":"current","label":"Next","banner":null,"badge":false,"noIndex":false,"className":"docs-version-current","isLast":true,"docsSidebars":{"tutorialSidebar":[{"type":"link","label":"Introduction","href":"/spec-up-t-website/docs/intro","docId":"intro","unlisted":false},{"type":"category","label":"Roles","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Intro","href":"/spec-up-t-website/docs/various-roles/intro","docId":"various-roles/intro","unlisted":false},{"type":"link","label":"Admins Guide","href":"/spec-up-t-website/docs/various-roles/admins-guide","docId":"various-roles/admins-guide","unlisted":false},{"type":"link","label":"Technical skills needed","href":"/spec-up-t-website/docs/various-roles/technical-skills-needed","docId":"various-roles/technical-skills-needed","unlisted":false},{"type":"link","label":"General Guide","href":"/spec-up-t-website/docs/various-roles/general-guide","docId":"various-roles/general-guide","unlisted":false},{"type":"category","label":"Content Authors Guide","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Content Authors Guide","href":"/spec-up-t-website/docs/various-roles/content-authors-guide/introduction","docId":"various-roles/content-authors-guide/introduction","unlisted":false}],"href":"/spec-up-t-website/docs/category/content-authors-guide"},{"type":"category","label":"Terminology Author Guide","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Terminology Authors Guide","href":"/spec-up-t-website/docs/various-roles/terminology-authors-guide/introduction","docId":"various-roles/terminology-authors-guide/introduction","unlisted":false},{"type":"link","label":"Term References","href":"/spec-up-t-website/docs/various-roles/terminology-authors-guide/term-references","docId":"various-roles/terminology-authors-guide/term-references","unlisted":false},{"type":"link","label":"External Term References","href":"/spec-up-t-website/docs/various-roles/terminology-authors-guide/external-term-references","docId":"various-roles/terminology-authors-guide/external-term-references","unlisted":false}],"href":"/spec-up-t-website/docs/category/terminology-author-guide"},{"type":"category","label":"Curators Guide","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Curators Guide","href":"/spec-up-t-website/docs/various-roles/curators-guide/introduction","docId":"various-roles/curators-guide/introduction","unlisted":false}],"href":"/spec-up-t-website/docs/category/curators-guide"},{"type":"category","label":"Glossary Maintainers Guide","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Glossary Maintainers Guide","href":"/spec-up-t-website/docs/various-roles/glossary-maintainers-guide/introduction","docId":"various-roles/glossary-maintainers-guide/introduction","unlisted":false}],"href":"/spec-up-t-website/docs/category/glossary-maintainers-guide"},{"type":"category","label":"Readers Guide","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Readers Guide","href":"/spec-up-t-website/docs/various-roles/readers-guide/introduction","docId":"various-roles/readers-guide/introduction","unlisted":false}],"href":"/spec-up-t-website/docs/category/readers-guide"},{"type":"link","label":"Developers Guide","href":"/spec-up-t-website/docs/various-roles/developers-guide","docId":"various-roles/developers-guide","unlisted":false}],"href":"/spec-up-t-website/docs/category/roles"},{"type":"link","label":"Spec-Up-T demo","href":"/spec-up-t-website/docs/spec-up-t-demo-site","docId":"spec-up-t-demo-site","unlisted":false},{"type":"link","label":"How it came to be","href":"/spec-up-t-website/docs/how-it-came-to-be","docId":"how-it-came-to-be","unlisted":false},{"type":"link","label":"Q & A","href":"/spec-up-t-website/docs/q-and-a","docId":"q-and-a","unlisted":false},{"type":"link","label":"Maintaining this site","href":"/spec-up-t-website/docs/this-site-maintainers","docId":"this-site-maintainers","unlisted":false},{"type":"link","label":"Glossary","href":"/spec-up-t-website/docs/glossary","docId":"glossary","unlisted":false},{"type":"link","label":"Troubleshooting","href":"/spec-up-t-website/docs/troubleshooting","docId":"troubleshooting","unlisted":false}]},"docs":{"glossary":{"id":"glossary","title":"Glossary","description":"This is a glossary with some terms that you need to know in order to understand working with Spec-Up-T.","sidebar":"tutorialSidebar"},"how-it-came-to-be":{"id":"how-it-came-to-be","title":"How it came to be","description":"The ToIP Terms extension of Spec-Up","sidebar":"tutorialSidebar"},"intro":{"id":"intro","title":"Introduction","description":"Intro","sidebar":"tutorialSidebar"},"q-and-a":{"id":"q-and-a","title":"Q & A","description":"Questions and answers about Spec-Up-T.","sidebar":"tutorialSidebar"},"spec-up-t-demo-site":{"id":"spec-up-t-demo-site","title":"Spec-Up-T demo","description":"The Demo","sidebar":"tutorialSidebar"},"this-site-maintainers":{"id":"this-site-maintainers","title":"Maintaining this site","description":"Here you will find information about things specific to this site.","sidebar":"tutorialSidebar"},"troubleshooting":{"id":"troubleshooting","title":"Troubleshooting","description":"Some tips in case of problems:","sidebar":"tutorialSidebar"},"various-roles/admins-guide":{"id":"various-roles/admins-guide","title":"Admins Guide","description":"This is the admin guide for the Spec-Up-T system.","sidebar":"tutorialSidebar"},"various-roles/content-authors-guide/introduction":{"id":"various-roles/content-authors-guide/introduction","title":"Content Authors Guide","description":"Uses: an IDE, git and a browser extension, to edit Spec-Up markdown files for his/her specific context (mental model) in a version managed environment, authenticated, to write the concept and specification and offer this as a PR.","sidebar":"tutorialSidebar"},"various-roles/curators-guide/introduction":{"id":"various-roles/curators-guide/introduction","title":"Curators Guide","description":"Uses an IDE and git and browser extensions, to check logical consistency & meaning of term definition in a certain context.","sidebar":"tutorialSidebar"},"various-roles/developers-guide":{"id":"various-roles/developers-guide","title":"Developers Guide","description":"This is the developers guide for the Spec-Up-T system.","sidebar":"tutorialSidebar"},"various-roles/general-guide":{"id":"various-roles/general-guide","title":"General Guide","description":"These are general instructions.","sidebar":"tutorialSidebar"},"various-roles/glossary-maintainers-guide/introduction":{"id":"various-roles/glossary-maintainers-guide/introduction","title":"Glossary Maintainers Guide","description":"Uses: Source management tool.","sidebar":"tutorialSidebar"},"various-roles/intro":{"id":"various-roles/intro","title":"Intro","description":"The following roles can be distinguished:","sidebar":"tutorialSidebar"},"various-roles/readers-guide/introduction":{"id":"various-roles/readers-guide/introduction","title":"Readers Guide","description":"Uses github.io website, reads concepts in text and terminology in glossaries, (for example generated by Spec-Up) with its own tailor-made contextual glossary that generates pop-ups here and there in the text offered.","sidebar":"tutorialSidebar"},"various-roles/technical-skills-needed":{"id":"various-roles/technical-skills-needed","title":"Technical skills needed","description":"Spec-Up-T is a specialized tool designed to facilitate the creation, management, and rendering of technical specifications in a streamlined manner. Users who intend to leverage Spec-Up-T for their projects must possess a foundational level of technical knowledge to navigate the installation, configuration, and utilization of this tool effectively. This article delves into the technical prerequisites necessary for a user to operate Spec-Up-T competently.","sidebar":"tutorialSidebar"},"various-roles/terminology-authors-guide/external-term-references":{"id":"various-roles/terminology-authors-guide/external-term-references","title":"External Term References","description":"It is possible to include references to terms from external spec-up generated specifications. To include a source you would like to pull references from include an external_specs array in your spec config. The value should be a key/value object where the key is used in the external reference below and the value is the URL of the external spec.","sidebar":"tutorialSidebar"},"various-roles/terminology-authors-guide/introduction":{"id":"various-roles/terminology-authors-guide/introduction","title":"Terminology Authors Guide","description":"Focusses on term definitions covering concepts of the group he/she belongs to.","sidebar":"tutorialSidebar"},"various-roles/terminology-authors-guide/term-references":{"id":"various-roles/terminology-authors-guide/term-references","title":"Term References","description":"Definition Lists","sidebar":"tutorialSidebar"}}}}')}}]); \ No newline at end of file diff --git a/assets/js/runtime~main.6eb5d3dc.js b/assets/js/runtime~main.f7818cd5.js similarity index 62% rename from assets/js/runtime~main.6eb5d3dc.js rename to assets/js/runtime~main.f7818cd5.js index e13ce657..d5f7cdd7 100644 --- a/assets/js/runtime~main.6eb5d3dc.js +++ b/assets/js/runtime~main.f7818cd5.js @@ -1 +1 @@ -(()=>{"use strict";var e,a,t,r,f,c={},d={};function o(e){var a=d[e];if(void 0!==a)return a.exports;var t=d[e]={id:e,loaded:!1,exports:{}};return c[e].call(t.exports,t,t.exports,o),t.loaded=!0,t.exports}o.m=c,o.c=d,e=[],o.O=(a,t,r,f)=>{if(!t){var c=1/0;for(i=0;i=f)&&Object.keys(o.O).every((e=>o.O[e](t[n])))?t.splice(n--,1):(d=!1,f0&&e[i-1][2]>f;i--)e[i]=e[i-1];e[i]=[t,r,f]},o.n=e=>{var a=e&&e.__esModule?()=>e.default:()=>e;return o.d(a,{a:a}),a},t=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,o.t=function(e,r){if(1&r&&(e=this(e)),8&r)return e;if("object"==typeof e&&e){if(4&r&&e.__esModule)return e;if(16&r&&"function"==typeof e.then)return e}var f=Object.create(null);o.r(f);var c={};a=a||[null,t({}),t([]),t(t)];for(var d=2&r&&e;"object"==typeof d&&!~a.indexOf(d);d=t(d))Object.getOwnPropertyNames(d).forEach((a=>c[a]=()=>e[a]));return c.default=()=>e,o.d(f,c),f},o.d=(e,a)=>{for(var t in a)o.o(a,t)&&!o.o(e,t)&&Object.defineProperty(e,t,{enumerable:!0,get:a[t]})},o.f={},o.e=e=>Promise.all(Object.keys(o.f).reduce(((a,t)=>(o.f[t](e,a),a)),[])),o.u=e=>"assets/js/"+({130:"7e7aa536",538:"e0c4e08d",685:"acc96f77",833:"cf57817a",881:"20692867",996:"30c1de03",1070:"e2c9a94b",1078:"9b0396f8",1122:"d20ae096",1235:"a7456010",1903:"acecf23e",2422:"738e0f00",2634:"c4f5d8e4",2711:"9e4087bc",3249:"ccc49370",3976:"0e384e19",4134:"393be207",4167:"9428579a",4192:"2be7da73",4274:"36846233",4345:"680248e1",4481:"4741e212",4836:"451344e5",5742:"aba21aa0",5920:"03c01b4d",6061:"1f391b9e",6418:"f049f840",6548:"3e8d065b",6685:"4d95055f",6969:"14eb3368",7051:"e747ec83",7098:"a7bd4aaa",7449:"fdea42e3",7472:"814f3328",7643:"a6aa9e1f",8401:"17896441",8509:"c4a0550b",8838:"dff1e1e9",8865:"166ee7c9",9013:"9d9f8394",9048:"a94703ab",9121:"53ef7a94",9151:"84de3d6b",9561:"08e3fca0",9647:"5e95c892",9858:"36994c47"}[e]||e)+"."+{130:"fa8e6979",538:"9326eb85",685:"2adb9af8",833:"fc22de99",881:"fc57796c",996:"06051f1e",1070:"afd75d60",1078:"863b7e1c",1122:"81295de9",1235:"2f05987d",1538:"658e140f",1903:"854ae9d8",2237:"81d21c10",2422:"bafd74f6",2634:"292185c8",2711:"01f9a487",3249:"7328970b",3976:"f97a11a3",4134:"a8e05f72",4167:"0ebf0861",4192:"b90105fe",4261:"c94ee3d7",4274:"54eff54f",4345:"ef72a306",4481:"95356e52",4836:"6f3e8301",5742:"88370a23",5920:"beccd8e9",6061:"4b557e1c",6418:"7af0889a",6548:"9519fbb4",6685:"82a871e2",6969:"28a201e0",7051:"91188f24",7098:"0821ec64",7449:"b36135f5",7472:"8ff4a98d",7643:"1925d865",8401:"f89dd302",8509:"a0067fad",8838:"bf109279",8865:"36095d20",9013:"484e1c76",9048:"4147e125",9121:"33996c6d",9151:"139cbb81",9561:"e887744b",9647:"4ed0b4b0",9858:"56f87c0d"}[e]+".js",o.miniCssF=e=>{},o.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),o.o=(e,a)=>Object.prototype.hasOwnProperty.call(e,a),r={},f="my-website:",o.l=(e,a,t,c)=>{if(r[e])r[e].push(a);else{var d,n;if(void 0!==t)for(var b=document.getElementsByTagName("script"),i=0;i{d.onerror=d.onload=null,clearTimeout(s);var f=r[e];if(delete r[e],d.parentNode&&d.parentNode.removeChild(d),f&&f.forEach((e=>e(t))),a)return a(t)},s=setTimeout(l.bind(null,void 0,{type:"timeout",target:d}),12e4);d.onerror=l.bind(null,d.onerror),d.onload=l.bind(null,d.onload),n&&document.head.appendChild(d)}},o.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},o.p="/spec-up-t-website/",o.gca=function(e){return e={17896441:"8401",20692867:"881",36846233:"4274","7e7aa536":"130",e0c4e08d:"538",acc96f77:"685",cf57817a:"833","30c1de03":"996",e2c9a94b:"1070","9b0396f8":"1078",d20ae096:"1122",a7456010:"1235",acecf23e:"1903","738e0f00":"2422",c4f5d8e4:"2634","9e4087bc":"2711",ccc49370:"3249","0e384e19":"3976","393be207":"4134","9428579a":"4167","2be7da73":"4192","680248e1":"4345","4741e212":"4481","451344e5":"4836",aba21aa0:"5742","03c01b4d":"5920","1f391b9e":"6061",f049f840:"6418","3e8d065b":"6548","4d95055f":"6685","14eb3368":"6969",e747ec83:"7051",a7bd4aaa:"7098",fdea42e3:"7449","814f3328":"7472",a6aa9e1f:"7643",c4a0550b:"8509",dff1e1e9:"8838","166ee7c9":"8865","9d9f8394":"9013",a94703ab:"9048","53ef7a94":"9121","84de3d6b":"9151","08e3fca0":"9561","5e95c892":"9647","36994c47":"9858"}[e]||e,o.p+o.u(e)},(()=>{var e={5354:0,1869:0};o.f.j=(a,t)=>{var r=o.o(e,a)?e[a]:void 0;if(0!==r)if(r)t.push(r[2]);else if(/^(1869|5354)$/.test(a))e[a]=0;else{var f=new Promise(((t,f)=>r=e[a]=[t,f]));t.push(r[2]=f);var c=o.p+o.u(a),d=new Error;o.l(c,(t=>{if(o.o(e,a)&&(0!==(r=e[a])&&(e[a]=void 0),r)){var f=t&&("load"===t.type?"missing":t.type),c=t&&t.target&&t.target.src;d.message="Loading chunk "+a+" failed.\n("+f+": "+c+")",d.name="ChunkLoadError",d.type=f,d.request=c,r[1](d)}}),"chunk-"+a,a)}},o.O.j=a=>0===e[a];var a=(a,t)=>{var r,f,c=t[0],d=t[1],n=t[2],b=0;if(c.some((a=>0!==e[a]))){for(r in d)o.o(d,r)&&(o.m[r]=d[r]);if(n)var i=n(o)}for(a&&a(t);b{"use strict";var e,a,t,r,c,f={},d={};function o(e){var a=d[e];if(void 0!==a)return a.exports;var t=d[e]={id:e,loaded:!1,exports:{}};return f[e].call(t.exports,t,t.exports,o),t.loaded=!0,t.exports}o.m=f,o.c=d,e=[],o.O=(a,t,r,c)=>{if(!t){var f=1/0;for(i=0;i=c)&&Object.keys(o.O).every((e=>o.O[e](t[n])))?t.splice(n--,1):(d=!1,c0&&e[i-1][2]>c;i--)e[i]=e[i-1];e[i]=[t,r,c]},o.n=e=>{var a=e&&e.__esModule?()=>e.default:()=>e;return o.d(a,{a:a}),a},t=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,o.t=function(e,r){if(1&r&&(e=this(e)),8&r)return e;if("object"==typeof e&&e){if(4&r&&e.__esModule)return e;if(16&r&&"function"==typeof e.then)return e}var c=Object.create(null);o.r(c);var f={};a=a||[null,t({}),t([]),t(t)];for(var d=2&r&&e;"object"==typeof d&&!~a.indexOf(d);d=t(d))Object.getOwnPropertyNames(d).forEach((a=>f[a]=()=>e[a]));return f.default=()=>e,o.d(c,f),c},o.d=(e,a)=>{for(var t in a)o.o(a,t)&&!o.o(e,t)&&Object.defineProperty(e,t,{enumerable:!0,get:a[t]})},o.f={},o.e=e=>Promise.all(Object.keys(o.f).reduce(((a,t)=>(o.f[t](e,a),a)),[])),o.u=e=>"assets/js/"+({130:"7e7aa536",538:"e0c4e08d",685:"acc96f77",833:"cf57817a",881:"20692867",996:"30c1de03",1070:"e2c9a94b",1078:"9b0396f8",1122:"d20ae096",1235:"a7456010",1903:"acecf23e",2422:"738e0f00",2634:"c4f5d8e4",2711:"9e4087bc",3249:"ccc49370",3976:"0e384e19",4134:"393be207",4167:"9428579a",4192:"2be7da73",4274:"36846233",4345:"680248e1",4481:"4741e212",4836:"451344e5",5742:"aba21aa0",5920:"03c01b4d",6061:"1f391b9e",6418:"f049f840",6548:"3e8d065b",6685:"4d95055f",6969:"14eb3368",7051:"e747ec83",7098:"a7bd4aaa",7449:"fdea42e3",7472:"814f3328",7643:"a6aa9e1f",8401:"17896441",8509:"c4a0550b",8838:"dff1e1e9",8865:"166ee7c9",9013:"9d9f8394",9048:"a94703ab",9121:"53ef7a94",9151:"84de3d6b",9561:"08e3fca0",9647:"5e95c892",9858:"36994c47"}[e]||e)+"."+{130:"fa8e6979",538:"9326eb85",685:"2adb9af8",833:"fc22de99",881:"fc57796c",996:"06051f1e",1070:"ff55a273",1078:"863b7e1c",1122:"81295de9",1235:"2f05987d",1538:"658e140f",1903:"854ae9d8",2237:"81d21c10",2422:"bafd74f6",2634:"292185c8",2711:"01f9a487",3249:"7328970b",3976:"d4e462f7",4134:"a8e05f72",4167:"0ebf0861",4192:"b90105fe",4261:"c94ee3d7",4274:"3ffff24f",4345:"ef72a306",4481:"95356e52",4836:"6f3e8301",5742:"88370a23",5920:"beccd8e9",6061:"4b557e1c",6418:"79e434da",6548:"9519fbb4",6685:"78e2c969",6969:"28a201e0",7051:"91188f24",7098:"0821ec64",7449:"b36135f5",7472:"8ff4a98d",7643:"1925d865",8401:"f89dd302",8509:"e68848bc",8838:"b389e276",8865:"36095d20",9013:"484e1c76",9048:"4147e125",9121:"dd6100b5",9151:"139cbb81",9561:"04208da2",9647:"4ed0b4b0",9858:"56f87c0d"}[e]+".js",o.miniCssF=e=>{},o.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),o.o=(e,a)=>Object.prototype.hasOwnProperty.call(e,a),r={},c="my-website:",o.l=(e,a,t,f)=>{if(r[e])r[e].push(a);else{var d,n;if(void 0!==t)for(var b=document.getElementsByTagName("script"),i=0;i{d.onerror=d.onload=null,clearTimeout(s);var c=r[e];if(delete r[e],d.parentNode&&d.parentNode.removeChild(d),c&&c.forEach((e=>e(t))),a)return a(t)},s=setTimeout(l.bind(null,void 0,{type:"timeout",target:d}),12e4);d.onerror=l.bind(null,d.onerror),d.onload=l.bind(null,d.onload),n&&document.head.appendChild(d)}},o.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},o.p="/spec-up-t-website/",o.gca=function(e){return e={17896441:"8401",20692867:"881",36846233:"4274","7e7aa536":"130",e0c4e08d:"538",acc96f77:"685",cf57817a:"833","30c1de03":"996",e2c9a94b:"1070","9b0396f8":"1078",d20ae096:"1122",a7456010:"1235",acecf23e:"1903","738e0f00":"2422",c4f5d8e4:"2634","9e4087bc":"2711",ccc49370:"3249","0e384e19":"3976","393be207":"4134","9428579a":"4167","2be7da73":"4192","680248e1":"4345","4741e212":"4481","451344e5":"4836",aba21aa0:"5742","03c01b4d":"5920","1f391b9e":"6061",f049f840:"6418","3e8d065b":"6548","4d95055f":"6685","14eb3368":"6969",e747ec83:"7051",a7bd4aaa:"7098",fdea42e3:"7449","814f3328":"7472",a6aa9e1f:"7643",c4a0550b:"8509",dff1e1e9:"8838","166ee7c9":"8865","9d9f8394":"9013",a94703ab:"9048","53ef7a94":"9121","84de3d6b":"9151","08e3fca0":"9561","5e95c892":"9647","36994c47":"9858"}[e]||e,o.p+o.u(e)},(()=>{var e={5354:0,1869:0};o.f.j=(a,t)=>{var r=o.o(e,a)?e[a]:void 0;if(0!==r)if(r)t.push(r[2]);else if(/^(1869|5354)$/.test(a))e[a]=0;else{var c=new Promise(((t,c)=>r=e[a]=[t,c]));t.push(r[2]=c);var f=o.p+o.u(a),d=new Error;o.l(f,(t=>{if(o.o(e,a)&&(0!==(r=e[a])&&(e[a]=void 0),r)){var c=t&&("load"===t.type?"missing":t.type),f=t&&t.target&&t.target.src;d.message="Loading chunk "+a+" failed.\n("+c+": "+f+")",d.name="ChunkLoadError",d.type=c,d.request=f,r[1](d)}}),"chunk-"+a,a)}},o.O.j=a=>0===e[a];var a=(a,t)=>{var r,c,f=t[0],d=t[1],n=t[2],b=0;if(f.some((a=>0!==e[a]))){for(r in d)o.o(d,r)&&(o.m[r]=d[r]);if(n)var i=n(o)}for(a&&a(t);b Archive | Spec-Up-T - + diff --git a/blog/index.html b/blog/index.html index 4d76c58d..e56e87d6 100644 --- a/blog/index.html +++ b/blog/index.html @@ -5,7 +5,7 @@ Blog | Spec-Up-T - + diff --git a/blog/welcome/index.html b/blog/welcome/index.html index 814bd449..3ea3c2af 100644 --- a/blog/welcome/index.html +++ b/blog/welcome/index.html @@ -5,7 +5,7 @@ Welcome | Spec-Up-T - + diff --git a/docs/category/content-authors-guide/index.html b/docs/category/content-authors-guide/index.html index 4bcee22f..7cbb5ac0 100644 --- a/docs/category/content-authors-guide/index.html +++ b/docs/category/content-authors-guide/index.html @@ -5,7 +5,7 @@ Content Authors Guide | Spec-Up-T - + diff --git a/docs/category/curators-guide/index.html b/docs/category/curators-guide/index.html index 722e991a..730da4f9 100644 --- a/docs/category/curators-guide/index.html +++ b/docs/category/curators-guide/index.html @@ -5,10 +5,10 @@ Curators Guide | Spec-Up-T - + -

Curators Guide

Curators Guide.

+

Curators Guide

Curators Guide.

\ No newline at end of file diff --git a/docs/category/glossary-maintainers-guide/index.html b/docs/category/glossary-maintainers-guide/index.html index 7674fb6f..0b3fb787 100644 --- a/docs/category/glossary-maintainers-guide/index.html +++ b/docs/category/glossary-maintainers-guide/index.html @@ -5,10 +5,10 @@ Glossary Maintainers Guide | Spec-Up-T - + -

Glossary Maintainers Guide

Glossary Maintainers Guide.

+

Glossary Maintainers Guide

Glossary Maintainers Guide.

\ No newline at end of file diff --git a/docs/category/readers-guide/index.html b/docs/category/readers-guide/index.html index 96fb8c9b..1fa8c70b 100644 --- a/docs/category/readers-guide/index.html +++ b/docs/category/readers-guide/index.html @@ -5,7 +5,7 @@ Readers Guide | Spec-Up-T - + diff --git a/docs/category/roles/index.html b/docs/category/roles/index.html index 7b1c634e..2c53661d 100644 --- a/docs/category/roles/index.html +++ b/docs/category/roles/index.html @@ -5,10 +5,10 @@ Roles | Spec-Up-T - + -

Roles

Roles.

+

Roles

Roles.

\ No newline at end of file diff --git a/docs/category/terminology-author-guide/index.html b/docs/category/terminology-author-guide/index.html index ac461415..665b4e9c 100644 --- a/docs/category/terminology-author-guide/index.html +++ b/docs/category/terminology-author-guide/index.html @@ -5,7 +5,7 @@ Terminology Author Guide | Spec-Up-T - + diff --git a/docs/glossary/index.html b/docs/glossary/index.html index 6a89a221..2fd817b0 100644 --- a/docs/glossary/index.html +++ b/docs/glossary/index.html @@ -5,7 +5,7 @@ Glossary | Spec-Up-T - + diff --git a/docs/how-it-came-to-be/index.html b/docs/how-it-came-to-be/index.html index 620e0c39..4343df05 100644 --- a/docs/how-it-came-to-be/index.html +++ b/docs/how-it-came-to-be/index.html @@ -5,104 +5,104 @@ How it came to be | Spec-Up-T - +

How it came to be

The ToIP Terms extension of Spec-Up​

This article is meant for technical experts in Spec-Up and git.

-

What is Spec-Up, what is Spec-Up-T and why do we need a fork? Could we move faster by creating our own? Do objectives diverge? Is it possible to work together in a better and more productive way? -A brief answer to all of these questions is ‘yes’. This article elaborates on the details and comes up with an elegant, yet simple and practical, git governance proposal that will keep the ties between Spec-Up and Spec-Up-T in tact.

+

What is Spec-Up, what is Spec-Up-T, and why do we need a fork? Could we move faster by creating our own? Do objectives diverge? Is it possible to work together in a better and more productive way? +A brief answer to all of these questions is 'yes'. This article elaborates on the details and comes up with an elegant yet simple and practical git governance proposal that will keep the ties between Spec-Up and Spec-Up-T intact.

-

“Spec-Up is a technical specification development tool that enables you to create rich specification documents for standards bodies and engineering projects by writing in an extended version of markdown that features all the bells and whistles - for example: advanced syntax highlighting, notice blocks, complex tables, charts, UML diagrams, and more.” -By: Spec-Up creator Daniel Buchner, at Decentralised Identity Foundation (DIF).

+

"Spec-Up is a technical specification development tool that enables you to create rich specification documents for standards bodies and engineering projects by writing in an extended version of markdown that features all the bells and whistles - for example, advanced syntax highlighting, notice blocks, complex tables, charts, UML diagrams, and more." +By Spec-Up creator Daniel Buchner at Decentralised Identity Foundation (DIF).

-

Spec-Up is a great tool for creating online standardization specifications. We use it a lot at TrustoverIP. Recently, we also started contributing to DIF’s Spec-Up code.

-

At ToIP we support the original objective of DIF with Spec-Up. Spec-Up, as it is at present, gives us a base that we want to stay in sync with. Why do we want to merge changes to and fro DIF's spec-up?

+

Spec-Up is a great tool for creating online standardization specifications. We use it a lot at TrustoverIP. Recently, we also started contributing to DIF's Spec-Up code.

+

At ToIP, we support the original objective of DIF with Spec-Up. Spec-Up, as it is now, gives us a base with which we want to stay in sync. Why do we want to merge changes to and from DIF's spec-up?

  • To acknowledge the great work accomplished by DIF
    • -
  • Support a common specification tool in the SSI field that overarches the active umbrella organisations
    • -
  • last but not least: to combine current and future efforts.
    • +
  • Support a standard specification tool in the SSI field that overarches the active umbrella organizations +Last but not least, we need to combine current and future efforts.

What's different?​

-

At ToIP we do more with concepts and terminology than has been foreseen with Spec-Up. For example: versioning of individual terms, and versioning of who references them and when, has been proven a key to success of building consensus within ToIP.

-

To offer ToIP-specific Spec-Up functionality we need to extent the code. Happily, we are able to extend Spec-Up with specific front-end and back-end functionality. As we did before, we could offer those extensions as a PR to DIF’s Spec-Up. In practise this means: and ask Daniel Buchner to have a look at it and ask him to consider merging the new code into the main code repository of Spec-Up.

+

At ToIP, we do more with concepts and terminology than Spec-Up has foreseen. An example of this work is versioning individual terms and versioning who references them and when have been proven critical to building consensus within ToIP.

+

To offer ToIP-specific Spec-Up functionality, we need to extend the code. Happily, we are able to extend Spec-Up with specific front-end and back-end functionality. As we did before, we could offer those extensions as a PR to DIF's Spec-Up. In practice, this means asking Daniel Buchner to have a look at it and asking him to consider merging the new code into the main code repository of Spec-Up.

A rock and a hard place​

What could be problematic for ToIP about the approach to present PRs regarding our specific ToIP code to DIF's Spec-Up:

  1. We put Daniel Buchner / DIF on the critical path for ToIP development
  2. We ask DIF to accept bolt-ons to a lean and mean Spec-Up
    3. -
  3. We trigger discussions about objectives of Spec-Up, where we want to implement Spec-Up right away. +
  4. We trigger discussions about the objectives of Spec-Up, where we want to implement Spec-Up right away. This leaves us between a rock and a hard place if we were to proceed as before.

Versioning of terms and interactive use of specifications​

-

At ToIP we have a need for a Spec-Up tool that has a slightly different angle to static site generation for specification-documents:

+

At ToIP, we need a Spec-Up tool that has a slightly different angle to static site generation for specification documents:

    -
  1. because we have a ToIP-specific fine-grained view on concepts and terminology.
    2. -
  2. we might want to have a few front-end amendments that would not match the lean and mean Spec-Up at DIF with the vision to have a compact simple solution for standards documents.
    3. -
  3. We might want to extend the layout capabilities to adhere to standards of specific target audiences. -The last reason is that we want to move faster with as little “desks to go for a stamp” as possible. -We call this extended Spec-Up Spec-Up-T, where ’T’ can both cover - or refer to - ‘Terms’ and ‘ToIP’.
    4. +
  4. because we have a ToIP-specific fine-grained view of concepts and terminology.
    5. +
  5. We should have a few front-end amendments that would not match the lean and mean Spec-Up at DIF with the vision of a compact, simple solution for standards documents.
    6. +
  6. We can extend the layout capabilities to adhere to the standards of specific target audiences. +The last reason is that we want to move faster with as few "desks to go for a stamp" as possible. +We call this extended Spec-Up Spec-Up-T, where' T' can both cover - or refer to - 'Terms' and 'ToIP.'

No-go solo​

-

What if we were to declare a part of the code in the DIF Spec-Up repository a no-go area? More specifically, within a common shared area we only change code under consensus by offering PRs to be accepted and merged by DIF. That would make coding easier and offer a clear division in feature sets of Spec-Up and Spec-Up-T.

-

Due to the reasons listed above, we need to partly develop solo in a fork (Spec-Up-T), and then we could offer our work to DIF. If they merge our code in their repo, that’d be great because it would confirm consensus about objectives behind Spec-Up. But this mutual merge is optional for DIF.

+

What if we declared a part of the code in the DIF Spec-Up repository a no-go area? More specifically, within a common shared area, we only change code under consensus by offering PRs to be accepted and merged by DIF. That would make coding easier and offer a clear division in feature sets of Spec-Up and Spec-Up-T.

+

Due to the reasons listed above, we need to partly develop solo in a fork (Spec-Up-T), and then we could offer our work to DIF. If they merge our code in their repo, that'd be great because it would confirm consensus about the objectives behind Spec-Up. But this mutual merge is optional for DIF.

How do we stay in sync?​

We propose a "bi-directional sync" or "mutual synchronization" model. In this model, both repositories are equally important, and changes are synced between them at will to ensure they both contain the same information or updates.

Charting territories​

For clarity, there are three main perspectives on Spec-Up(-T) publicly AND on your local computer:

    -
  • Authors look at ready-to-use Spec-Up github.com version (after running Starter-pack)
    • +
  • Authors look at the ready-to-use Spec-Up github.com version (after running Starter-pack)
  • Coders look at the NPM Spec-Up libraries
  • Users see the generated end-product on github.io (index.html)

Perspective: Authors​

-

Authors of a new Specification start with an empty directory on their local machine. After the command npm install spec-up-T the spec directory and all the files mentioned will be present. The grey files are not to be touched because they are generated results. The green files can be altered to fill and configure the new Specification. A Spec-Up-T install will typically include all DIF Spec-Up code.

-

What's the meaning of this? ->​

-

After this an author can start filling the project, and configuring Spec-Up(-T).

+

Authors of a new Specification start with an empty directory on their local machine. After the command npm install spec-up-T, the spec directory and all the files mentioned will be present. The grey files are not to be touched because they are generated results. The green files can be altered to fill and configure the new specification. A Spec-Up-T install will typically include all DIF Spec-Up codes.

+

What's the meaning of this? ->​

+

After this, an author can start filling the project and configuring Spec-Up(-T).

image

-

Next is theNpm install command that actually populates the authors local Specification repo with the Spec-Up(-T) code.

-

Mind you, it's no different on github.com: a push will invoke a github action that generates a branch called gh-pages with the same files.

+

Next is the 'Npm install` command that populates the author's local Specification repo with the Spec-Up(-T) code.

+

Mind you; it's no different on github.com: a push will invoke a github action that generates a branch called gh-pages with the same files.

What's the meaning of this? ->​

-

Both a local and remote version of an author's specification can be generated, can be monitored and curated.

+

Both a local and remote version of an author's specification can be generated, monitored, and curated.

image

-

The static site generation result in a one page index.html file.

+

The static site generation results in a one-page index.html file.

What's the meaning of this? ->​

-

An author can develop and test the Specification locally and then push it to production.

+

An author can develop and test the specification locally and then push it to production.

image

Important note​

-

To get the github page online a few configuration steps must follow on github.com repo, branche master

+

In his wish to put the github page online, the implementor must follow a few configuration steps on the github.com repo, branch master:

-

Go to 'Settings' -> 'Pages' (you need administrator-rights)

+

Go to 'Settings' -> 'Pages' (you need administrator rights)

-

to publish the Specification as a one pager on github.io.

+

To publish the specification as a one-pager on github.io.

image

Perspective: Coders​

-

Suppose DIF's Spec-Up is stable and not actively enhanced further. Spec-Up still can merge PRs from others. In time Spec-Up-T libraries will grow (second circle pair) and with this development and through merges Spec-Up can cherry pick whatever it wants to incorporate from Spec-Up-T and grow too, without diverging (third circle pair).

+

Suppose DIF's Spec-Up is stable and not actively enhanced further. Spec-Up can still merge PRs from others. In time, Spec-Up-T libraries will grow (second circle pair), and with this development and through merges, Spec-Up can cherry-pick whatever it wants to incorporate from Spec-Up-T and grow too, without diverging (third circle pair).

image

-

The image below shows the github.com repo and its NPM library section op the in green, red and orange. and in below. We won’t touch the red and orange sections in our repo ‘Spec-Up-T’ without making a separate branche and offer the changes as a PR to DIF.

+

The image below shows the github.com repo and its NPM library section in green, red, and orange. We won't touch the red and orange sections in our repo 'Spec-Up-T' without making a separate branch and offering the changes as a PR to DIF.

image

Mind you, the Spec directory regularly holds the authors' markdown, but it's crossed out because this is a configurable location.

Legend​

    -
  • Red: definitely do not touch anything, because of the red files and red directories are generated and some are core components
    • +
  • Red: definitely do not touch anything because the red files and red directories are generated, and some are core components
  • Orange: may touch, but in consultation via PRs with DIF / Daniel Buchner
    • -
  • Green: these are the files to freely alter under Spec-Up-T.
    • +
  • Green: These are the files that can freely be altered under Spec-Up-T.
-

In the orange sections, we could make amendments for ToIP concepts and terminology. By doing so, we can move forward without having to wait for DIF to accept or reject these changes.

-

Other Spec-Up-based repos could come over to Spec-Up-T and pull the amendments that we've made to their repo. We’ll branch off per feature. Because we stay in sync with the latest Spec-Up, a clean merge with little or no merge conflicts should be possible. Of course, for this to happen, the target repo needs to be in sync with the latest Spec-Up too.

+

In the orange sections, we could make amendments to ToIP concepts and terminology. By doing so, we can move forward without having to wait for DIF to accept or reject these changes.

+

Other Spec-Up-based repos could come over to Spec-Up-T and pull the amendments that we've made to their repo. We'll branch off per feature. Because we stay in sync with the latest Spec-Up, a clean merge with little or no merge conflicts should be possible. Of course, for this to happen, the target repo needs to be in sync with the latest Spec-Up, too.

Preparatory code organization and Git configuration in current DIF Spec-Up​

-

To have a clean start we suggest to offer a PR to Daniel Buchner. This PR doesn't change any feature nor outcome at the front-end side of a Spec-Up generated site, but only alters the code organisation. Thesse are the points of interest:

+

To have a clean start, we suggest offering a PR to Daniel Buchner. This PR doesn't change any feature or outcome at the front-end side of a Spec-Up-generated site but only alters the code organization. These are the points of interest:

  1. -

    Maintain a Clean Division: Currently, our Node.js scripts are placed in the root directory, while client-side JavaScript and CSS have their own directory under /assets. We should aim for a similar clean separation of all Node.js (and server side code in general) for all new developments. By organizing new features and code into separate files within a dedicated directory, we can ensure that code and content is even more manageable and even better organized.

    +

    Maintain a Clean Division: Currently, our Node.js scripts are placed in the root directory, while client-side JavaScript and CSS have their own directory under /assets. We should aim for a similar clean separation of all Node.js (and server-side code in general) for all new developments. By organizing new features and code into separate files within a dedicated directory, we can ensure that code and content are even more manageable and even better organized.

  2. -

    Minimize Changes to Existing Code: To facilitate smoother updates and reduce the burden of acceptance checks, it's crucial to keep modifications to existing code to a minimum. By placing new code in distinct files and directories, we allow ongoing work without significant disruption. This approach respects the existing codebase while permitting necessary extensions and bug fixes.

    +

    Minimize Changes to Existing Code: This is done to facilitate smoother updates and reduce the burden of acceptance checks; it's crucial to keep modifications to existing code to a minimum. By placing new code in distinct files and directories, we allow ongoing work without significant disruption. This approach respects the existing codebase while permitting necessary extensions and bug fixes.

  3. -

    Exclude Generated Files from Git. In our case it is about node_modules, generated files (e.g., everything in /compiled). It should not be included in our Git repositories. These files are the result of compilation commands like $ gulp compile and can be recreated from source, making their inclusion in version control redundant and cluttering.

    +

    Exclude Generated Files from Git. In our case, it is about node_modules and generated files (e.g., everything in /compiled). It should not be included in our Git repositories. These files are the result of compilation commands like $ gulp compile and can be recreated from the source, making their inclusion in version control redundant and cluttering.

  4. Maintenance issues:

    @@ -110,7 +110,7 @@

    Edit this page

\ No newline at end of file diff --git a/docs/intro/index.html b/docs/intro/index.html index fc9cb342..96f5db39 100644 --- a/docs/intro/index.html +++ b/docs/intro/index.html @@ -5,7 +5,7 @@ Introduction | Spec-Up-T - + @@ -13,24 +13,24 @@

Intro​

Spec-Up-T is a tool that helps you write specifications. It is a tool for writing in Markdown and creates one index.html file.

This index.html file is the actual specification file that is the goal of it all.

-

This index.html file is stand-alone and can be hosted on any webserver. Or double click it and it will open. +

This index.html file is stand-alone and can be hosted on any web server. Or double-click it, and it will open. The code is available on Github.

-

Spec-Up-T is based on Spec-Up and some of the content on this website is taken from the Spec-Up website.

-
tip

In order to start using Spec-Up-T you will have to install it. Go straight to the admin section for instructions.

+

Spec-Up-T is based on Spec-Up, and some of the content on this website is taken from the Spec-Up website.

+
tip

You will have to install Spec-Up-T to start using it. Go straight to the admin section for instructions.

History​

Spec-Up-T is based on Spec-Up (Spec-Up on Github).

Spec-Up is a tool provided by DIF (Decentralized Identity Foundation) and created by Daniel Buchner.

Logo ToIP and DIF combined

-

From the Spec-Up documentation: “Spec-Up is a technical specification development tool that enables you to create rich specification documents for standards bodies and engineering projects by writing in an extended version of markdown that features all the bells and whistles - for example: advanced syntax highlighting, notice blocks, complex tables, charts, UML diagrams, and more.”

+

From the Spec-Up documentation: “Spec-Up is a technical specification development tool that enables you to create rich specification documents for standards bodies and engineering projects by writing in an extended version of markdown that features all the bells and whistles - for example, advanced syntax highlighting, notice blocks, complex tables, charts, UML diagrams, and more.”

Spec-UpSpec-Up-T
DIF Logo
Decentralized Identity Foundation
ToIP Logo
Trust over IP
“Together we're building a new identity ecosystem”“Developing a complete architecture for Internet Digital Trust. And a better Internet for everyone.”
Spec-Up on GithubSpec-Up-T on Github
DIF websiteToIP website

Spec-Up-T is an expansion of DIF's Spec-Up specifically for the needs of the Trust-over-IP foundation. Read more in the elaborate motivation in this technical article: How it came to be.

Spec-Up-T​

-

Spec-Up-T stays in sync with Spec-Up, and currently adds the following extra functionality:

+

Spec-Up-T stays in sync with Spec-Up and currently adds the following extra functionality:

  1. Search & Find (not the same as the browser search)
    2. -
  2. Splitter for Terms and Definition section following the Termininology Governance Guide and various meeting report since CTWG April 2024
    3. +
  3. Splitter for Terms and Definition section following the Termininology Governance Guide and various meeting reports since CTWG April 2024
  4. External Reference (xref) functionality (To Do: add link)
    5. -
  5. Small User Interface enhancements (back to top button, automatic copying of urls when clicking on anchors (“$”), menu-item highlighting)
    6. +
  6. Small User Interface enhancements (back-to-top button, automatic copying of urls when clicking on anchors (“$”), menu-item highlighting)

Spec-Up and Spec-Up-T work on Github. The specification is stored in a Github repo. Editing can be done locally in a suitable editor (Visual Studio Code is widely used), or can be done web-based via the editor provided by Github if you are logged in.

Github Actions is a convenient way to automate things within Github by creating workflows. For example, you can create a workflow that generates an updated version of the specification.

diff --git a/docs/q-and-a/index.html b/docs/q-and-a/index.html index 229b0102..f96c5b4c 100644 --- a/docs/q-and-a/index.html +++ b/docs/q-and-a/index.html @@ -5,7 +5,7 @@ Q & A | Spec-Up-T - + diff --git a/docs/spec-up-t-demo-site/index.html b/docs/spec-up-t-demo-site/index.html index d80a3417..30947f25 100644 --- a/docs/spec-up-t-demo-site/index.html +++ b/docs/spec-up-t-demo-site/index.html @@ -5,7 +5,7 @@ Spec-Up-T demo | Spec-Up-T - + diff --git a/docs/this-site-maintainers/index.html b/docs/this-site-maintainers/index.html index 6ddb582a..b836ceb1 100644 --- a/docs/this-site-maintainers/index.html +++ b/docs/this-site-maintainers/index.html @@ -5,7 +5,7 @@ Maintaining this site | Spec-Up-T - + diff --git a/docs/troubleshooting/index.html b/docs/troubleshooting/index.html index 234f06c6..0e1e9b29 100644 --- a/docs/troubleshooting/index.html +++ b/docs/troubleshooting/index.html @@ -5,7 +5,7 @@ Troubleshooting | Spec-Up-T - + diff --git a/docs/various-roles/admins-guide/index.html b/docs/various-roles/admins-guide/index.html index 4accc8a6..49201146 100644 --- a/docs/various-roles/admins-guide/index.html +++ b/docs/various-roles/admins-guide/index.html @@ -5,7 +5,7 @@ Admins Guide | Spec-Up-T - + @@ -15,10 +15,10 @@

Installation​

Short video​

Let's install Spec-Up-T. This short video shows the process.

- +

Link to the video

Getting Started​

-

Now let's do it ourselves. Get started by creating a new site.

+

Now, let's do it ourselves. Get started by creating a new site.

What you'll need​

  • Node.js: @@ -30,14 +30,14 @@

    What you

Install a new site​

General info​

-

Installing Spec-Up-T works similarly to installing any other npm package. You install it locally (not globally) and then you run it.

+

Installing Spec-Up-T works similarly to installing any other npm package. You install it locally (not globally), and then you run it.

Install a new Spec-Up-T site​

npx create-spec-up-t my-spec-up-t-website
-

my-spec-up-t-website can be anything you want it to be (however it is recommended to not use spaces or special characters in directory names).

+

my-spec-up-t-website can be anything you want it to be (however, it is recommended to not use spaces or special characters in directory names).

You can also omit the last part:

npx create-spec-up-t
-

If you omit my-spec-up-t-website a default directory name is used, namely spec-up-t-starterpack.

-

Sometimes you want to force the latest version to be installed. Then you can do the following:

+

If you omit my-spec-up-t-website, a default directory name, namely spec-up-t-starterpack, is used.

+

Sometimes, you want to force the latest version to be installed. Then you can do the following:

npx create-spec-up-t@latest my-spec-up-t-website

You can type this command into Command Prompt, Powershell, Terminal, or any other integrated terminal of your code editor. It should work on any operating system (not tested yet).

You should now have a directory called my-spec-up-t-website (or spec-up-t-starterpack if you did not specify a name).

@@ -56,8 +56,8 @@

Ins

When the prompt is visible again, you should now have a basic Spec-Up-T install:

  • a specs.json file
    • -
  • a spec/ directory with a sample markdown files
    • -
  • a node_modules directory, a package.json file and a package-lock.json file (these three elements belong to the npm system)
    • +
  • a spec/ directory with sample markdown files
    • +
  • a node_modules directory, a package.json file, and a package-lock.json file (these three elements belong to the npm system)

What you don't have yet is the following:

    @@ -68,37 +68,18 @@

    More infoThe specs.json file​

    Thespecs.json file in the root folder of your repository specifies configuration values used in the generation of your spec documents. The values in your specs.json file include things like where your spec's markdown files are located, where to output the generated spec document, and various metadata values used in rendering, such as the title, logo, and repo links for each of your specs. The following are the required/optional fields supported in the specs.json config file:

      -
    • public_root (PATH STRING, optional) - For some platforms and services where you may want to output your rendered spec, the pathing may differ from the directory structure of your local project. To account for this, you can use the public_root property to specify the insertion of a path segment to account for the different in pathing between your local renders and wherever you publish your spec to.
      • -
    • specs (ARRAY, required) - the specs array contains descriptor objects for each of the specs you are generating in your project, and are composed of the following required and optional properties: -
        -
      • -

        spec_directory (STRING, required) - You must specify the repo-root-relative location of your spec's markdown file directory. You MUST name your spec's markdown file spec.md and locate it in your spec_directory for the tool to automatically find and use it for rendering. If you want to use a different name for the markdown file, or you have multiple markdown files you would like the tool to assemble into one document, you must specify them using the optionalmarkdown_paths field described below. See the "multi-file" example in the spec-up repo.

        -
        • -
      • -

        title (STRING, required) - You must add a title for your spec, which will be rendered in the generated document's H1 text and page title.

        -
        • -
      • -

        logo (PATH/URI STRING, optional) - You may add a reference to a logo asset, either via a path to the asset or a URI

        -
        • -
      • -

        logo_link (URI STRING, optional) - The URI you want your logo to point to in the rendered page.

        -
        • -
      • -

        markdown_paths (ARRAY, optional) - If you want to name your spec's markdown file something other than spec.md, or you have multiple files you would like assembled into a single output document, you must specify their paths as array entries in the order you would like them assembled. The paths in this array are assumed to be based on the spec_directory you specified, so DO NOT repeat the full root relative path.

        -
        • -
      • -

        katex (BOOLEAN, optional) - To enable TeX support via KaTeX, set this property to true. After rendering, be sure to copy the fonts/ subdirectory, containing the necessary web fonts.

        -
        • -
      • -

        output_path (STRING, optional) - If you want the generated spec document to be output to a different location than the spec_directory you specified (e.g. the project root for GitHub Pages publishing) you can specify another root relative path (use ./ for root), and the tool will write the document file there instead.

        -
        • -
      • -

        source (OBJECT, optional) - this object allows you to configure where repo-specific data is pulled from to power some of the more advanced repo-related features. To do this, specify the code hosting service by adding a service ID string to host (currently Spec-Up only supports "github", but this is extensible), add the account/org the repo is located within via the account property, and add the repo name under the repo property. Here is an example configuration:

        -
        {
            "host": "github",
            "account": "decentralized-identity",
            "repo": "sidetree"
        }
        -
        • -
      -
      • +
    • public_root (PATH STRING, optional) - For some platforms and services where you may want to output your rendered spec, the pathing may differ from the directory structure of your local project. To account for this, you can use the public_root property to specify the insertion of a path segment to account for the difference in pathing between your local renders and wherever you publish your spec.
      • +
    • specs (ARRAY, required) - the specs array contains descriptor objects for each of the specs you are generating in your project and are composed of the following required and optional properties:
      • +
    • spec_directory (STRING, required) - You must specify the repo-root-relative location of your spec's markdown file directory. You MUST name your spec's markdown file spec.md and locate it in your spec_directory so the tool can automatically find and use it for rendering. If you want to use a different name for the markdown file, or you have multiple markdown files you would like the tool to assemble into one document, you must specify them using the optionalmarkdown_paths field described below. See the "multi-file" example in the spec-up repo.
      • +
    • title (STRING, required) - You must add a title for your spec, which will be rendered in the generated document's H1 text and page title.
      • +
    • logo (PATH/URI STRING, optional) - You may add a reference to a logo asset, either via a path to the asset or a URI
      • +
    • logo_link (URI STRING, optional) - The URI you want your logo to point to on the rendered page.
      • +
    • markdown_paths (ARRAY, optional) - If you want to name your spec's markdown file something other than spec.md, or you have multiple files you would like assembled into a single output document, you must specify their paths as array entries in the order you would like them assembled. The paths in this array are assumed to be based on the spec_directory you specified, so DO NOT repeat the full root relative path.
      • +
    • katex (BOOLEAN, optional) - To enable TeX support via KaTeX, set this property to true. After rendering, be sure to copy the fonts/ subdirectory containing the necessary web fonts.
      • +
    • output_path (STRING, optional) - If you want the generated spec document to be output to a different location than the spec_directory you specified (e.g. the project root for GitHub Pages publishing), you can specify another root relative path (use ./ for root), and the tool will write the document file there instead.
      • +
    • source (OBJECT, optional) - this object allows you to configure where repo-specific data is pulled from to power some of the more advanced repo-related features. To do this, specify the code hosting service by adding a service ID string to host (currently Spec-Up only supports "github", but this is extensible), add the account/org the repo is located within via the account property, and add the repo name under the repo property. Here is an example configuration:
    +
    {
    "host": "github",
    "account": "decentralized-identity",
    "repo": "sidetree"
    }

    You're ready to start rendering specs as HTML sites locally and/or pushing them to github pages however you see fit to automate.

    \ No newline at end of file diff --git a/docs/various-roles/content-authors-guide/introduction/index.html b/docs/various-roles/content-authors-guide/introduction/index.html index a4d93799..f550f7dc 100644 --- a/docs/various-roles/content-authors-guide/introduction/index.html +++ b/docs/various-roles/content-authors-guide/introduction/index.html @@ -5,7 +5,7 @@ Content Authors Guide | Spec-Up-T - + diff --git a/docs/various-roles/curators-guide/introduction/index.html b/docs/various-roles/curators-guide/introduction/index.html index 420fee43..afcf55f1 100644 --- a/docs/various-roles/curators-guide/introduction/index.html +++ b/docs/various-roles/curators-guide/introduction/index.html @@ -3,14 +3,22 @@ -Curators Guide | Spec-Up-T +introduction | Spec-Up-T - + -

    Curators Guide

    -

    Uses an IDE and git and browser extensions, to check logical consistency & meaning of term definition in a certain context.

    -

    Uses browser extensions to harvest a personal collection of term definitions, based on those recommended by the specification authors.

    +

    introduction

    + +

    Curators Guide

    +

    Uses an IDE and git and browser extensions to check the overall content of a specification and logical consistency & meaning of term definition in a particular context.

    +

    The curator uses browser extensions to harvest a personal collection of term definitions based on those recommended by the specification authors.

    +

    A curator can: +Fork a Spec-Up-T repo to his/her user account on GitHub.com +Optionally fetch and merge this repo to an IDE on a local computer. +Configure the user account to publish the GitHub pages generated by Spec-Up-T +Push change to the user account of the curator to show the admin role +Offer a PR with changes and compare them across forks.

    \ No newline at end of file diff --git a/docs/various-roles/developers-guide/index.html b/docs/various-roles/developers-guide/index.html index b5744b36..a32500b5 100644 --- a/docs/various-roles/developers-guide/index.html +++ b/docs/various-roles/developers-guide/index.html @@ -5,7 +5,7 @@ Developers Guide | Spec-Up-T - + diff --git a/docs/various-roles/general-guide/index.html b/docs/various-roles/general-guide/index.html index caee57e8..b41f4614 100644 --- a/docs/various-roles/general-guide/index.html +++ b/docs/various-roles/general-guide/index.html @@ -3,29 +3,29 @@ -General Guide | Spec-Up-T +General Guide | Spec-Up-T - +

    General Guide

    -

    These are general instructions.

    +

    These are general instructions for every role involved.

    Look up xrefs​

    Xrefs are [To Do: write explanation]

    npm run xrefs
    -

    Now the references to external specs are generated, if any.

    +

    Now, the references to external specs are generated, if any.

    Create index.html​

    -

    The final result will be just one file: index.html. This file is rendered or rerendered with the following command:

    +

    The final result will be just one file: index.html. This file is rendered or re-rendered with the following command:

    npm run render
    -

    Now an index.html file is created in the docs directory. This is the default directory, specified in the specs.json file.

    +

    Now, an index.html file is created in the docs directory. This is the default directory specified in the specs.json file.

    You are ready​

    Now you have a basic Spec-Up-T specification file (index.html) with the following content:

    • a specs.json file
      • -
    • a spec/ directory with a sample markdown files
      • +
    • a spec/ directory with sample markdown files
    • a docs directory with a sample index.html file
      • -
    • a node_modules directory, a package.json file and a package-lock.json file (these three elements belong to the npm system)
      • +
    • a node_modules directory, a package.json file, and a package-lock.json file (these three elements belong to the npm system)

    View your specification​

    So the index.html is the endresult. You should view it in a browser. Er zijn twee manieren om dit te doen:

    @@ -33,15 +33,15 @@

    View
  • via http://
  • via file:///

-

The simplest way to do so is via file:///: go to the index.html file with your Explorer, Finder or other file manager, and double-click on it. Usually it now opens in your browser.

-

If not, go to the browser, and try to open the file from the browser menu.

-

This way you open the index.html file via the file protocol (“file:///”).

-

What you can also do is access it via HTTP. You then need to place the index.html file on a web server and access it through a browser using the url under which the file is accessible.

-

This way you can share it with the world by sharing the url.

-
info

HTTP stands for HyperText Transfer Protocol. It is the foundation of any data exchange on the Web and it is a protocol used for transmitting hypertext requests and information on the internet. HTTP is used by the World Wide Web and defines how messages are formatted and transmitted, and how web servers and browsers should respond to various commands.

+

The simplest way to do so is via file:///: go to the index.html file with your Explorer, Finder, or other file manager, and double-click on it. Usually, it now opens in your browser.

+

If not, go to the browser and try to open the file from the browser menu.

+

This way, you open the index.html file via the file protocol (“file:///”).

+

You can also access it via HTTP. You then need to place the index.html file on a web server and access it through a browser using the URL under which the file is accessible.

+

This way, you can share it with the world by sharing the URL.

+
info

HTTP stands for HyperText Transfer Protocol. It is the foundation of any data exchange on the Web and a protocol for transmitting hypertext requests and information online. The World Wide Web uses HTTP and defines how messages are formatted and transmitted and how web servers and browsers should respond to various commands.

Three different modes​

npm run render is not the only way to go. There are three different modes for rendering the specification:

-
commandbehavior
npm run editafter rendering, this will stay running and the gulp library will watch the source files in your spec directory/ies for changes and re-render any time you save a file. Opening these rendered files in a browser and refreshing them will keep you up to date.
npm run renderthis renders the site once and does not keep a gulpy watch on the underlying files.
npm run devthis enables debugging features.
+
commandbehavior
npm run editAfter rendering, this will stay running, and the gulp library will watch the source files in your spec directory/ies for changes and re-render any time you save a file. Opening these rendered files in a browser and refreshing them will keep you up to date.
npm run renderThis renders the site once and does not keep a gulpy watch on the underlying files.
npm run devthis enables debugging features.

Automation​

The above scripts can easily be triggered by github actions. See this repo's example

diff --git a/docs/various-roles/glossary-maintainers-guide/introduction/index.html b/docs/various-roles/glossary-maintainers-guide/introduction/index.html index 5a2093e9..0aa7e0e4 100644 --- a/docs/various-roles/glossary-maintainers-guide/introduction/index.html +++ b/docs/various-roles/glossary-maintainers-guide/introduction/index.html @@ -5,7 +5,7 @@ Glossary Maintainers Guide | Spec-Up-T - + diff --git a/docs/various-roles/intro/index.html b/docs/various-roles/intro/index.html index 82c2c84b..ac59ed6c 100644 --- a/docs/various-roles/intro/index.html +++ b/docs/various-roles/intro/index.html @@ -3,14 +3,14 @@ -Intro | Spec-Up-T +Intro | Spec-Up-T - +

Intro

-

The following roles can be distinguished:

-
RoleDescriptionGuide LinkSkills
Content AuthorFocusses on content and concepts of the group he/she belongs to.Content Author GuideUnderstand JSON, Understand Markdown
Terminology AuthorFocusses on term definitions covering concepts of the group he/she belongs to.Terminology Author GuideUnderstand Markdown
CuratorChecks logical consistency & meaning of term definition in a certain context.Curator GuideUnderstand Markdown
ReaderReads concepts in text and terminology in glossaries.Reader GuideUnderstand the web
AdminInstalls, updates and maintains Spec-Up-T.Admin GuideUnderstand Node and NPM, Understand file system, Understand debugging
DeveloperAdds new functionality to Spec-Up-T.Developer GuideUnderstand Git and Github
+

Spec-Up-T implementations can distinguish the following roles:

+
RoleDescriptionGuide LinkSkills
Content AuthorFocusses on content and concepts of the group he/she belongs to.Content Author GuideUnderstand JSON, Understand Markdown
Terminology AuthorFocusses on term definitions covering concepts of the group he/she belongs to.Terminology Author GuideUnderstand Markdown
CuratorChecks overall content and logical consistency & meaning of term definition in a certain context.Curator GuideUnderstand Markdown
ReaderReads concepts in text and terminology in glossaries.Reader GuideUnderstand the web
AdminInstalls, updates, and maintains Spec-Up-T.Admin GuideUnderstand Node and NPM, Understand file system, Understand debugging
DeveloperAdds new functionality to Spec-Up-T.Developer GuideUnderstand Git and Github
\ No newline at end of file diff --git a/docs/various-roles/readers-guide/introduction/index.html b/docs/various-roles/readers-guide/introduction/index.html index e2334253..dcb096d8 100644 --- a/docs/various-roles/readers-guide/introduction/index.html +++ b/docs/various-roles/readers-guide/introduction/index.html @@ -5,7 +5,7 @@ Readers Guide | Spec-Up-T - + diff --git a/docs/various-roles/technical-skills-needed/index.html b/docs/various-roles/technical-skills-needed/index.html index 3787022f..afae0e6a 100644 --- a/docs/various-roles/technical-skills-needed/index.html +++ b/docs/various-roles/technical-skills-needed/index.html @@ -5,7 +5,7 @@ Technical skills needed | Spec-Up-T - + diff --git a/docs/various-roles/terminology-authors-guide/external-term-references/index.html b/docs/various-roles/terminology-authors-guide/external-term-references/index.html index f89494aa..c5a7f213 100644 --- a/docs/various-roles/terminology-authors-guide/external-term-references/index.html +++ b/docs/various-roles/terminology-authors-guide/external-term-references/index.html @@ -5,7 +5,7 @@ External Term References | Spec-Up-T - + diff --git a/docs/various-roles/terminology-authors-guide/introduction/index.html b/docs/various-roles/terminology-authors-guide/introduction/index.html index 1df6eb1a..97f839b3 100644 --- a/docs/various-roles/terminology-authors-guide/introduction/index.html +++ b/docs/various-roles/terminology-authors-guide/introduction/index.html @@ -5,7 +5,7 @@ Terminology Authors Guide | Spec-Up-T - + diff --git a/docs/various-roles/terminology-authors-guide/term-references/index.html b/docs/various-roles/terminology-authors-guide/term-references/index.html index 333bd701..b332d040 100644 --- a/docs/various-roles/terminology-authors-guide/term-references/index.html +++ b/docs/various-roles/terminology-authors-guide/term-references/index.html @@ -5,7 +5,7 @@ Term References | Spec-Up-T - + diff --git a/index.html b/index.html index f44ea03d..48f87167 100644 --- a/index.html +++ b/index.html @@ -5,7 +5,7 @@ Spec-Up-T | Spec-Up-T - + diff --git a/markdown-page/index.html b/markdown-page/index.html index 063a9960..ebc65415 100644 --- a/markdown-page/index.html +++ b/markdown-page/index.html @@ -5,7 +5,7 @@ Markdown page example | Spec-Up-T - +