├── .gitignore
├── .ruby-version
├── .travis.yml
├── 404.html
├── Gemfile
├── Gemfile.lock
├── LICENSE
├── README.md
├── _config.yml
├── _content.yml
├── _includes
    ├── head.html
    └── sidebar.html
├── _layouts
    ├── default.html
    ├── page.html
    └── post.html
├── _posts
    ├── 2012-02-06-whats-jekyll.md
    ├── 2012-02-07-example-content.md
    ├── 2013-12-28-introducing-hyde.md
    └── 2016-07-29-metalsmith-part1.md
├── approach.md
├── atom.xml
├── images
    ├── dependencies.png
    └── icon.svg
├── index.md
├── package.json
├── partners.md
├── public
    ├── apple-touch-icon-144-precomposed.png
    ├── css
    │   ├── hyde.css
    │   ├── poole.css
    │   └── syntax.css
    └── favicon.ico
├── status.md
├── technology.md
└── technology
    ├── applications.md
    ├── architecture.png
    ├── authoring.md
    ├── existing.md
    ├── foundations
        ├── git.md
        ├── github.md
        ├── gitlab.md
        ├── markdown.md
        └── prose.md
    ├── implementation.md
    ├── implementation
        └── docsmith.md
    ├── inspiration.md
    ├── taxonomies.md
    ├── translation.md
    └── workflow.md


/.gitignore:
--------------------------------------------------------------------------------
1 | secrets.sh
2 | _site
3 | node_modules
4 | contentascode
5 | NOTES.md


--------------------------------------------------------------------------------
/.ruby-version:
--------------------------------------------------------------------------------
1 | ruby-2.2.1
2 | 


--------------------------------------------------------------------------------
/.travis.yml:
--------------------------------------------------------------------------------
 1 | language: node_js
 2 | sudo: false
 3 | node_js:
 4 |   - '4.2'
 5 | branches:
 6 |   except:
 7 |     - gh-pages
 8 | cache:
 9 |   bundler: true
10 |   directories:
11 |     - node_modules
12 |     - $HOME/.rvm
13 |     - $HOME/.nvm
14 | install:
15 |   - npm i pm2 http-server contentascode/broken-link-checker -g
16 |   - "rvm install $(sed 's/ruby-//g' .ruby-version)"
17 |   - bundle install
18 | deploy:
19 |   skip_cleanup: true
20 |   provider: script
21 |   script: npm run deploy
22 | env:
23 |   global:
24 |     - GH_USERNAME=jmatsushita
25 |     - CONFIG_OWNER=iilab
26 |     - CONFIG_REPO=contentascode
27 |     - secure: >
28 |         "n4Yb8tQikDFtdNNUhEaQevdprHrU2dpFdjOuj6HxcRkwFHVJ/8IU0eyL5iUg3hnCB+kuolZYoCRCh8Z9DouErhiq7oBHRSjZ7jCHuMUK6ZSOuXBoYW4xEeEV3/K741m0n4GbEeA72JHNmY710ctkCscNJdFGIl6YbLVmis8dmON5sHjuZwKntyAt4c+2R1iHK1odkSXB9Ua/m/rZp1CX/LzVpYY7zQCdzjdcNM1OjeHqUboxu+uln03vUBaS2WRF66r/gCFi42B+Gc0U/z80whm9lVy/wszN6WTX4pUD0x564kHH5yBJQUS3vdDCgnTB55EU+lKJgJGgp70sSWJRtj+WT+uRLtR769jbnxJvwwQMHmk6GZ5Jw+YzPSYu6L8RjbgYiLnKTxOFf+tjdqeOVW5qf9JzXZtATQ0au/UoBm/ruk08D9Ok2HCkvcUWLXnTL1neMITv4Yu9x/lxim83DSByPt6+5c/X9JqSqMF8CFa7ZoHxmNbY/Ww3XHdVKFg3ksh8/ZqN9mMmxBI1PA8Kyvx5/Ci9WLWSxEozgqbnlF1jAAdOuZCxriEOUmQu3mODgMW53V+vq6QlCEWBanRFySe56MMMGXsFtctyVVFV3+i7HhpO4IvIC5soWCVYjLVR+Tv2ewMY7Wvlg0Cu+tLvjYQtD1TrcW5gt3fKylaMKiQ="
29 | 


--------------------------------------------------------------------------------
/404.html:
--------------------------------------------------------------------------------
1 | ---
2 | layout: default
3 | title: "404: Page not found"
4 | permalink: 404.html
5 | ---
6 | 
7 | <p class="lead">Sorry, we've misplaced that URL or it's pointing to something that doesn't exist. <a href="{{ site.baseurl }}">Head back home</a> to try finding it again.</p>
8 | 


--------------------------------------------------------------------------------
/Gemfile:
--------------------------------------------------------------------------------
1 | source 'https://rubygems.org'
2 | 
3 | gem "github-pages"


--------------------------------------------------------------------------------
/Gemfile.lock:
--------------------------------------------------------------------------------
  1 | GEM
  2 |   remote: https://rubygems.org/
  3 |   specs:
  4 |     RedCloth (4.2.9)
  5 |     activesupport (4.2.5.1)
  6 |       i18n (~> 0.7)
  7 |       json (~> 1.7, >= 1.7.7)
  8 |       minitest (~> 5.1)
  9 |       thread_safe (~> 0.3, >= 0.3.4)
 10 |       tzinfo (~> 1.1)
 11 |     addressable (2.3.8)
 12 |     coffee-script (2.4.1)
 13 |       coffee-script-source
 14 |       execjs
 15 |     coffee-script-source (1.10.0)
 16 |     colorator (0.1)
 17 |     ethon (0.8.1)
 18 |       ffi (>= 1.3.0)
 19 |     execjs (2.6.0)
 20 |     faraday (0.9.2)
 21 |       multipart-post (>= 1.2, < 3)
 22 |     ffi (1.9.10)
 23 |     gemoji (2.1.0)
 24 |     github-pages (48)
 25 |       RedCloth (= 4.2.9)
 26 |       github-pages-health-check (= 0.6.1)
 27 |       jekyll (= 3.0.3)
 28 |       jekyll-coffeescript (= 1.0.1)
 29 |       jekyll-feed (= 0.3.1)
 30 |       jekyll-gist (= 1.4.0)
 31 |       jekyll-mentions (= 1.0.0)
 32 |       jekyll-paginate (= 1.1.0)
 33 |       jekyll-redirect-from (= 0.9.1)
 34 |       jekyll-sass-converter (= 1.3.0)
 35 |       jekyll-seo-tag (= 1.0.0)
 36 |       jekyll-sitemap (= 0.10.0)
 37 |       jekyll-textile-converter (= 0.1.0)
 38 |       jemoji (= 0.5.1)
 39 |       kramdown (= 1.9.0)
 40 |       liquid (= 3.0.6)
 41 |       mercenary (~> 0.3)
 42 |       rdiscount (= 2.1.8)
 43 |       redcarpet (= 3.3.3)
 44 |       rouge (= 1.10.1)
 45 |       terminal-table (~> 1.4)
 46 |     github-pages-health-check (0.6.1)
 47 |       addressable (~> 2.3)
 48 |       net-dns (~> 0.8)
 49 |       public_suffix (~> 1.4)
 50 |       typhoeus (~> 0.7)
 51 |     html-pipeline (2.3.0)
 52 |       activesupport (>= 2, < 5)
 53 |       nokogiri (>= 1.4)
 54 |     i18n (0.7.0)
 55 |     jekyll (3.0.3)
 56 |       colorator (~> 0.1)
 57 |       jekyll-sass-converter (~> 1.0)
 58 |       jekyll-watch (~> 1.1)
 59 |       kramdown (~> 1.3)
 60 |       liquid (~> 3.0)
 61 |       mercenary (~> 0.3.3)
 62 |       rouge (~> 1.7)
 63 |       safe_yaml (~> 1.0)
 64 |     jekyll-coffeescript (1.0.1)
 65 |       coffee-script (~> 2.2)
 66 |     jekyll-feed (0.3.1)
 67 |     jekyll-gist (1.4.0)
 68 |       octokit (~> 4.2)
 69 |     jekyll-mentions (1.0.0)
 70 |       html-pipeline (~> 2.2)
 71 |       jekyll (~> 3.0)
 72 |     jekyll-paginate (1.1.0)
 73 |     jekyll-redirect-from (0.9.1)
 74 |       jekyll (>= 2.0)
 75 |     jekyll-sass-converter (1.3.0)
 76 |       sass (~> 3.2)
 77 |     jekyll-seo-tag (1.0.0)
 78 |       jekyll (>= 2.0)
 79 |     jekyll-sitemap (0.10.0)
 80 |     jekyll-textile-converter (0.1.0)
 81 |       RedCloth (~> 4.0)
 82 |     jekyll-watch (1.3.1)
 83 |       listen (~> 3.0)
 84 |     jemoji (0.5.1)
 85 |       gemoji (~> 2.0)
 86 |       html-pipeline (~> 2.2)
 87 |       jekyll (>= 2.0)
 88 |     json (1.8.3)
 89 |     kramdown (1.9.0)
 90 |     liquid (3.0.6)
 91 |     listen (3.0.6)
 92 |       rb-fsevent (>= 0.9.3)
 93 |       rb-inotify (>= 0.9.7)
 94 |     mercenary (0.3.5)
 95 |     mini_portile2 (2.0.0)
 96 |     minitest (5.8.4)
 97 |     multipart-post (2.0.0)
 98 |     net-dns (0.8.0)
 99 |     nokogiri (1.6.7.2)
100 |       mini_portile2 (~> 2.0.0.rc2)
101 |     octokit (4.2.0)
102 |       sawyer (~> 0.6.0, >= 0.5.3)
103 |     public_suffix (1.5.3)
104 |     rb-fsevent (0.9.7)
105 |     rb-inotify (0.9.7)
106 |       ffi (>= 0.5.0)
107 |     rdiscount (2.1.8)
108 |     redcarpet (3.3.3)
109 |     rouge (1.10.1)
110 |     safe_yaml (1.0.4)
111 |     sass (3.4.21)
112 |     sawyer (0.6.0)
113 |       addressable (~> 2.3.5)
114 |       faraday (~> 0.8, < 0.10)
115 |     terminal-table (1.5.2)
116 |     thread_safe (0.3.5)
117 |     typhoeus (0.8.0)
118 |       ethon (>= 0.8.0)
119 |     tzinfo (1.2.2)
120 |       thread_safe (~> 0.1)
121 | 
122 | PLATFORMS
123 |   ruby
124 | 
125 | DEPENDENCIES
126 |   github-pages
127 | 
128 | BUNDLED WITH
129 |    1.10.6
130 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
  1 |                     GNU GENERAL PUBLIC LICENSE
  2 |                        Version 3, 29 June 2007
  3 | 
  4 |  Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
  5 |  Everyone is permitted to copy and distribute verbatim copies
  6 |  of this license document, but changing it is not allowed.
  7 | 
  8 |                             Preamble
  9 | 
 10 |   The GNU General Public License is a free, copyleft license for
 11 | software and other kinds of works.
 12 | 
 13 |   The licenses for most software and other practical works are designed
 14 | to take away your freedom to share and change the works.  By contrast,
 15 | the GNU General Public License is intended to guarantee your freedom to
 16 | share and change all versions of a program--to make sure it remains free
 17 | software for all its users.  We, the Free Software Foundation, use the
 18 | GNU General Public License for most of our software; it applies also to
 19 | any other work released this way by its authors.  You can apply it to
 20 | your programs, too.
 21 | 
 22 |   When we speak of free software, we are referring to freedom, not
 23 | price.  Our General Public Licenses are designed to make sure that you
 24 | have the freedom to distribute copies of free software (and charge for
 25 | them if you wish), that you receive source code or can get it if you
 26 | want it, that you can change the software or use pieces of it in new
 27 | free programs, and that you know you can do these things.
 28 | 
 29 |   To protect your rights, we need to prevent others from denying you
 30 | these rights or asking you to surrender the rights.  Therefore, you have
 31 | certain responsibilities if you distribute copies of the software, or if
 32 | you modify it: responsibilities to respect the freedom of others.
 33 | 
 34 |   For example, if you distribute copies of such a program, whether
 35 | gratis or for a fee, you must pass on to the recipients the same
 36 | freedoms that you received.  You must make sure that they, too, receive
 37 | or can get the source code.  And you must show them these terms so they
 38 | know their rights.
 39 | 
 40 |   Developers that use the GNU GPL protect your rights with two steps:
 41 | (1) assert copyright on the software, and (2) offer you this License
 42 | giving you legal permission to copy, distribute and/or modify it.
 43 | 
 44 |   For the developers' and authors' protection, the GPL clearly explains
 45 | that there is no warranty for this free software.  For both users' and
 46 | authors' sake, the GPL requires that modified versions be marked as
 47 | changed, so that their problems will not be attributed erroneously to
 48 | authors of previous versions.
 49 | 
 50 |   Some devices are designed to deny users access to install or run
 51 | modified versions of the software inside them, although the manufacturer
 52 | can do so.  This is fundamentally incompatible with the aim of
 53 | protecting users' freedom to change the software.  The systematic
 54 | pattern of such abuse occurs in the area of products for individuals to
 55 | use, which is precisely where it is most unacceptable.  Therefore, we
 56 | have designed this version of the GPL to prohibit the practice for those
 57 | products.  If such problems arise substantially in other domains, we
 58 | stand ready to extend this provision to those domains in future versions
 59 | of the GPL, as needed to protect the freedom of users.
 60 | 
 61 |   Finally, every program is threatened constantly by software patents.
 62 | States should not allow patents to restrict development and use of
 63 | software on general-purpose computers, but in those that do, we wish to
 64 | avoid the special danger that patents applied to a free program could
 65 | make it effectively proprietary.  To prevent this, the GPL assures that
 66 | patents cannot be used to render the program non-free.
 67 | 
 68 |   The precise terms and conditions for copying, distribution and
 69 | modification follow.
 70 | 
 71 |                        TERMS AND CONDITIONS
 72 | 
 73 |   0. Definitions.
 74 | 
 75 |   "This License" refers to version 3 of the GNU General Public License.
 76 | 
 77 |   "Copyright" also means copyright-like laws that apply to other kinds of
 78 | works, such as semiconductor masks.
 79 | 
 80 |   "The Program" refers to any copyrightable work licensed under this
 81 | License.  Each licensee is addressed as "you".  "Licensees" and
 82 | "recipients" may be individuals or organizations.
 83 | 
 84 |   To "modify" a work means to copy from or adapt all or part of the work
 85 | in a fashion requiring copyright permission, other than the making of an
 86 | exact copy.  The resulting work is called a "modified version" of the
 87 | earlier work or a work "based on" the earlier work.
 88 | 
 89 |   A "covered work" means either the unmodified Program or a work based
 90 | on the Program.
 91 | 
 92 |   To "propagate" a work means to do anything with it that, without
 93 | permission, would make you directly or secondarily liable for
 94 | infringement under applicable copyright law, except executing it on a
 95 | computer or modifying a private copy.  Propagation includes copying,
 96 | distribution (with or without modification), making available to the
 97 | public, and in some countries other activities as well.
 98 | 
 99 |   To "convey" a work means any kind of propagation that enables other
100 | parties to make or receive copies.  Mere interaction with a user through
101 | a computer network, with no transfer of a copy, is not conveying.
102 | 
103 |   An interactive user interface displays "Appropriate Legal Notices"
104 | to the extent that it includes a convenient and prominently visible
105 | feature that (1) displays an appropriate copyright notice, and (2)
106 | tells the user that there is no warranty for the work (except to the
107 | extent that warranties are provided), that licensees may convey the
108 | work under this License, and how to view a copy of this License.  If
109 | the interface presents a list of user commands or options, such as a
110 | menu, a prominent item in the list meets this criterion.
111 | 
112 |   1. Source Code.
113 | 
114 |   The "source code" for a work means the preferred form of the work
115 | for making modifications to it.  "Object code" means any non-source
116 | form of a work.
117 | 
118 |   A "Standard Interface" means an interface that either is an official
119 | standard defined by a recognized standards body, or, in the case of
120 | interfaces specified for a particular programming language, one that
121 | is widely used among developers working in that language.
122 | 
123 |   The "System Libraries" of an executable work include anything, other
124 | than the work as a whole, that (a) is included in the normal form of
125 | packaging a Major Component, but which is not part of that Major
126 | Component, and (b) serves only to enable use of the work with that
127 | Major Component, or to implement a Standard Interface for which an
128 | implementation is available to the public in source code form.  A
129 | "Major Component", in this context, means a major essential component
130 | (kernel, window system, and so on) of the specific operating system
131 | (if any) on which the executable work runs, or a compiler used to
132 | produce the work, or an object code interpreter used to run it.
133 | 
134 |   The "Corresponding Source" for a work in object code form means all
135 | the source code needed to generate, install, and (for an executable
136 | work) run the object code and to modify the work, including scripts to
137 | control those activities.  However, it does not include the work's
138 | System Libraries, or general-purpose tools or generally available free
139 | programs which are used unmodified in performing those activities but
140 | which are not part of the work.  For example, Corresponding Source
141 | includes interface definition files associated with source files for
142 | the work, and the source code for shared libraries and dynamically
143 | linked subprograms that the work is specifically designed to require,
144 | such as by intimate data communication or control flow between those
145 | subprograms and other parts of the work.
146 | 
147 |   The Corresponding Source need not include anything that users
148 | can regenerate automatically from other parts of the Corresponding
149 | Source.
150 | 
151 |   The Corresponding Source for a work in source code form is that
152 | same work.
153 | 
154 |   2. Basic Permissions.
155 | 
156 |   All rights granted under this License are granted for the term of
157 | copyright on the Program, and are irrevocable provided the stated
158 | conditions are met.  This License explicitly affirms your unlimited
159 | permission to run the unmodified Program.  The output from running a
160 | covered work is covered by this License only if the output, given its
161 | content, constitutes a covered work.  This License acknowledges your
162 | rights of fair use or other equivalent, as provided by copyright law.
163 | 
164 |   You may make, run and propagate covered works that you do not
165 | convey, without conditions so long as your license otherwise remains
166 | in force.  You may convey covered works to others for the sole purpose
167 | of having them make modifications exclusively for you, or provide you
168 | with facilities for running those works, provided that you comply with
169 | the terms of this License in conveying all material for which you do
170 | not control copyright.  Those thus making or running the covered works
171 | for you must do so exclusively on your behalf, under your direction
172 | and control, on terms that prohibit them from making any copies of
173 | your copyrighted material outside their relationship with you.
174 | 
175 |   Conveying under any other circumstances is permitted solely under
176 | the conditions stated below.  Sublicensing is not allowed; section 10
177 | makes it unnecessary.
178 | 
179 |   3. Protecting Users' Legal Rights From Anti-Circumvention Law.
180 | 
181 |   No covered work shall be deemed part of an effective technological
182 | measure under any applicable law fulfilling obligations under article
183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
184 | similar laws prohibiting or restricting circumvention of such
185 | measures.
186 | 
187 |   When you convey a covered work, you waive any legal power to forbid
188 | circumvention of technological measures to the extent such circumvention
189 | is effected by exercising rights under this License with respect to
190 | the covered work, and you disclaim any intention to limit operation or
191 | modification of the work as a means of enforcing, against the work's
192 | users, your or third parties' legal rights to forbid circumvention of
193 | technological measures.
194 | 
195 |   4. Conveying Verbatim Copies.
196 | 
197 |   You may convey verbatim copies of the Program's source code as you
198 | receive it, in any medium, provided that you conspicuously and
199 | appropriately publish on each copy an appropriate copyright notice;
200 | keep intact all notices stating that this License and any
201 | non-permissive terms added in accord with section 7 apply to the code;
202 | keep intact all notices of the absence of any warranty; and give all
203 | recipients a copy of this License along with the Program.
204 | 
205 |   You may charge any price or no price for each copy that you convey,
206 | and you may offer support or warranty protection for a fee.
207 | 
208 |   5. Conveying Modified Source Versions.
209 | 
210 |   You may convey a work based on the Program, or the modifications to
211 | produce it from the Program, in the form of source code under the
212 | terms of section 4, provided that you also meet all of these conditions:
213 | 
214 |     a) The work must carry prominent notices stating that you modified
215 |     it, and giving a relevant date.
216 | 
217 |     b) The work must carry prominent notices stating that it is
218 |     released under this License and any conditions added under section
219 |     7.  This requirement modifies the requirement in section 4 to
220 |     "keep intact all notices".
221 | 
222 |     c) You must license the entire work, as a whole, under this
223 |     License to anyone who comes into possession of a copy.  This
224 |     License will therefore apply, along with any applicable section 7
225 |     additional terms, to the whole of the work, and all its parts,
226 |     regardless of how they are packaged.  This License gives no
227 |     permission to license the work in any other way, but it does not
228 |     invalidate such permission if you have separately received it.
229 | 
230 |     d) If the work has interactive user interfaces, each must display
231 |     Appropriate Legal Notices; however, if the Program has interactive
232 |     interfaces that do not display Appropriate Legal Notices, your
233 |     work need not make them do so.
234 | 
235 |   A compilation of a covered work with other separate and independent
236 | works, which are not by their nature extensions of the covered work,
237 | and which are not combined with it such as to form a larger program,
238 | in or on a volume of a storage or distribution medium, is called an
239 | "aggregate" if the compilation and its resulting copyright are not
240 | used to limit the access or legal rights of the compilation's users
241 | beyond what the individual works permit.  Inclusion of a covered work
242 | in an aggregate does not cause this License to apply to the other
243 | parts of the aggregate.
244 | 
245 |   6. Conveying Non-Source Forms.
246 | 
247 |   You may convey a covered work in object code form under the terms
248 | of sections 4 and 5, provided that you also convey the
249 | machine-readable Corresponding Source under the terms of this License,
250 | in one of these ways:
251 | 
252 |     a) Convey the object code in, or embodied in, a physical product
253 |     (including a physical distribution medium), accompanied by the
254 |     Corresponding Source fixed on a durable physical medium
255 |     customarily used for software interchange.
256 | 
257 |     b) Convey the object code in, or embodied in, a physical product
258 |     (including a physical distribution medium), accompanied by a
259 |     written offer, valid for at least three years and valid for as
260 |     long as you offer spare parts or customer support for that product
261 |     model, to give anyone who possesses the object code either (1) a
262 |     copy of the Corresponding Source for all the software in the
263 |     product that is covered by this License, on a durable physical
264 |     medium customarily used for software interchange, for a price no
265 |     more than your reasonable cost of physically performing this
266 |     conveying of source, or (2) access to copy the
267 |     Corresponding Source from a network server at no charge.
268 | 
269 |     c) Convey individual copies of the object code with a copy of the
270 |     written offer to provide the Corresponding Source.  This
271 |     alternative is allowed only occasionally and noncommercially, and
272 |     only if you received the object code with such an offer, in accord
273 |     with subsection 6b.
274 | 
275 |     d) Convey the object code by offering access from a designated
276 |     place (gratis or for a charge), and offer equivalent access to the
277 |     Corresponding Source in the same way through the same place at no
278 |     further charge.  You need not require recipients to copy the
279 |     Corresponding Source along with the object code.  If the place to
280 |     copy the object code is a network server, the Corresponding Source
281 |     may be on a different server (operated by you or a third party)
282 |     that supports equivalent copying facilities, provided you maintain
283 |     clear directions next to the object code saying where to find the
284 |     Corresponding Source.  Regardless of what server hosts the
285 |     Corresponding Source, you remain obligated to ensure that it is
286 |     available for as long as needed to satisfy these requirements.
287 | 
288 |     e) Convey the object code using peer-to-peer transmission, provided
289 |     you inform other peers where the object code and Corresponding
290 |     Source of the work are being offered to the general public at no
291 |     charge under subsection 6d.
292 | 
293 |   A separable portion of the object code, whose source code is excluded
294 | from the Corresponding Source as a System Library, need not be
295 | included in conveying the object code work.
296 | 
297 |   A "User Product" is either (1) a "consumer product", which means any
298 | tangible personal property which is normally used for personal, family,
299 | or household purposes, or (2) anything designed or sold for incorporation
300 | into a dwelling.  In determining whether a product is a consumer product,
301 | doubtful cases shall be resolved in favor of coverage.  For a particular
302 | product received by a particular user, "normally used" refers to a
303 | typical or common use of that class of product, regardless of the status
304 | of the particular user or of the way in which the particular user
305 | actually uses, or expects or is expected to use, the product.  A product
306 | is a consumer product regardless of whether the product has substantial
307 | commercial, industrial or non-consumer uses, unless such uses represent
308 | the only significant mode of use of the product.
309 | 
310 |   "Installation Information" for a User Product means any methods,
311 | procedures, authorization keys, or other information required to install
312 | and execute modified versions of a covered work in that User Product from
313 | a modified version of its Corresponding Source.  The information must
314 | suffice to ensure that the continued functioning of the modified object
315 | code is in no case prevented or interfered with solely because
316 | modification has been made.
317 | 
318 |   If you convey an object code work under this section in, or with, or
319 | specifically for use in, a User Product, and the conveying occurs as
320 | part of a transaction in which the right of possession and use of the
321 | User Product is transferred to the recipient in perpetuity or for a
322 | fixed term (regardless of how the transaction is characterized), the
323 | Corresponding Source conveyed under this section must be accompanied
324 | by the Installation Information.  But this requirement does not apply
325 | if neither you nor any third party retains the ability to install
326 | modified object code on the User Product (for example, the work has
327 | been installed in ROM).
328 | 
329 |   The requirement to provide Installation Information does not include a
330 | requirement to continue to provide support service, warranty, or updates
331 | for a work that has been modified or installed by the recipient, or for
332 | the User Product in which it has been modified or installed.  Access to a
333 | network may be denied when the modification itself materially and
334 | adversely affects the operation of the network or violates the rules and
335 | protocols for communication across the network.
336 | 
337 |   Corresponding Source conveyed, and Installation Information provided,
338 | in accord with this section must be in a format that is publicly
339 | documented (and with an implementation available to the public in
340 | source code form), and must require no special password or key for
341 | unpacking, reading or copying.
342 | 
343 |   7. Additional Terms.
344 | 
345 |   "Additional permissions" are terms that supplement the terms of this
346 | License by making exceptions from one or more of its conditions.
347 | Additional permissions that are applicable to the entire Program shall
348 | be treated as though they were included in this License, to the extent
349 | that they are valid under applicable law.  If additional permissions
350 | apply only to part of the Program, that part may be used separately
351 | under those permissions, but the entire Program remains governed by
352 | this License without regard to the additional permissions.
353 | 
354 |   When you convey a copy of a covered work, you may at your option
355 | remove any additional permissions from that copy, or from any part of
356 | it.  (Additional permissions may be written to require their own
357 | removal in certain cases when you modify the work.)  You may place
358 | additional permissions on material, added by you to a covered work,
359 | for which you have or can give appropriate copyright permission.
360 | 
361 |   Notwithstanding any other provision of this License, for material you
362 | add to a covered work, you may (if authorized by the copyright holders of
363 | that material) supplement the terms of this License with terms:
364 | 
365 |     a) Disclaiming warranty or limiting liability differently from the
366 |     terms of sections 15 and 16 of this License; or
367 | 
368 |     b) Requiring preservation of specified reasonable legal notices or
369 |     author attributions in that material or in the Appropriate Legal
370 |     Notices displayed by works containing it; or
371 | 
372 |     c) Prohibiting misrepresentation of the origin of that material, or
373 |     requiring that modified versions of such material be marked in
374 |     reasonable ways as different from the original version; or
375 | 
376 |     d) Limiting the use for publicity purposes of names of licensors or
377 |     authors of the material; or
378 | 
379 |     e) Declining to grant rights under trademark law for use of some
380 |     trade names, trademarks, or service marks; or
381 | 
382 |     f) Requiring indemnification of licensors and authors of that
383 |     material by anyone who conveys the material (or modified versions of
384 |     it) with contractual assumptions of liability to the recipient, for
385 |     any liability that these contractual assumptions directly impose on
386 |     those licensors and authors.
387 | 
388 |   All other non-permissive additional terms are considered "further
389 | restrictions" within the meaning of section 10.  If the Program as you
390 | received it, or any part of it, contains a notice stating that it is
391 | governed by this License along with a term that is a further
392 | restriction, you may remove that term.  If a license document contains
393 | a further restriction but permits relicensing or conveying under this
394 | License, you may add to a covered work material governed by the terms
395 | of that license document, provided that the further restriction does
396 | not survive such relicensing or conveying.
397 | 
398 |   If you add terms to a covered work in accord with this section, you
399 | must place, in the relevant source files, a statement of the
400 | additional terms that apply to those files, or a notice indicating
401 | where to find the applicable terms.
402 | 
403 |   Additional terms, permissive or non-permissive, may be stated in the
404 | form of a separately written license, or stated as exceptions;
405 | the above requirements apply either way.
406 | 
407 |   8. Termination.
408 | 
409 |   You may not propagate or modify a covered work except as expressly
410 | provided under this License.  Any attempt otherwise to propagate or
411 | modify it is void, and will automatically terminate your rights under
412 | this License (including any patent licenses granted under the third
413 | paragraph of section 11).
414 | 
415 |   However, if you cease all violation of this License, then your
416 | license from a particular copyright holder is reinstated (a)
417 | provisionally, unless and until the copyright holder explicitly and
418 | finally terminates your license, and (b) permanently, if the copyright
419 | holder fails to notify you of the violation by some reasonable means
420 | prior to 60 days after the cessation.
421 | 
422 |   Moreover, your license from a particular copyright holder is
423 | reinstated permanently if the copyright holder notifies you of the
424 | violation by some reasonable means, this is the first time you have
425 | received notice of violation of this License (for any work) from that
426 | copyright holder, and you cure the violation prior to 30 days after
427 | your receipt of the notice.
428 | 
429 |   Termination of your rights under this section does not terminate the
430 | licenses of parties who have received copies or rights from you under
431 | this License.  If your rights have been terminated and not permanently
432 | reinstated, you do not qualify to receive new licenses for the same
433 | material under section 10.
434 | 
435 |   9. Acceptance Not Required for Having Copies.
436 | 
437 |   You are not required to accept this License in order to receive or
438 | run a copy of the Program.  Ancillary propagation of a covered work
439 | occurring solely as a consequence of using peer-to-peer transmission
440 | to receive a copy likewise does not require acceptance.  However,
441 | nothing other than this License grants you permission to propagate or
442 | modify any covered work.  These actions infringe copyright if you do
443 | not accept this License.  Therefore, by modifying or propagating a
444 | covered work, you indicate your acceptance of this License to do so.
445 | 
446 |   10. Automatic Licensing of Downstream Recipients.
447 | 
448 |   Each time you convey a covered work, the recipient automatically
449 | receives a license from the original licensors, to run, modify and
450 | propagate that work, subject to this License.  You are not responsible
451 | for enforcing compliance by third parties with this License.
452 | 
453 |   An "entity transaction" is a transaction transferring control of an
454 | organization, or substantially all assets of one, or subdividing an
455 | organization, or merging organizations.  If propagation of a covered
456 | work results from an entity transaction, each party to that
457 | transaction who receives a copy of the work also receives whatever
458 | licenses to the work the party's predecessor in interest had or could
459 | give under the previous paragraph, plus a right to possession of the
460 | Corresponding Source of the work from the predecessor in interest, if
461 | the predecessor has it or can get it with reasonable efforts.
462 | 
463 |   You may not impose any further restrictions on the exercise of the
464 | rights granted or affirmed under this License.  For example, you may
465 | not impose a license fee, royalty, or other charge for exercise of
466 | rights granted under this License, and you may not initiate litigation
467 | (including a cross-claim or counterclaim in a lawsuit) alleging that
468 | any patent claim is infringed by making, using, selling, offering for
469 | sale, or importing the Program or any portion of it.
470 | 
471 |   11. Patents.
472 | 
473 |   A "contributor" is a copyright holder who authorizes use under this
474 | License of the Program or a work on which the Program is based.  The
475 | work thus licensed is called the contributor's "contributor version".
476 | 
477 |   A contributor's "essential patent claims" are all patent claims
478 | owned or controlled by the contributor, whether already acquired or
479 | hereafter acquired, that would be infringed by some manner, permitted
480 | by this License, of making, using, or selling its contributor version,
481 | but do not include claims that would be infringed only as a
482 | consequence of further modification of the contributor version.  For
483 | purposes of this definition, "control" includes the right to grant
484 | patent sublicenses in a manner consistent with the requirements of
485 | this License.
486 | 
487 |   Each contributor grants you a non-exclusive, worldwide, royalty-free
488 | patent license under the contributor's essential patent claims, to
489 | make, use, sell, offer for sale, import and otherwise run, modify and
490 | propagate the contents of its contributor version.
491 | 
492 |   In the following three paragraphs, a "patent license" is any express
493 | agreement or commitment, however denominated, not to enforce a patent
494 | (such as an express permission to practice a patent or covenant not to
495 | sue for patent infringement).  To "grant" such a patent license to a
496 | party means to make such an agreement or commitment not to enforce a
497 | patent against the party.
498 | 
499 |   If you convey a covered work, knowingly relying on a patent license,
500 | and the Corresponding Source of the work is not available for anyone
501 | to copy, free of charge and under the terms of this License, through a
502 | publicly available network server or other readily accessible means,
503 | then you must either (1) cause the Corresponding Source to be so
504 | available, or (2) arrange to deprive yourself of the benefit of the
505 | patent license for this particular work, or (3) arrange, in a manner
506 | consistent with the requirements of this License, to extend the patent
507 | license to downstream recipients.  "Knowingly relying" means you have
508 | actual knowledge that, but for the patent license, your conveying the
509 | covered work in a country, or your recipient's use of the covered work
510 | in a country, would infringe one or more identifiable patents in that
511 | country that you have reason to believe are valid.
512 | 
513 |   If, pursuant to or in connection with a single transaction or
514 | arrangement, you convey, or propagate by procuring conveyance of, a
515 | covered work, and grant a patent license to some of the parties
516 | receiving the covered work authorizing them to use, propagate, modify
517 | or convey a specific copy of the covered work, then the patent license
518 | you grant is automatically extended to all recipients of the covered
519 | work and works based on it.
520 | 
521 |   A patent license is "discriminatory" if it does not include within
522 | the scope of its coverage, prohibits the exercise of, or is
523 | conditioned on the non-exercise of one or more of the rights that are
524 | specifically granted under this License.  You may not convey a covered
525 | work if you are a party to an arrangement with a third party that is
526 | in the business of distributing software, under which you make payment
527 | to the third party based on the extent of your activity of conveying
528 | the work, and under which the third party grants, to any of the
529 | parties who would receive the covered work from you, a discriminatory
530 | patent license (a) in connection with copies of the covered work
531 | conveyed by you (or copies made from those copies), or (b) primarily
532 | for and in connection with specific products or compilations that
533 | contain the covered work, unless you entered into that arrangement,
534 | or that patent license was granted, prior to 28 March 2007.
535 | 
536 |   Nothing in this License shall be construed as excluding or limiting
537 | any implied license or other defenses to infringement that may
538 | otherwise be available to you under applicable patent law.
539 | 
540 |   12. No Surrender of Others' Freedom.
541 | 
542 |   If conditions are imposed on you (whether by court order, agreement or
543 | otherwise) that contradict the conditions of this License, they do not
544 | excuse you from the conditions of this License.  If you cannot convey a
545 | covered work so as to satisfy simultaneously your obligations under this
546 | License and any other pertinent obligations, then as a consequence you may
547 | not convey it at all.  For example, if you agree to terms that obligate you
548 | to collect a royalty for further conveying from those to whom you convey
549 | the Program, the only way you could satisfy both those terms and this
550 | License would be to refrain entirely from conveying the Program.
551 | 
552 |   13. Use with the GNU Affero General Public License.
553 | 
554 |   Notwithstanding any other provision of this License, you have
555 | permission to link or combine any covered work with a work licensed
556 | under version 3 of the GNU Affero General Public License into a single
557 | combined work, and to convey the resulting work.  The terms of this
558 | License will continue to apply to the part which is the covered work,
559 | but the special requirements of the GNU Affero General Public License,
560 | section 13, concerning interaction through a network will apply to the
561 | combination as such.
562 | 
563 |   14. Revised Versions of this License.
564 | 
565 |   The Free Software Foundation may publish revised and/or new versions of
566 | the GNU General Public License from time to time.  Such new versions will
567 | be similar in spirit to the present version, but may differ in detail to
568 | address new problems or concerns.
569 | 
570 |   Each version is given a distinguishing version number.  If the
571 | Program specifies that a certain numbered version of the GNU General
572 | Public License "or any later version" applies to it, you have the
573 | option of following the terms and conditions either of that numbered
574 | version or of any later version published by the Free Software
575 | Foundation.  If the Program does not specify a version number of the
576 | GNU General Public License, you may choose any version ever published
577 | by the Free Software Foundation.
578 | 
579 |   If the Program specifies that a proxy can decide which future
580 | versions of the GNU General Public License can be used, that proxy's
581 | public statement of acceptance of a version permanently authorizes you
582 | to choose that version for the Program.
583 | 
584 |   Later license versions may give you additional or different
585 | permissions.  However, no additional obligations are imposed on any
586 | author or copyright holder as a result of your choosing to follow a
587 | later version.
588 | 
589 |   15. Disclaimer of Warranty.
590 | 
591 |   THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
592 | APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
596 | PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
597 | IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
599 | 
600 |   16. Limitation of Liability.
601 | 
602 |   IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
610 | SUCH DAMAGES.
611 | 
612 |   17. Interpretation of Sections 15 and 16.
613 | 
614 |   If the disclaimer of warranty and limitation of liability provided
615 | above cannot be given local legal effect according to their terms,
616 | reviewing courts shall apply local law that most closely approximates
617 | an absolute waiver of all civil liability in connection with the
618 | Program, unless a warranty or assumption of liability accompanies a
619 | copy of the Program in return for a fee.
620 | 
621 |                      END OF TERMS AND CONDITIONS
622 | 
623 |             How to Apply These Terms to Your New Programs
624 | 
625 |   If you develop a new program, and you want it to be of the greatest
626 | possible use to the public, the best way to achieve this is to make it
627 | free software which everyone can redistribute and change under these terms.
628 | 
629 |   To do so, attach the following notices to the program.  It is safest
630 | to attach them to the start of each source file to most effectively
631 | state the exclusion of warranty; and each file should have at least
632 | the "copyright" line and a pointer to where the full notice is found.
633 | 
634 |     {one line to give the program's name and a brief idea of what it does.}
635 |     Copyright (C) {year}  {name of author}
636 | 
637 |     This program is free software: you can redistribute it and/or modify
638 |     it under the terms of the GNU General Public License as published by
639 |     the Free Software Foundation, either version 3 of the License, or
640 |     (at your option) any later version.
641 | 
642 |     This program is distributed in the hope that it will be useful,
643 |     but WITHOUT ANY WARRANTY; without even the implied warranty of
644 |     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
645 |     GNU General Public License for more details.
646 | 
647 |     You should have received a copy of the GNU General Public License
648 |     along with this program.  If not, see <http://www.gnu.org/licenses/>.
649 | 
650 | Also add information on how to contact you by electronic and paper mail.
651 | 
652 |   If the program does terminal interaction, make it output a short
653 | notice like this when it starts in an interactive mode:
654 | 
655 |     {project}  Copyright (C) {year}  {fullname}
656 |     This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657 |     This is free software, and you are welcome to redistribute it
658 |     under certain conditions; type `show c' for details.
659 | 
660 | The hypothetical commands `show w' and `show c' should show the appropriate
661 | parts of the General Public License.  Of course, your program's commands
662 | might be different; for a GUI interface, you would use an "about box".
663 | 
664 |   You should also get your employer (if you work as a programmer) or school,
665 | if any, to sign a "copyright disclaimer" for the program, if necessary.
666 | For more information on this, and how to apply and follow the GNU GPL, see
667 | <http://www.gnu.org/licenses/>.
668 | 
669 |   The GNU General Public License does not permit incorporating your program
670 | into proprietary programs.  If your program is a subroutine library, you
671 | may consider it more useful to permit linking proprietary applications with
672 | the library.  If this is what you want to do, use the GNU Lesser General
673 | Public License instead of this License.  But first, please read
674 | <http://www.gnu.org/philosophy/why-not-lgpl.html>.
675 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | [![Travis](https://img.shields.io/travis/iilab/contentascode.svg)](https://travis-ci.org/iilab/contentascode) [![Content as Code](https://img.shields.io/badge/contentascode-deployed-green.svg)](http://iilab.github.io/contentascode)
 2 | 
 3 | # Content as Code
 4 | 
 5 | **Content as Code** is a partnership which develops workflows and technology to improve content re-use and maintainability.
 6 | 
 7 | It is formed of implementers in organisations publishing free/libre and open source content and wanting to have lightweight (post-CMS) approaches to content management that focus on the author experience (as well as editor and translator experience).
 8 | 
 9 | ## Goals
10 | 
11 | To develop workflows and technology to **make content authoring and management benefit from software engineering collaboration best practices**.
12 | 
13 | In particular by:
14 |  - Using **Git** for version control
15 |  - Using **Markdown** and enhanced flavors of Markdown for authoring
16 |  - Developing better tools focusing on **author experience**
17 |  - Developing pathways for **content contribution and review**
18 |  - Enabling **translation workflows**
19 |  - Support **static website generation** and interoperability with **content management systems**
20 |  - Enabling content reuse
21 | 
22 | # Roadmap
23 | 
24 |   - [Lift off](https://github.com/iilab/contentascode/milestones)
25 | 
26 | # Reference Implementation
27 | 
28 | This repo contains the source (```master``` branch) and generated (```gh-pages``` branch) site which is building http://iilab.github.io/contentascode
29 | 
30 | It is a reference implementation for the crump workflow for Github/Github Pages/Prose/Transifex and also depends on:
31 |  - https://github.com
32 |  - https://prose.io
33 |  - https://transifex.com
34 | 
35 | Other implementations based on self-hosted software Gitlab/Jekyll/Prose will be developed.
36 | 
37 | ## Install
38 | 
39 |  - You might need a ruby version manager (such as rvm)
40 |  - You might need to ```bundle update```
41 | 
42 | ## Build
43 | 
44 | This repo should build automatically on Github Pages. To build the site locally for development:
45 | 
46 | ```
47 | bundle exec jekyll serve --watch --baseurl ''
48 | ```
49 | 
50 | You can also run ```bundle exec jekyll build``` (to generate the site in ```/_site```) or ```bundle exec jekyll serve``` (optionally with the ```--watch``` flag to rebuild automatically when a source markdown file changes) 
51 | 
52 | ## Notes
53 | 
54 |  - This site was built with the [Hyde](https://github.com/poole/hyde) theme.
55 |  - [Minor changes were made](https://github.com/poole/hyde/compare/master...iilab:master) such as:
56 |    - adding the ```gems``` key/values
57 |    - removing the ```relative_permalinks: true``` 
58 |    - kramdown's auto table of contents
59 |    - adding source and edit links
60 |  - I use [this trick](http://stackoverflow.com/a/7472481) to keep the master branch synchronised with the gh-pages branch
61 | 


--------------------------------------------------------------------------------
/_config.yml:
--------------------------------------------------------------------------------
 1 | markdown: kramdown
 2 | permalink: pretty
 3 | title: Content as Code
 4 | tagline: Developing workflows and technology to improve content re-use and maintainability.
 5 | description: Developing workflows and technology to improve content re-use and maintainability.
 6 | url: 'http://iilab.github.io'
 7 | baseurl: /contentascode
 8 | author:
 9 |   name: Jun Matsushita (iilab.org)
10 |   url: 'https://twitter.com/iilab'
11 | defaults:
12 |   - scope:
13 |       path: ''
14 |     values:
15 |       layout: default
16 | kramdown:
17 |   input: GFM
18 |   auto_ids: true
19 |   footnote_nr: 1
20 |   entity_output: as_char
21 |   toc_levels: 1..3
22 |   enable_coderay: false
23 | redcarpet:
24 |   extensions:
25 |     - tables
26 |     - autolink
27 |     - strikethrough
28 |     - space_after_headers
29 |     - with_toc_data
30 |     - fenced_code_blocks
31 |     - lax_spacing
32 |     - smart
33 | github:
34 |   current_branch: master
35 |   repository_url: 'https://github.com/iilab/contentascode'
36 | gems:
37 |   - jekyll-sitemap
38 |   - jekyll-gist
39 | safe: false
40 | lsi: false
41 | exclude:
42 |   - README.md
43 |   - Rakefile
44 |   - Gemfile
45 |   - Gemfile.lock
46 |   - changelog.md
47 |   - '*.Rmd'
48 |   - vendor
49 |   - .travis.yml
50 | username: jmatsushita
51 | owner: iilab
52 | repo: contentascode
53 | 


--------------------------------------------------------------------------------
/_content.yml:
--------------------------------------------------------------------------------
1 | source: .
2 | implementation: docsmith
3 | integration:
4 |   travis:
5 |     branch: 'versions/*'
6 |     build: rake
7 |     validate:
8 |       - links
9 | 


--------------------------------------------------------------------------------
/_includes/head.html:
--------------------------------------------------------------------------------
 1 | <head>
 2 |   <link href="http://gmpg.org/xfn/11" rel="profile">
 3 |   <meta http-equiv="X-UA-Compatible" content="IE=edge">
 4 |   <meta http-equiv="content-type" content="text/html; charset=utf-8">
 5 | 
 6 |   <!-- Enable responsiveness on mobile devices-->
 7 |   <meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1">
 8 | 
 9 |   <title>
10 |     {% if page.title == "Home" %}
11 |       {{ site.title }} &middot; {{ site.tagline }}
12 |     {% else %}
13 |       {{ page.title }} &middot; {{ site.title }}
14 |     {% endif %}
15 |   </title>
16 | 
17 |   <!-- CSS -->
18 |   <link rel="stylesheet" href="{{ site.baseurl }}/public/css/poole.css">
19 |   <link rel="stylesheet" href="{{ site.baseurl }}/public/css/syntax.css">
20 |   <link rel="stylesheet" href="{{ site.baseurl }}/public/css/hyde.css">
21 |   <link rel="stylesheet" href="http://fonts.googleapis.com/css?family=PT+Sans:400,400italic,700|Abril+Fatface">
22 | 
23 |   <!-- Icons -->
24 |   <!--
25 |   <link rel="apple-touch-icon-precomposed" sizes="144x144" href="{{ site.baseurl }}/public/apple-touch-icon-144-precomposed.png">
26 |                                  <link rel="shortcut icon" href="{{ site.baseurl }}/public/favicon.ico"> -->
27 |   <link rel="icon" type="image/svg+xml" href="images/icon.svg">
28 | 
29 |   <!-- RSS -->
30 |   <link rel="alternate" type="application/rss+xml" title="RSS" href="{{ site.baseurl }}/atom.xml">
31 | </head>
32 | 


--------------------------------------------------------------------------------
/_includes/sidebar.html:
--------------------------------------------------------------------------------
 1 | <div class="sidebar">
 2 |   <div class="container sidebar-sticky">
 3 |     <div class="sidebar-about">
 4 |       <h1>
 5 |         <a href="{{ site.baseurl }}">
 6 |           {{ site.title }}
 7 |         </a>
 8 |       </h1>
 9 |       <p class="lead">{{ site.description }}</p>
10 |     </div>
11 | 
12 |     <nav class="sidebar-nav">
13 |       <a class="sidebar-nav-item{% if page.url == site.baseurl %} active{% endif %}" href="{{ site.baseurl }}/">Home</a>
14 | 
15 |       {% comment %}
16 |         The code below dynamically generates a sidebar nav of pages with
17 |         `layout: page` in the front-matter. See readme for usage.
18 |       {% endcomment %}
19 | 
20 |       {% assign pages_list = site.pages %}
21 |       {% for node in pages_list %}
22 |         {% if node.title != null %}
23 |           {% if node.layout == "page" %}
24 |             <a class="sidebar-nav-item{% if page.url == node.url %} active{% endif %}" href="{{ site.baseurl }}{{ node.url }}">{{ node.title }}</a>
25 |           {% endif %}
26 |         {% endif %}
27 |       {% endfor %}
28 | 
29 |       <a class="sidebar-nav-item" href="{{ site.github.repository_url }}">GitHub project</a>
30 | 
31 |     </nav>
32 | 
33 |     <p>&copy; {{ site.time | date: '%Y' }}. All rights reserved.</p>
34 |   </div>
35 | </div>
36 | 


--------------------------------------------------------------------------------
/_layouts/default.html:
--------------------------------------------------------------------------------
 1 | <!DOCTYPE html>
 2 | <html lang="en-us">
 3 | 
 4 |   {% include head.html %}
 5 | 
 6 |   <body>
 7 | 
 8 |     {% include sidebar.html %}
 9 | 
10 |     <div class="content container">
11 | 
12 |     <div>
13 |       {% assign crumbs = page.url | remove:'/index.html' | split: '/' %}
14 |       <small>
15 |         <div style="float:left"><a href="{{ site.baseurl }}/">Home</a>
16 |         {% for crumb in crumbs offset: 1 %}
17 |           {% if forloop.last %}
18 |             / {{ crumb | replace:'-',' ' | remove:'.html' | capitalize }}
19 |           {% else %}
20 |             / <a href="{{ site.baseurl }}{% assign crumb_limit = forloop.index | plus: 1 %}{% for crumb in crumbs limit: crumb_limit %}{{ crumb | append: '/' }}{% endfor %}">{{ crumb | replace:'-',' ' | remove:'.html' | capitalize }}</a>
21 |           {% endif %}
22 |         {% endfor %}
23 |         </div>
24 | 
25 |         <div style="float:right"><em><a href="{{site.github.repository_url}}/edit/{{site.github.current_branch}}/{{page.path}}">Edit this page</a> - <a href="{{site.github.repository_url}}/commits/{{site.github.current_branch}}/{{page.path}}">View page history</a> - <a href="{{site.github.repository_url}}/tree/{{site.github.current_branch}}/{{page.path}}">View page source</a></em>
26 |         </div>
27 |       </small>
28 |     </div>
29 | 
30 |     <div class="page" style="clear:both">
31 |       <h1 class="page-title">{{ page.title }}</h1>
32 |       {{ content }}
33 |     </div>
34 | 
35 |     </div>
36 | 
37 |   </body>
38 | </html>
39 | 


--------------------------------------------------------------------------------
/_layouts/page.html:
--------------------------------------------------------------------------------
1 | ---
2 | layout: default
3 | ---
4 | 
5 |   {{ content }}
6 | 


--------------------------------------------------------------------------------
/_layouts/post.html:
--------------------------------------------------------------------------------
 1 | ---
 2 | layout: default
 3 | ---
 4 | 
 5 | <div class="post">
 6 |   <h1 class="post-title">{{ page.title }}</h1>
 7 |   <span class="post-date">{{ page.date | date_to_string }}</span>
 8 |   {{ content }}
 9 | </div>
10 | 
11 | <div class="related">
12 |   <h2>Related Posts</h2>
13 |   <ul class="related-posts">
14 |     {% for post in site.related_posts limit:3 %}
15 |       <li>
16 |         <h3>
17 |           <a href="{{ post.url }}">
18 |             {{ post.title }}
19 |             <small>{{ post.date | date_to_string }}</small>
20 |           </a>
21 |         </h3>
22 |       </li>
23 |     {% endfor %}
24 |   </ul>
25 | </div>
26 | 


--------------------------------------------------------------------------------
/_posts/2012-02-06-whats-jekyll.md:
--------------------------------------------------------------------------------
 1 | ---
 2 | layout: post
 3 | title: What's Jekyll?
 4 | ---
 5 | 
 6 | [Jekyll](http://jekyllrb.com) is a static site generator, an open-source tool for creating simple yet powerful websites of all shapes and sizes. From [the project's readme](https://github.com/mojombo/jekyll/blob/master/README.markdown):
 7 | 
 8 |   > Jekyll is a simple, blog aware, static site generator. It takes a template directory [...] and spits out a complete, static website suitable for serving with Apache or your favorite web server. This is also the engine behind GitHub Pages, which you can use to host your project’s page or blog right here from GitHub.
 9 | 
10 | It's an immensely useful tool and one we encourage you to use here with Hyde.
11 | 
12 | Find out more by [visiting the project on GitHub](https://github.com/mojombo/jekyll).


--------------------------------------------------------------------------------
/_posts/2012-02-07-example-content.md:
--------------------------------------------------------------------------------
  1 | ---
  2 | layout: post
  3 | title: Example content
  4 | ---
  5 | 
  6 | 
  7 | <div class="message">
  8 |   Howdy! This is an example blog post that shows several types of HTML content supported in this theme.
  9 | </div>
 10 | 
 11 | Cum sociis natoque penatibus et magnis <a href="#">dis parturient montes</a>, nascetur ridiculus mus. *Aenean eu leo quam.* Pellentesque ornare sem lacinia quam venenatis vestibulum. Sed posuere consectetur est at lobortis. Cras mattis consectetur purus sit amet fermentum.
 12 | 
 13 | > Curabitur blandit tempus porttitor. Nullam quis risus eget urna mollis ornare vel eu leo. Nullam id dolor id nibh ultricies vehicula ut id elit.
 14 | 
 15 | Etiam porta **sem malesuada magna** mollis euismod. Cras mattis consectetur purus sit amet fermentum. Aenean lacinia bibendum nulla sed consectetur.
 16 | 
 17 | ## Inline HTML elements
 18 | 
 19 | HTML defines a long list of available inline tags, a complete list of which can be found on the [Mozilla Developer Network](https://developer.mozilla.org/en-US/docs/Web/HTML/Element).
 20 | 
 21 | - **To bold text**, use `<strong>`.
 22 | - *To italicize text*, use `<em>`.
 23 | - Abbreviations, like <abbr title="HyperText Markup Langage">HTML</abbr> should use `<abbr>`, with an optional `title` attribute for the full phrase.
 24 | - Citations, like <cite>&mdash; Mark otto</cite>, should use `<cite>`.
 25 | - <del>Deleted</del> text should use `<del>` and <ins>inserted</ins> text should use `<ins>`.
 26 | - Superscript <sup>text</sup> uses `<sup>` and subscript <sub>text</sub> uses `<sub>`.
 27 | 
 28 | Most of these elements are styled by browsers with few modifications on our part.
 29 | 
 30 | ## Heading
 31 | 
 32 | Vivamus sagittis lacus vel augue rutrum faucibus dolor auctor. Duis mollis, est non commodo luctus, nisi erat porttitor ligula, eget lacinia odio sem nec elit. Morbi leo risus, porta ac consectetur ac, vestibulum at eros.
 33 | 
 34 | ### Code
 35 | 
 36 | Cum sociis natoque penatibus et magnis dis `code element` montes, nascetur ridiculus mus.
 37 | 
 38 | {% highlight js %}
 39 | // Example can be run directly in your JavaScript console
 40 | 
 41 | // Create a function that takes two arguments and returns the sum of those arguments
 42 | var adder = new Function("a", "b", "return a + b");
 43 | 
 44 | // Call the function
 45 | adder(2, 6);
 46 | // > 8
 47 | {% endhighlight %}
 48 | 
 49 | Aenean lacinia bibendum nulla sed consectetur. Etiam porta sem malesuada magna mollis euismod. Fusce dapibus, tellus ac cursus commodo, tortor mauris condimentum nibh, ut fermentum massa.
 50 | 
 51 | ### Gists via GitHub Pages
 52 | 
 53 | Vestibulum id ligula porta felis euismod semper. Nullam quis risus eget urna mollis ornare vel eu leo. Donec sed odio dui.
 54 | 
 55 | {% gist 5555251 gist.md %}
 56 | 
 57 | Aenean eu leo quam. Pellentesque ornare sem lacinia quam venenatis vestibulum. Nullam quis risus eget urna mollis ornare vel eu leo. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Donec sed odio dui. Vestibulum id ligula porta felis euismod semper.
 58 | 
 59 | ### Lists
 60 | 
 61 | Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Aenean lacinia bibendum nulla sed consectetur. Etiam porta sem malesuada magna mollis euismod. Fusce dapibus, tellus ac cursus commodo, tortor mauris condimentum nibh, ut fermentum massa justo sit amet risus.
 62 | 
 63 | * Praesent commodo cursus magna, vel scelerisque nisl consectetur et.
 64 | * Donec id elit non mi porta gravida at eget metus.
 65 | * Nulla vitae elit libero, a pharetra augue.
 66 | 
 67 | Donec ullamcorper nulla non metus auctor fringilla. Nulla vitae elit libero, a pharetra augue.
 68 | 
 69 | 1. Vestibulum id ligula porta felis euismod semper.
 70 | 2. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus.
 71 | 3. Maecenas sed diam eget risus varius blandit sit amet non magna.
 72 | 
 73 | Cras mattis consectetur purus sit amet fermentum. Sed posuere consectetur est at lobortis.
 74 | 
 75 | <dl>
 76 |   <dt>HyperText Markup Language (HTML)</dt>
 77 |   <dd>The language used to describe and define the content of a Web page</dd>
 78 | 
 79 |   <dt>Cascading Style Sheets (CSS)</dt>
 80 |   <dd>Used to describe the appearance of Web content</dd>
 81 | 
 82 |   <dt>JavaScript (JS)</dt>
 83 |   <dd>The programming language used to build advanced Web sites and applications</dd>
 84 | </dl>
 85 | 
 86 | Integer posuere erat a ante venenatis dapibus posuere velit aliquet. Morbi leo risus, porta ac consectetur ac, vestibulum at eros. Nullam quis risus eget urna mollis ornare vel eu leo.
 87 | 
 88 | ### Images
 89 | 
 90 | Quisque consequat sapien eget quam rhoncus, sit amet laoreet diam tempus. Aliquam aliquam metus erat, a pulvinar turpis suscipit at.
 91 | 
 92 | ![placeholder](http://placehold.it/800x400 "Large example image")
 93 | ![placeholder](http://placehold.it/400x200 "Medium example image")
 94 | ![placeholder](http://placehold.it/200x200 "Small example image")
 95 | 
 96 | ### Tables
 97 | 
 98 | Aenean lacinia bibendum nulla sed consectetur. Lorem ipsum dolor sit amet, consectetur adipiscing elit.
 99 | 
100 | <table>
101 |   <thead>
102 |     <tr>
103 |       <th>Name</th>
104 |       <th>Upvotes</th>
105 |       <th>Downvotes</th>
106 |     </tr>
107 |   </thead>
108 |   <tfoot>
109 |     <tr>
110 |       <td>Totals</td>
111 |       <td>21</td>
112 |       <td>23</td>
113 |     </tr>
114 |   </tfoot>
115 |   <tbody>
116 |     <tr>
117 |       <td>Alice</td>
118 |       <td>10</td>
119 |       <td>11</td>
120 |     </tr>
121 |     <tr>
122 |       <td>Bob</td>
123 |       <td>4</td>
124 |       <td>3</td>
125 |     </tr>
126 |     <tr>
127 |       <td>Charlie</td>
128 |       <td>7</td>
129 |       <td>9</td>
130 |     </tr>
131 |   </tbody>
132 | </table>
133 | 
134 | Nullam id dolor id nibh ultricies vehicula ut id elit. Sed posuere consectetur est at lobortis. Nullam quis risus eget urna mollis ornare vel eu leo.
135 | 
136 | -----
137 | 
138 | Want to see something else added? <a href="https://github.com/poole/poole/issues/new">Open an issue.</a>
139 | 


--------------------------------------------------------------------------------
/_posts/2013-12-28-introducing-hyde.md:
--------------------------------------------------------------------------------
 1 | ---
 2 | layout: post
 3 | title: Introducing Hyde
 4 | ---
 5 | 
 6 | Hyde is a brazen two-column [Jekyll](http://jekyllrb.com) theme that pairs a prominent sidebar with uncomplicated content. It's based on [Poole](http://getpoole.com), the Jekyll butler.
 7 | 
 8 | ### Built on Poole
 9 | 
10 | Poole is the Jekyll Butler, serving as an upstanding and effective foundation for Jekyll themes by [@mdo](https://twitter.com/mdo). Poole, and every theme built on it (like Hyde here) includes the following:
11 | 
12 | * Complete Jekyll setup included (layouts, config, [404](/404), [RSS feed](/atom.xml), posts, and [example page](/about))
13 | * Mobile friendly design and development
14 | * Easily scalable text and component sizing with `rem` units in the CSS
15 | * Support for a wide gamut of HTML elements
16 | * Related posts (time-based, because Jekyll) below each post
17 | * Syntax highlighting, courtesy Pygments (the Python-based code snippet highlighter)
18 | 
19 | ### Hyde features
20 | 
21 | In addition to the features of Poole, Hyde adds the following:
22 | 
23 | * Sidebar includes support for textual modules and a dynamically generated navigation with active link support
24 | * Two orientations for content and sidebar, default (left sidebar) and [reverse](https://github.com/poole/lanyon#reverse-layout) (right sidebar), available via `<body>` classes
25 | * [Eight optional color schemes](https://github.com/poole/hyde#themes), available via `<body>` classes
26 | 
27 | [Head to the readme](https://github.com/poole/hyde#readme) to learn more.
28 | 
29 | ### Browser support
30 | 
31 | Hyde is by preference a forward-thinking project. In addition to the latest versions of Chrome, Safari (mobile and desktop), and Firefox, it is only compatible with Internet Explorer 9 and above.
32 | 
33 | ### Download
34 | 
35 | Hyde is developed on and hosted with GitHub. Head to the <a href="https://github.com/poole/hyde">GitHub repository</a> for downloads, bug reports, and features requests.
36 | 
37 | Thanks!
38 | 


--------------------------------------------------------------------------------
/_posts/2016-07-29-metalsmith-part1.md:
--------------------------------------------------------------------------------
  1 | ---
  2 | layout: post
  3 | title: Metalsmith Static Website Generator: Plugins
  4 | ---
  5 | 
  6 | As Content management systems become increasingly bloated, buggy, and rife with security exploits, programmers are looking for better website creation tools. The <a href="https://developmentseed.org/blog/2012/07/27/build-cms-free-websites/">post-CMS</a> approach replaces poorly coded and integrated functionality of CMS programs with a suite of established open source tools such as Static Website Generators, Git version control, web-based content editors, and microservices. The new movement called <a href="http://iilab.github.io/contentascode">Content As Code,</a> aims for programmers to limit program complexity and pick the tools that most support the content. In this post I will review <a href="http://www.metalsmith.io">Metalsmith</a> Static Website Generator and walk through several core Metalsmith plugins that aim to provide powerful functionality using as little code as possible. I will also show how plugin functionality is invoked and why this is essential. You will gain a practical understanding of Static Generator applications as an alternative to CMS program page creation process. This post is intended as an introduction for new programmers. 
  7 | 
  8 | To generate static pages, Metalsmith reads content in a source directory, executes a series of actions defined by plugins, and writes the processed data to a destination directory. The sequential compiling of plugins is a process unique to Metalsmith. Within the context of Metalsmith, plugins are single purpose components invoked by a configuration file.  Remarkable in comparison to traditional CMS programs like Drupal, only two plugins, metalsmith-markdown and metalsmith-layouts, are necessary to generate a static page.
  9 | 
 10 | Metalsmith source files are formatted using<a href ="http://daringfireball.net/projects/markdown/syntax#precode"> markdown </a>. Because markdown is a plain text language, it is both human readable and easily translated to HTML and many other languages. 
 11 | 
 12 | * An example of a simple markdown file.
 13 | ```
 14 | ---
 15 | title: First Post
 16 | date: 2012-08-20
 17 | layout: post.html
 18 | ---
 19 | An interesting post about how it's going to be different this time around. I'm going write a lot more nowadays and use this blog to improve my writing.
 20 | ```
 21 | Markdown files consist of <a href ="https://jekyllrb.com/docs/frontmatter/">frontmatter</a> and content. The frontmatter, which is flanked by a set of dashed lines, is metadata that provides Metalsmith and it’s plugins with parameters for handling the file’s content. Everything after frontmatter is considered content. 
 22 | 
 23 | Metalsmith-markdown plugin translates markdown syntax to HTML. 
 24 | 
 25 | * The translated content from the previous example looks like this.
 26 | ```
 27 | <p>An interesting post about how it&#39;s going to be different this time around. I&#39;m going write a lot more nowadays and use this blog to improve my writing.</p>
 28 | ```
 29 | ----------
 30 | To then structure the file, Metalsmith-layouts plugin parses the HTML tagged content into a layout template defined in the source file’s frontmatter.
 31 | 
 32 | * An example of a template file.
 33 | ```
 34 | <html>
 35 | <head>
 36 |   <title>My Blog</title>
 37 | </head>
 38 | <body>
 39 |   <h1 style="color:{{ color }}">{{ title }}</h1>
 40 |   <time>{{ date | date('Y-m-d') }}</time>
 41 |   {{ contents | safe }}
 42 | </body>
 43 | </html>
 44 | ```
 45 | * A set of double brackets indicates placeholders in the template file where metalsmith-layouts parses in content from the source file. 
 46 | ```
 47 | {{ contents | safe }}
 48 | ```
 49 | 
 50 | * Template files also contain placeholders where frontmatter content is inserted. 
 51 | 
 52 | A frontmatter pattern.
 53 | ```
 54 | {{ title }}
 55 | ```
 56 | * Relevant frontmatter.
 57 | ```
 58 | title: First Post
 59 | ```
 60 | ----------
 61 | * The compiled markdown and template outputs a static webpage.
 62 | ```
 63 | <html>
 64 | <head>
 65 |   <title>My Blog</title>
 66 | </head>
 67 | <body>
 68 |   <h1 style="color:">First Post</h1>
 69 |   <time>2012-08-20</time>
 70 |   <p>An interesting post about how it&#39;s going to be different this time around. I&#39;m going write a lot more nowadays and use this blog to improve my writing.</p>
 71 | </body>
 72 | </html>
 73 | ```
 74 | ----------
 75 | Metalsmith-markdown and Metalsmith-layouts is all that is required to render a basic static webpage. However, there are many more plugins to choose from to add functionality. Next, I walk through three additional plugins, metalsmith-permalinks, metalsmith-drafts, and metalsmith-debug. 
 76 | 
 77 | To structure a permalink, a formatted file path, metalsmith-permalinks plugin transforms file names with a pattern. A key/value pair provides the pattern parameters. Plugin objects and their parameters are invoked in the main Metalsmith configuration file, metalsmith.json.
 78 | ```
 79 | "metalsmith-permalinks": {
 80 |         "pattern": ":title"
 81 |      }
 82 | ```
 83 | In this example, Metalsmith-permalinks generates a permalink based on the title provided in the frontmatter.
 84 | 
 85 | * Relevant frontmatter.
 86 | ```
 87 | title: First Post
 88 | ```
 89 | * The generated permalink.
 90 | ```
 91 | first_post/index.html 
 92 | ```
 93 | ----------
 94 | The ability to create draft pages is an important tool in managing website content. It allows for content creation and page publication to be controlled separately. Metalsmith-drafts plugin looks to see if the source file is earmarked as a draft. 
 95 | 
 96 | ```
 97 | draft: true
 98 | ``` 
 99 | If this is the case, Metalsmith does not generate a static html file.
100 | 
101 | ----------
102 | Logging tools are essential to understanding and debugging code. Metalsmith-debug plugin enables processing and compiling logs. To view the most recent log file enter into the terminal window.
103 | ```
104 | DEBUG=* metalsmith 
105 | ```
106 | ----------
107 | 
108 | Because plugins are separate components, a good mechanism for managing and invoking them is vital. This is the job of the metalsmith.json configuration file. It contains all necessary plugin parameters in one plugin object.
109 | 
110 | ```
111 | {
112 |   "source": "./_posts",
113 |   "destination": "./_site",
114 |   "metadata": {
115 |     "title": "My Jekyll-Powered Blog",
116 |     "description": "My second, super-cool, Jekyll-powered blog."
117 |   },
118 |     "plugins": {
119 |       "metalsmith-markdown": {},
120 |       "metalsmith-drafts": true,
121 |       "metalsmith-permalinks": {
122 |         "pattern": ":title"
123 |      },
124 | 
125 |       "metalsmith-layouts": {
126 |          "engine": "swig",
127 |          "directory": "_layouts"
128 |     },
129 |      "metalsmith-debug": {}
130 |   }
131 | }
132 | ```
133 | The small file also contains metadata, including the locations of source and destination directories.
134 | 
135 | In summary, Metalsmith is comprised of separate single function plugins managed by one configuration file. Rather than the default extensive and interdependent functionality of a CMS program, Metalsmith’s modular components and lean programming enables better control of the page creation process which in turn promotes site ownership. Metalsmith and Static Web Generators are just one tool in the post-CMS goal of content prioritization. I encourage you to read further about <a href ="https://www.staticgen.com">Static Website Generators</a> and explore some additional tools such as <a href="https://git-scm.com">Git version control</a> and <a href="http://prose.io/#about">web-based content editors.</a>
136 | 
137 | 
138 | 
139 | 
140 | 
141 | 
142 | 
143 | 


--------------------------------------------------------------------------------
/approach.md:
--------------------------------------------------------------------------------
 1 | ---
 2 | layout: page
 3 | title: Approach
 4 | ---
 5 | 
 6 | > [Contribute your ideas and discuss the approach of Content as Code](https://github.com/iilab/contentascode/issues/1)
 7 | 
 8 | * TOC
 9 | {:toc}
10 | 
11 | 
12 | ## Design Goals
13 | 
14 | These goals articulate our user-centric focus applied to the author/editor/translator/publisher experiences.
15 | 
16 | ### Focused Writing
17 | 
18 | > The ability for authors to focus on their content and not have to think about the technology is a design goal.
19 | 
20 | The tools should disappear (literally with distraction free modes, or when using tools that are so familiar to us that we don't pay attention to them anymore - like the keyboard, or... Word).
21 | 
22 | Being able to let authors use the tools that allow them to be most productive and happy is a key goal of Content as Code. Allowing a diversity of tools to be used in this workflow is a design goal, but promoting and prioritising tools that are open source, modular and well designed is part of the implementation approach.
23 | 
24 | Read more about the [technology approach for content authoring](../technology/authoring)
25 | 
26 | ### Localisation and translation
27 | 
28 | > Integrating translation and localisation deeply in the workflow and without adding complexity is a design goal.
29 | 
30 | Read more about the [technology approach for translation](../technology/translation)
31 | 
32 | ### Low barrier to collaboration
33 | 
34 | > Allowing others to spot problems, develop new content or adapt content for new purposes is a design goal.
35 | 
36 | This should include the collaborative creation, adaptation and translation of content in sprints, remotely or with other innovative approaches.
37 | 
38 | ### Track changes and manage contributions
39 | 
40 | > Maintain editorial coherence by making it easy to track, review and comment on changes coming from a range of sources and improving the editor's experience is a design goal.
41 | 
42 | ### Content Reuse
43 | 
44 | > Allowing the discovery, tracking and updating of content used from other sources is a design goal.
45 | 
46 | Multimedia content, internal links or external links should be easy to navigate and include in content.
47 | 
48 | ### Multiple publication channels
49 | 
50 | > Publishing to the web, books, mobile apps or other channels is a design goal.
51 | 
52 | # Content as Code Approach
53 | 
54 | There is a problem with content management in a [Post-CMS](#what-does-post-cms-means) context. For projects which have complex editorial workflows, adopting more lightweight approaches such as static site generation is still difficult, can create friction and are lacking in functionality.
55 | 
56 | Software engineering as a discipline, has been dealing with complex contribution processes requiring to create, move, merge, transform large quantities of code. This has led to the creation of tool to be able to trace the history of changes, allow very large team contributing to similar code bases and manage, reuse vast amounts of other project's code, track changes and organise review by peers, manage documentation and its obsolecence, translations of manuals and software, test problems as early as possible in order to rapidly and frequently build software artifacts that can be deployed across servers, computer and mobile devices.
57 | 
58 | [![dependencies](../images/dependencies.png)](../images/dependencies.png)
59 | 
60 | Applying these concepts and lessons to editorial workflows is not trivial and requires a strong focus on author experience (as well as editor and translator experience).
61 | 
62 | ## FAQ
63 | 
64 | ### What does Post-CMS mean?
65 | 
66 | That we've been seduced and then disappointed by [CMSes](https://en.wikipedia.org/wiki/Content_management_system "Content Management Systems") which add too much complexity and therefore create problems of maintainability of content.
67 | 
68 | ### Why use Markdown and not AsciiDoc/ReStructure/Textile/Wiki syntax?
69 | 
70 | That's a question of taste and we'll focus on Markdown first but we'll implement other syntaxes (and focus on software libraries that can switch syntaxes) and will accept contributions that go in this direction.
71 | 
72 | ### Why not use XML/JSON/YAML... as the storage format?
73 | 
74 | Having a format which is has a track record for data storage seems like a natural direction to go to, however the popularity of Markdown and of formats like YAML (both used as the data format in this format, like in Jekyll and other static website generators) is based on the fact that the representation of the content/data is elegant mainly because it removes clutter/noise and it is more resilient to syntax errors (which some could see as allowing more data corruptions).
75 | 
76 | With this approach the thinking is that data corruptions will be caught by a quick feedback loop to the author, or simply by hiding structured data.
77 | 
78 | ### Markdown + YAML or whatever format you design to store content/data is not proven!
79 | 
80 | That's not a question but ok, we understand why you're excited or worried about this. It's true that Markdown has a history of causing pains because of loose specifications but that's pretty much settled with the [CommonMark standard](http://commonmark.org/) with a wide range of [compliant implementations](https://github.com/jgm/CommonMark/wiki/List-of-CommonMark-Implementations). Also what we're proposing is to introduce block-level metadata or [```middlematter```](https://github.com/iilab/contentascode/issues/12). There is a tradition of deriving markdown and adding flavors. This has led to a ecosystem of sometimes competing approaches to do similar things (syntax for tables is a good example of this). We'll make sure to follow this tradition and generate a strong specification for our flavor. Given that the existing practice is already to mix Markdown and YAML, Markdown probably only needs to be extended very minimally in able to allow YAML to be included inline, in a way that is elegant and minimises clutter.
81 | 
82 | This integration should result in 2 well defined approaches to be used as a storage format and provide equivalence to other better known formats.
83 | 
84 | ### Why not create a Word plugin?
85 | 
86 | Yes! There are existing plugins to manage Markdown in Word and this fits our goals to be interoperable and extensible.
87 | 
88 | ### What about open formats for multimedia content
89 | 
90 | Yes! We love SVG and projects like MermaidJS which are promising ways to develop graphical content which can be reused, remixed and composed.
91 | 
92 | 


--------------------------------------------------------------------------------
/atom.xml:
--------------------------------------------------------------------------------
 1 | ---
 2 | layout: null
 3 | ---
 4 | 
 5 | <?xml version="1.0" encoding="utf-8"?>
 6 | <feed xmlns="http://www.w3.org/2005/Atom">
 7 | 
 8 |  <title>{{ site.title }}</title>
 9 |  <link href="{{ site.url }}/atom.xml" rel="self"/>
10 |  <link href="{{ site.url }}/"/>
11 |  <updated>{{ site.time | date_to_xmlschema }}</updated>
12 |  <id>{{ site.url }}</id>
13 |  <author>
14 |    <name>{{ site.author.name }}</name>
15 |    <email>{{ site.author.email }}</email>
16 |  </author>
17 | 
18 |  {% for post in site.posts %}
19 |  <entry>
20 |    <title>{{ post.title }}</title>
21 |    <link href="{{ site.url }}{{ post.url }}"/>
22 |    <updated>{{ post.date | date_to_xmlschema }}</updated>
23 |    <id>{{ site.url }}{{ post.id }}</id>
24 |    <content type="html">{{ post.content | xml_escape }}</content>
25 |  </entry>
26 |  {% endfor %}
27 | 
28 | </feed>
29 | 


--------------------------------------------------------------------------------
/images/dependencies.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/iilab/contentascode/48a99b3b3381270647a2cf12da0d756b7b06fb3f/images/dependencies.png


--------------------------------------------------------------------------------
/images/icon.svg:
--------------------------------------------------------------------------------
1 | <?xml version="1.0" standalone="yes"?>
2 | 
3 | <svg version="1.1" viewBox="0.0 0.0 256.0 256.0" fill="none" stroke="none" stroke-linecap="square" stroke-miterlimit="10" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink"><clipPath id="p.0"><path d="m0 0l256.0 0l0 256.0l-256.0 0l0 -256.0z" clip-rule="nonzero"></path></clipPath><g clip-path="url(#p.0)"><path fill="#0c343d" d="m0 0l256.0 0l0 256.0l-256.0 0z" fill-rule="nonzero"></path><path fill="#000000" fill-opacity="0.0" d="m0.31233597 0.31233597l256.0 0l0 256.0l-256.0 0z" fill-rule="nonzero"></path><path stroke="#ffffff" stroke-width="3.0" stroke-linejoin="round" stroke-linecap="butt" d="m0.31233597 0.31233597l256.0 0l0 256.0l-256.0 0z" fill-rule="nonzero"></path><path fill="#e69138" d="m26.613646 156.3008l31.22497 -39.169533l-11.143829 -48.84397l50.080795 7.6293945E-5l31.224419 -39.169777l31.224411 39.169777l50.08081 -7.6293945E-5l-11.143829 48.84397l31.22496 39.169533l-45.12152 21.737564l-11.14415 48.844055l-45.12068 -21.737839l-45.12069 21.737839l-11.144142 -48.844055z" fill-rule="nonzero"></path><path stroke="#ffffff" stroke-width="3.0" stroke-linejoin="round" stroke-linecap="butt" d="m26.613646 156.3008l31.22497 -39.169533l-11.143829 -48.84397l50.080795 7.6293945E-5l31.224419 -39.169777l31.224411 39.169777l50.08081 -7.6293945E-5l-11.143829 48.84397l31.22496 39.169533l-45.12152 21.737564l-11.14415 48.844055l-45.12068 -21.737839l-45.12069 21.737839l-11.144142 -48.844055z" fill-rule="nonzero"></path></g></svg>
4 | 
5 | 


--------------------------------------------------------------------------------
/index.md:
--------------------------------------------------------------------------------
 1 | ---
 2 | layout: default
 3 | title: Home
 4 | ---
 5 | 
 6 | ## Goals
 7 | 
 8 | **Content as Code** is an approach to develop workflows and technology to improve content re-use and maintainability.
 9 | 
10 | It aims to **make content authoring and management benefit from software engineering collaboration best practices**.
11 | 
12 | Our **design goals** are to enable:
13 | 
14 |  - [Focused Writing](approach/#focused-writing)
15 |  - [Localisation and translation](approach/#localisation-and-translation)
16 |  - [Low barrier to collaboration](approach/#low-barrier-to-collaboration)
17 |  - [Track changes and manage contributions](approach/#track-changes-and-manage-contributions)
18 |  - [Content Reuse](approach/#content-reuse)
19 |  - [Multiple publication channels](approach/#multiple-publication-channels)
20 | 
21 | ![dependencies](images/dependencies.png)
22 | 
23 | Our [**technology approach**](technology) builds on top of lightweight tools that separate concerns (instead of large monolithic frameworks as generally seen in CMSes):
24 | 
25 |  - Using **Git** for version control
26 |  - Using **Markdown** and enhanced flavors of Markdown for authoring
27 |  - Support **dependency tracking** at the fragment level.
28 |  - Support **static website generation** and interoperability with **content management systems**
29 |  - Support a **micro-service** approach to providing commenting, statistics and other dynamic features.
30 | 
31 | ## Who?
32 | 
33 | Content as code is supported by a partnership. The partnership brings together implementers contributing to projects publishing free/libre and open source content and wanting to have a lightweight (post-CMS or [CMS-Free](https://developmentseed.org/blog/2012/07/27/build-cms-free-websites/)) approach to content management that focus on the **author experience** (as well as editor and translator experience).
34 | 
35 | Read more about:
36 | 
37 |  - Our [approach and goals](approach) to editorial workflows
38 |  - The [technology](technology) supporting content workflows
39 |  - The [partner projects](partners)
40 | 


--------------------------------------------------------------------------------
/package.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "scripts": {
 3 |     "clean": "rm -rf $CONFIG_REPO && rm _branch.yml",
 4 |     "build": "jekyll build --config _config.yml,_branch.yml -d $CONFIG_REPO",
 5 |     "test": "npm run build && echo \"Do some validations...\" && npm run test-links",
 6 |     "test-links": "pm2 -s stop hs || true && pm2 -s delete hs || true && pm2 -f start `which hs` -- -p 8080 . && blc -s -r --input http://127.0.0.1:8080/$CONFIG_REPO | tee /dev/tty | grep -z '. 0 broken\\.[[:space:]]\\+Elapsed'",
 7 |     "deploy": "npm run deploy-push",
 8 |     "deploy-push": "cd $CONFIG_REPO && git init && git config user.email \"$GIT_EMAIL\" && git config user.name \"$GIT_NAME\" && git remote add upstream https://${GH_USERNAME}:${GH_TOKEN}@github.com/${CONFIG_OWNER}/${CONFIG_REPO}.git && git fetch upstream && git reset upstream/gh-pages && touch .nojekyll && git add -A . && git commit -a -m \"Travis build $TRAVIS_BUILD_NUMBER\" && git push --quiet upstream HEAD:gh-pages\n",
 9 |     "prebuild": "if [ $TRAVIS_PULL_REQUEST -eq 'true'] ; then TRAVIS_BRANCH=$TRAVIS_COMMIT ; fi && echo \"github:\\n  current_branch: $TRAVIS_BRANCH\" > _branch.yml\n",
10 |     "postbuild": "rm _branch.yml"
11 |   },
12 |   "name": "contentascode",
13 |   "description": "**Content as Code** is a partnership which develops workflows and technology to improve content re-use and maintainability.",
14 |   "version": "1.0.0",
15 |   "main": "index.js",
16 |   "repository": {
17 |     "type": "git",
18 |     "url": "git+https://github.com/iilab/contentascode.git"
19 |   },
20 |   "keywords": [],
21 |   "author": "Unknown",
22 |   "license": "ISC",
23 |   "bugs": {
24 |     "url": "https://github.com/iilab/contentascode/issues"
25 |   },
26 |   "homepage": "https://github.com/iilab/contentascode#readme"
27 | }


--------------------------------------------------------------------------------
/partners.md:
--------------------------------------------------------------------------------
 1 | ---
 2 | layout: page
 3 | title: Partners
 4 | ---
 5 | 
 6 | Projects that have expressed interest in this approach are:
 7 | 
 8 |  - Security in a Box (Tactical Tech)
 9 |  - Umbrella (Security First) 
10 |  - Level Up (Internews, The Engine Room)
11 |  - TOTEM (Greenhost)
12 |  - Advocacy Assembly (Small Media)
13 |  - Panic Button, Open Mentoring (iilab)
14 | 


--------------------------------------------------------------------------------
/public/apple-touch-icon-144-precomposed.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/iilab/contentascode/48a99b3b3381270647a2cf12da0d756b7b06fb3f/public/apple-touch-icon-144-precomposed.png


--------------------------------------------------------------------------------
/public/css/hyde.css:
--------------------------------------------------------------------------------
  1 | /*
  2 |  *  __                  __
  3 |  * /\ \                /\ \
  4 |  * \ \ \___   __  __   \_\ \     __
  5 |  *  \ \  _ `\/\ \/\ \  /'_` \  /'__`\
  6 |  *   \ \ \ \ \ \ \_\ \/\ \_\ \/\  __/
  7 |  *    \ \_\ \_\/`____ \ \___,_\ \____\
  8 |  *     \/_/\/_/`/___/> \/__,_ /\/____/
  9 |  *                /\___/
 10 |  *                \/__/
 11 |  *
 12 |  * Designed, built, and released under MIT license by @mdo. Learn more at
 13 |  * https://github.com/poole/hyde.
 14 |  */
 15 | 
 16 | 
 17 | /*
 18 |  * Contents
 19 |  *
 20 |  * Global resets
 21 |  * Sidebar
 22 |  * Container
 23 |  * Reverse layout
 24 |  * Themes
 25 |  */
 26 | 
 27 | 
 28 | /*
 29 |  * Global resets
 30 |  *
 31 |  * Update the foundational and global aspects of the page.
 32 |  */
 33 | 
 34 | html {
 35 |   font-family: "PT Sans", Helvetica, Arial, sans-serif;
 36 | }
 37 | @media (min-width: 48em) {
 38 |   html {
 39 |     font-size: 16px;
 40 |   }
 41 | }
 42 | @media (min-width: 58em) {
 43 |   html {
 44 |     font-size: 20px;
 45 |   }
 46 | }
 47 | 
 48 | 
 49 | /*
 50 |  * Sidebar
 51 |  *
 52 |  * Flexible banner for housing site name, intro, and "footer" content. Starts
 53 |  * out above content in mobile and later moves to the side with wider viewports.
 54 |  */
 55 | 
 56 | .sidebar {
 57 |   text-align: center;
 58 |   padding: 2rem 1rem;
 59 |   color: rgba(255,255,255,.5);
 60 |   background-color: #202020;
 61 | }
 62 | @media (min-width: 48em) {
 63 |   .sidebar {
 64 |     position: fixed;
 65 |     top: 0;
 66 |     left: 0;
 67 |     bottom: 0;
 68 |     width: 18rem;
 69 |     text-align: left;
 70 |   }
 71 | }
 72 | 
 73 | /* Sidebar links */
 74 | .sidebar a {
 75 |   color: #fff;
 76 | }
 77 | 
 78 | /* About section */
 79 | .sidebar-about h1 {
 80 |   color: #fff;
 81 |   margin-top: 0;
 82 |   font-family: "Abril Fatface", serif;
 83 |   font-size: 3.25rem;
 84 | }
 85 | 
 86 | /* Sidebar nav */
 87 | .sidebar-nav {
 88 |   margin-bottom: 1rem;
 89 | }
 90 | .sidebar-nav-item {
 91 |   display: block;
 92 |   line-height: 1.75;
 93 | }
 94 | a.sidebar-nav-item:hover,
 95 | a.sidebar-nav-item:focus {
 96 |   text-decoration: underline;
 97 | }
 98 | .sidebar-nav-item.active {
 99 |   font-weight: bold;
100 | }
101 | 
102 | /* Sticky sidebar
103 |  *
104 |  * Add the `sidebar-sticky` class to the sidebar's container to affix it the
105 |  * contents to the bottom of the sidebar in tablets and up.
106 |  */
107 | 
108 | @media (min-width: 48em) {
109 |   .sidebar-sticky {
110 |     position: absolute;
111 |     right:  1rem;
112 |     bottom: 1rem;
113 |     left:   1rem;
114 |   }
115 | }
116 | 
117 | 
118 | /* Container
119 |  *
120 |  * Align the contents of the site above the proper threshold with some margin-fu
121 |  * with a 25%-wide `.sidebar`.
122 |  */
123 | 
124 | .content {
125 |   padding-top:    4rem;
126 |   padding-bottom: 4rem;
127 | }
128 | 
129 | @media (min-width: 48em) {
130 |   .content {
131 |     max-width: 38rem;
132 |     margin-left: 20rem;
133 |     margin-right: 2rem;
134 |   }
135 | }
136 | 
137 | @media (min-width: 64em) {
138 |   .content {
139 |     margin-left: 22rem;
140 |     margin-right: 4rem;
141 |   }
142 | }
143 | 
144 | 
145 | /*
146 |  * Reverse layout
147 |  *
148 |  * Flip the orientation of the page by placing the `.sidebar` on the right.
149 |  */
150 | 
151 | @media (min-width: 48em) {
152 |   .layout-reverse .sidebar {
153 |     left: auto;
154 |     right: 0;
155 |   }
156 |   .layout-reverse .content {
157 |     margin-left: 2rem;
158 |     margin-right: 20rem;
159 |   }
160 | }
161 | 
162 | @media (min-width: 64em) {
163 |   .layout-reverse .content {
164 |     margin-left: 4rem;
165 |     margin-right: 22rem;
166 |   }
167 | }
168 | 
169 | 
170 | 
171 | /*
172 |  * Themes
173 |  *
174 |  * As of v1.1, Hyde includes optional themes to color the sidebar and links
175 |  * within blog posts. To use, add the class of your choosing to the `body`.
176 |  */
177 | 
178 | /* Base16 (http://chriskempson.github.io/base16/#default) */
179 | 
180 | /* Red */
181 | .theme-base-08 .sidebar {
182 |   background-color: #ac4142;
183 | }
184 | .theme-base-08 .content a,
185 | .theme-base-08 .related-posts li a:hover {
186 |   color: #ac4142;
187 | }
188 | 
189 | /* Orange */
190 | .theme-base-09 .sidebar {
191 |   background-color: #d28445;
192 | }
193 | .theme-base-09 .content a,
194 | .theme-base-09 .related-posts li a:hover {
195 |   color: #d28445;
196 | }
197 | 
198 | /* Yellow */
199 | .theme-base-0a .sidebar {
200 |   background-color: #f4bf75;
201 | }
202 | .theme-base-0a .content a,
203 | .theme-base-0a .related-posts li a:hover {
204 |   color: #f4bf75;
205 | }
206 | 
207 | /* Green */
208 | .theme-base-0b .sidebar {
209 |   background-color: #90a959;
210 | }
211 | .theme-base-0b .content a,
212 | .theme-base-0b .related-posts li a:hover {
213 |   color: #90a959;
214 | }
215 | 
216 | /* Cyan */
217 | .theme-base-0c .sidebar {
218 |   background-color: #75b5aa;
219 | }
220 | .theme-base-0c .content a,
221 | .theme-base-0c .related-posts li a:hover {
222 |   color: #75b5aa;
223 | }
224 | 
225 | /* Blue */
226 | .theme-base-0d .sidebar {
227 |   background-color: #6a9fb5;
228 | }
229 | .theme-base-0d .content a,
230 | .theme-base-0d .related-posts li a:hover {
231 |   color: #6a9fb5;
232 | }
233 | 
234 | /* Magenta */
235 | .theme-base-0e .sidebar {
236 |   background-color: #aa759f;
237 | }
238 | .theme-base-0e .content a,
239 | .theme-base-0e .related-posts li a:hover {
240 |   color: #aa759f;
241 | }
242 | 
243 | /* Brown */
244 | .theme-base-0f .sidebar {
245 |   background-color: #8f5536;
246 | }
247 | .theme-base-0f .content a,
248 | .theme-base-0f .related-posts li a:hover {
249 |   color: #8f5536;
250 | }
251 | 


--------------------------------------------------------------------------------
/public/css/poole.css:
--------------------------------------------------------------------------------
  1 | /*
  2 |  *                        ___
  3 |  *                       /\_ \
  4 |  *  _____     ___     ___\//\ \      __
  5 |  * /\ '__`\  / __`\  / __`\\ \ \   /'__`\
  6 |  * \ \ \_\ \/\ \_\ \/\ \_\ \\_\ \_/\  __/
  7 |  *  \ \ ,__/\ \____/\ \____//\____\ \____\
  8 |  *   \ \ \/  \/___/  \/___/ \/____/\/____/
  9 |  *    \ \_\
 10 |  *     \/_/
 11 |  *
 12 |  * Designed, built, and released under MIT license by @mdo. Learn more at
 13 |  * https://github.com/poole/poole.
 14 |  */
 15 | 
 16 | 
 17 | /*
 18 |  * Contents
 19 |  *
 20 |  * Body resets
 21 |  * Custom type
 22 |  * Messages
 23 |  * Container
 24 |  * Masthead
 25 |  * Posts and pages
 26 |  * Pagination
 27 |  * Reverse layout
 28 |  * Themes
 29 |  */
 30 | 
 31 | 
 32 | /*
 33 |  * Body resets
 34 |  *
 35 |  * Update the foundational and global aspects of the page.
 36 |  */
 37 | 
 38 | * {
 39 |   -webkit-box-sizing: border-box;
 40 |      -moz-box-sizing: border-box;
 41 |           box-sizing: border-box;
 42 | }
 43 | 
 44 | html,
 45 | body {
 46 |   margin: 0;
 47 |   padding: 0;
 48 | }
 49 | 
 50 | html {
 51 |   font-family: "Helvetica Neue", Helvetica, Arial, sans-serif;
 52 |   font-size: 16px;
 53 |   line-height: 1.5;
 54 | }
 55 | @media (min-width: 38em) {
 56 |   html {
 57 |     font-size: 20px;
 58 |   }
 59 | }
 60 | 
 61 | body {
 62 |   color: #515151;
 63 |   background-color: #fff;
 64 |   -webkit-text-size-adjust: 100%;
 65 |       -ms-text-size-adjust: 100%;
 66 | }
 67 | 
 68 | /* No `:visited` state is required by default (browsers will use `a`) */
 69 | a {
 70 |   color: #268bd2;
 71 |   text-decoration: none;
 72 | }
 73 | a strong {
 74 |   color: inherit;
 75 | }
 76 | /* `:focus` is linked to `:hover` for basic accessibility */
 77 | a:hover,
 78 | a:focus {
 79 |   text-decoration: underline;
 80 | }
 81 | 
 82 | /* Headings */
 83 | h1, h2, h3, h4, h5, h6 {
 84 |   margin-bottom: .5rem;
 85 |   font-weight: bold;
 86 |   line-height: 1.25;
 87 |   color: #313131;
 88 |   text-rendering: optimizeLegibility;
 89 | }
 90 | h1 {
 91 |   font-size: 2rem;
 92 | }
 93 | h2 {
 94 |   margin-top: 1rem;
 95 |   font-size: 1.5rem;
 96 | }
 97 | h3 {
 98 |   margin-top: 1.5rem;
 99 |   font-size: 1.25rem;
100 | }
101 | h4, h5, h6 {
102 |   margin-top: 1rem;
103 |   font-size: 1rem;
104 | }
105 | 
106 | /* Body text */
107 | p {
108 |   margin-top: 0;
109 |   margin-bottom: 1rem;
110 | }
111 | 
112 | strong {
113 |   color: #303030;
114 | }
115 | 
116 | 
117 | /* Lists */
118 | ul, ol, dl {
119 |   margin-top: 0;
120 |   margin-bottom: 0rem;
121 | }
122 | 
123 | dt {
124 |   font-weight: bold;
125 | }
126 | dd {
127 |   margin-bottom: .5rem;
128 | }
129 | 
130 | /* Misc */
131 | hr {
132 |   position: relative;
133 |   margin: 1.5rem 0;
134 |   border: 0;
135 |   border-top: 1px solid #eee;
136 |   border-bottom: 1px solid #fff;
137 | }
138 | 
139 | abbr {
140 |   font-size: 85%;
141 |   font-weight: bold;
142 |   color: #555;
143 |   text-transform: uppercase;
144 | }
145 | abbr[title] {
146 |   cursor: help;
147 |   border-bottom: 1px dotted #e5e5e5;
148 | }
149 | 
150 | /* Code */
151 | code,
152 | pre {
153 |   font-family: Menlo, Monaco, "Courier New", monospace;
154 | }
155 | code {
156 |   padding: .25em .5em;
157 |   font-size: 85%;
158 |   color: #bf616a;
159 |   background-color: #f9f9f9;
160 |   border-radius: 3px;
161 | }
162 | pre {
163 |   display: block;
164 |   margin-top: 0;
165 |   margin-bottom: 1rem;
166 |   padding: 1rem;
167 |   font-size: .8rem;
168 |   line-height: 1.4;
169 |   white-space: pre;
170 |   white-space: pre-wrap;
171 |   word-break: break-all;
172 |   word-wrap: break-word;
173 |   background-color: #f9f9f9;
174 | }
175 | pre code {
176 |   padding: 0;
177 |   font-size: 100%;
178 |   color: inherit;
179 |   background-color: transparent;
180 | }
181 | 
182 | /* Pygments via Jekyll */
183 | .highlight {
184 |   margin-bottom: 1rem;
185 |   border-radius: 4px;
186 | }
187 | .highlight pre {
188 |   margin-bottom: 0;
189 | }
190 | 
191 | /* Gist via GitHub Pages */
192 | .gist .gist-file {
193 |   font-family: Menlo, Monaco, "Courier New", monospace !important;
194 | }
195 | .gist .markdown-body {
196 |   padding: 15px;
197 | }
198 | .gist pre {
199 |   padding: 0;
200 |   background-color: transparent;
201 | }
202 | .gist .gist-file .gist-data {
203 |   font-size: .8rem !important;
204 |   line-height: 1.4;
205 | }
206 | .gist code {
207 |   padding: 0;
208 |   color: inherit;
209 |   background-color: transparent;
210 |   border-radius: 0;
211 | }
212 | 
213 | /* Quotes */
214 | blockquote {
215 |   padding: .5rem 1rem;
216 |   margin: .8rem 0;
217 |   color: #7a7a7a;
218 |   border-left: .25rem solid #e5e5e5;
219 | }
220 | blockquote p:last-child {
221 |   margin-bottom: 0;
222 | }
223 | @media (min-width: 30em) {
224 |   blockquote {
225 |     padding-right: 5rem;
226 |     padding-left: 1.25rem;
227 |   }
228 | }
229 | 
230 | img {
231 |   display: block;
232 |   max-width: 100%;
233 |   margin: 0 0 1rem;
234 |   border-radius: 5px;
235 | }
236 | 
237 | /* Tables */
238 | table {
239 |   margin-bottom: 1rem;
240 |   width: 100%;
241 |   border: 1px solid #e5e5e5;
242 |   border-collapse: collapse;
243 | }
244 | td,
245 | th {
246 |   padding: .25rem .5rem;
247 |   border: 1px solid #e5e5e5;
248 | }
249 | tbody tr:nth-child(odd) td,
250 | tbody tr:nth-child(odd) th {
251 |   background-color: #f9f9f9;
252 | }
253 | 
254 | 
255 | /*
256 |  * Custom type
257 |  *
258 |  * Extend paragraphs with `.lead` for larger introductory text.
259 |  */
260 | 
261 | .lead {
262 |   font-size: 1.25rem;
263 |   font-weight: 300;
264 | }
265 | 
266 | 
267 | /*
268 |  * Messages
269 |  *
270 |  * Show alert messages to users. You may add it to single elements like a `<p>`,
271 |  * or to a parent if there are multiple elements to show.
272 |  */
273 | 
274 | .message {
275 |   margin-bottom: 1rem;
276 |   padding: 1rem;
277 |   color: #717171;
278 |   background-color: #f9f9f9;
279 | }
280 | 
281 | 
282 | /*
283 |  * Container
284 |  *
285 |  * Center the page content.
286 |  */
287 | 
288 | .container {
289 |   max-width: 38rem;
290 |   padding-left:  1rem;
291 |   padding-right: 1rem;
292 |   margin-left:  auto;
293 |   margin-right: auto;
294 | }
295 | 
296 | 
297 | /*
298 |  * Masthead
299 |  *
300 |  * Super small header above the content for site name and short description.
301 |  */
302 | 
303 | .masthead {
304 |   padding-top:    1rem;
305 |   padding-bottom: 1rem;
306 |   margin-bottom: 3rem;
307 | }
308 | .masthead-title {
309 |   margin-top: 0;
310 |   margin-bottom: 0;
311 |   color: #505050;
312 | }
313 | .masthead-title a {
314 |   color: #505050;
315 | }
316 | .masthead-title small {
317 |   font-size: 75%;
318 |   font-weight: 400;
319 |   color: #c0c0c0;
320 |   letter-spacing: 0;
321 | }
322 | 
323 | 
324 | /*
325 |  * Posts and pages
326 |  *
327 |  * Each post is wrapped in `.post` and is used on default and post layouts. Each
328 |  * page is wrapped in `.page` and is only used on the page layout.
329 |  */
330 | 
331 | .page,
332 | .post {
333 |   margin-bottom: 4em;
334 | }
335 | 
336 | /* Blog post or page title */
337 | .page-title,
338 | .post-title,
339 | .post-title a {
340 |   color: #303030;
341 | }
342 | 
343 | h1.page-title, h1.post-title {
344 |   margin-top: 40px;
345 |   margin-bottom: 20px;
346 | }
347 | 
348 | /* Meta data line below post title */
349 | .post-date {
350 |   display: block;
351 |   margin-top: -.5rem;
352 |   margin-bottom: 1rem;
353 |   color: #9a9a9a;
354 | }
355 | 
356 | /* Related posts */
357 | .related {
358 |   padding-top: 2rem;
359 |   padding-bottom: 2rem;
360 |   border-top: 1px solid #eee;
361 | }
362 | .related-posts {
363 |   padding-left: 0;
364 |   list-style: none;
365 | }
366 | .related-posts h3 {
367 |   margin-top: 0;
368 | }
369 | .related-posts li small {
370 |   font-size: 75%;
371 |   color: #999;
372 | }
373 | .related-posts li a:hover {
374 |   color: #268bd2;
375 |   text-decoration: none;
376 | }
377 | .related-posts li a:hover small {
378 |   color: inherit;
379 | }
380 | 
381 | 
382 | /*
383 |  * Pagination
384 |  *
385 |  * Super lightweight (HTML-wise) blog pagination. `span`s are provide for when
386 |  * there are no more previous or next posts to show.
387 |  */
388 | 
389 | .pagination {
390 |   overflow: hidden; /* clearfix */
391 |   margin-left: -1rem;
392 |   margin-right: -1rem;
393 |   font-family: "PT Sans", Helvetica, Arial, sans-serif;
394 |   color: #ccc;
395 |   text-align: center;
396 | }
397 | 
398 | /* Pagination items can be `span`s or `a`s */
399 | .pagination-item {
400 |   display: block;
401 |   padding: 1rem;
402 |   border: 1px solid #eee;
403 | }
404 | .pagination-item:first-child {
405 |   margin-bottom: -1px;
406 | }
407 | 
408 | /* Only provide a hover state for linked pagination items */
409 | a.pagination-item:hover {
410 |   background-color: #f5f5f5;
411 | }
412 | 
413 | @media (min-width: 30em) {
414 |   .pagination {
415 |     margin: 3rem 0;
416 |   }
417 |   .pagination-item {
418 |     float: left;
419 |     width: 50%;
420 |   }
421 |   .pagination-item:first-child {
422 |     margin-bottom: 0;
423 |     border-top-left-radius:    4px;
424 |     border-bottom-left-radius: 4px;
425 |   }
426 |   .pagination-item:last-child {
427 |     margin-left: -1px;
428 |     border-top-right-radius:    4px;
429 |     border-bottom-right-radius: 4px;
430 |   }
431 | }
432 | 


--------------------------------------------------------------------------------
/public/css/syntax.css:
--------------------------------------------------------------------------------
 1 | .highlight .hll { background-color: #ffc; }
 2 | .highlight .c { color: #999; } /* Comment */
 3 | .highlight .err { color: #a00; background-color: #faa } /* Error */
 4 | .highlight .k { color: #069; } /* Keyword */
 5 | .highlight .o { color: #555 } /* Operator */
 6 | .highlight .cm { color: #09f; font-style: italic } /* Comment.Multiline */
 7 | .highlight .cp { color: #099 } /* Comment.Preproc */
 8 | .highlight .c1 { color: #999; } /* Comment.Single */
 9 | .highlight .cs { color: #999; } /* Comment.Special */
10 | .highlight .gd { background-color: #fcc; border: 1px solid #c00 } /* Generic.Deleted */
11 | .highlight .ge { font-style: italic } /* Generic.Emph */
12 | .highlight .gr { color: #f00 } /* Generic.Error */
13 | .highlight .gh { color: #030; } /* Generic.Heading */
14 | .highlight .gi { background-color: #cfc; border: 1px solid #0c0 } /* Generic.Inserted */
15 | .highlight .go { color: #aaa } /* Generic.Output */
16 | .highlight .gp { color: #009; } /* Generic.Prompt */
17 | .highlight .gs { } /* Generic.Strong */
18 | .highlight .gu { color: #030; } /* Generic.Subheading */
19 | .highlight .gt { color: #9c6 } /* Generic.Traceback */
20 | .highlight .kc { color: #069; } /* Keyword.Constant */
21 | .highlight .kd { color: #069; } /* Keyword.Declaration */
22 | .highlight .kn { color: #069; } /* Keyword.Namespace */
23 | .highlight .kp { color: #069 } /* Keyword.Pseudo */
24 | .highlight .kr { color: #069; } /* Keyword.Reserved */
25 | .highlight .kt { color: #078; } /* Keyword.Type */
26 | .highlight .m { color: #f60 } /* Literal.Number */
27 | .highlight .s { color: #d44950 } /* Literal.String */
28 | .highlight .na { color: #4f9fcf } /* Name.Attribute */
29 | .highlight .nb { color: #366 } /* Name.Builtin */
30 | .highlight .nc { color: #0a8; } /* Name.Class */
31 | .highlight .no { color: #360 } /* Name.Constant */
32 | .highlight .nd { color: #99f } /* Name.Decorator */
33 | .highlight .ni { color: #999; } /* Name.Entity */
34 | .highlight .ne { color: #c00; } /* Name.Exception */
35 | .highlight .nf { color: #c0f } /* Name.Function */
36 | .highlight .nl { color: #99f } /* Name.Label */
37 | .highlight .nn { color: #0cf; } /* Name.Namespace */
38 | .highlight .nt { color: #2f6f9f; } /* Name.Tag */
39 | .highlight .nv { color: #033 } /* Name.Variable */
40 | .highlight .ow { color: #000; } /* Operator.Word */
41 | .highlight .w { color: #bbb } /* Text.Whitespace */
42 | .highlight .mf { color: #f60 } /* Literal.Number.Float */
43 | .highlight .mh { color: #f60 } /* Literal.Number.Hex */
44 | .highlight .mi { color: #f60 } /* Literal.Number.Integer */
45 | .highlight .mo { color: #f60 } /* Literal.Number.Oct */
46 | .highlight .sb { color: #c30 } /* Literal.String.Backtick */
47 | .highlight .sc { color: #c30 } /* Literal.String.Char */
48 | .highlight .sd { color: #c30; font-style: italic } /* Literal.String.Doc */
49 | .highlight .s2 { color: #c30 } /* Literal.String.Double */
50 | .highlight .se { color: #c30; } /* Literal.String.Escape */
51 | .highlight .sh { color: #c30 } /* Literal.String.Heredoc */
52 | .highlight .si { color: #a00 } /* Literal.String.Interpol */
53 | .highlight .sx { color: #c30 } /* Literal.String.Other */
54 | .highlight .sr { color: #3aa } /* Literal.String.Regex */
55 | .highlight .s1 { color: #c30 } /* Literal.String.Single */
56 | .highlight .ss { color: #fc3 } /* Literal.String.Symbol */
57 | .highlight .bp { color: #366 } /* Name.Builtin.Pseudo */
58 | .highlight .vc { color: #033 } /* Name.Variable.Class */
59 | .highlight .vg { color: #033 } /* Name.Variable.Global */
60 | .highlight .vi { color: #033 } /* Name.Variable.Instance */
61 | .highlight .il { color: #f60 } /* Literal.Number.Integer.Long */
62 | 
63 | .css .o,
64 | .css .o + .nt,
65 | .css .nt + .nt { color: #999; }
66 | 


--------------------------------------------------------------------------------
/public/favicon.ico:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/iilab/contentascode/48a99b3b3381270647a2cf12da0d756b7b06fb3f/public/favicon.ico


--------------------------------------------------------------------------------
/status.md:
--------------------------------------------------------------------------------
  1 | ---
  2 | layout: page
  3 | title: Status
  4 | ---
  5 | 
  6 | ## Current
  7 | 
  8 | > [Contribute your ideas and discuss the approach of Content as Code #1](https://github.com/iilab/contentascode/issues/1)
  9 | 
 10 | > [Contribute your ideas and follow the discussion about the choice of authoring environment #5](https://github.com/iilab/contentascode/issues/5)
 11 | 
 12 | > [Help develop the proof of concept #7](https://github.com/iilab/contentascode/issues/7)
 13 | 
 14 | <!-- MarkdownTOC -->
 15 | 
 16 | - [Strategies](#strategies)
 17 | - [Implementations](#implementations)
 18 | - [Roadmap](#roadmap)
 19 |     - [Blog](#blog)
 20 |     - [Wiki](#wiki)
 21 |     - [Knowledge Base](#knowledge-base)
 22 |     - [Project Management](#project-management)
 23 |     - [CMS](#cms)
 24 | - [Milestones](#milestones)
 25 |     - [Proof of Concept - v0.0.1](#proof-of-concept---v001)
 26 |     - [Prototype - v0.1.0](#prototype---v010)
 27 |     - [Minimum Viable Implementation - v1.0.0](#minimum-viable-implementation---v100)
 28 | - [Follow](#follow)
 29 | 
 30 | <!-- /MarkdownTOC -->
 31 | 
 32 | 
 33 | ## Strategies
 34 | 
 35 | The below roadmap is only loosely enforced and what drives progress on Content as Code is engagement from projects which are implementing such approaches and will help:
 36 |  - Develop building blocks with other development stacks
 37 |  - Extend features of existing building blocks (such as docsmith)
 38 |  - Participate in the user experience and technology design
 39 | 
 40 | ## Implementations
 41 | 
 42 |  - Summary
 43 | 
 44 | |        Name       |            Description            |                        Repo URL                        |
 45 | |-------------------|-----------------------------------|--------------------------------------------------------|
 46 | | Content as Code   | Reference Implementation          | iilab/contentascode                                    |
 47 | | Open Integrity    | Data Framework                    | https://code.iilab.org/openintegrity/openintegrity.org |
 48 | | Open Mentoring    | Mobile Education                  | iilab/openmentoring                                    |
 49 | | Panic Button      | Simple CMS for Mobile App         | PanicInitiative/PanicButton                            |
 50 | | Using TBB         | Semantic Documentation experiment | elationfoundation/using-tor-browser-bundle             |
 51 | | Security in a Box | Work in Progress                  | coming soon                                            |
 52 | | Level Up          | Work in Progress                  | coming soon                                            |
 53 | | TOTEM             | Work in Progress                  | coming soon                                            |
 54 | | Advocacy Assembly | Work in Progress                  | coming soon                                            |
 55 | 
 56 |  - Components / Stages
 57 | 
 58 | |        Name       | Source |         Author        | Generator  |  Build   | Integration |  Publishing |
 59 | |-------------------|--------|-----------------------|------------|----------|-------------|-------------|
 60 | | Content as Code   | Github | Markdown/Pandoc       | Metalsmith | npm      | Travis      | Gh-pages    |
 61 | | Open Integrity    | Gitlab | Prose/Markdown/Pandoc | Metalsmith | Sighjs   | Gitlab CI   | Self-hosted |
 62 | | Open Mentoring    | Github | Markdown/Marked       | Metalsmith | make     | Travis      | Gh-pages    |
 63 | | Panic Button      | Github | Prose/Markdown        | Jekyll     | gh-pages |             | Self-hosted |
 64 | | Using TBB         | Github | Markdown              | Jekyll     |          |             |             |
 65 | | Security in a Box | Gitlab | Markdown              |            |          |             |             |
 66 | | Level Up          | Github |                       |            |          |             |             |
 67 | | TOTEM             | Gitlab |                       |            |          |             |             |
 68 | | Advocacy Assembly | Github |                       |            |          |             |             |
 69 | 
 70 |  - Publishing Channels
 71 | 
 72 | |        Name       | Web | Mobile | Book | Interactive |
 73 | |-------------------|-----|--------|------|-------------|
 74 | | Content as Code   | Yes | No     | No   | No          |
 75 | | Open Integrity    | Yes |        |      | Yes         |
 76 | | Open Mentoring    | Yes | Yes    | Soon | Some        |
 77 | | Panic Button      | Yes | Yes    | No   | Some        |
 78 | | Using TBB         | Yes |        |      |             |
 79 | | Security in a Box |     |        |      |             |
 80 | | Level Up          |     |        |      |             |
 81 | | TOTEM             |     |        |      |             |
 82 | | Advocacy Assembly |     |        |      |             |
 83 | 
 84 | ## Roadmap
 85 | 
 86 | * TOC
 87 | {:toc}
 88 | 
 89 | 
 90 | ### Blog
 91 | > In progress
 92 | 
 93 |  - [x] Initialise an empty project (`docsmith init metalsmith` (default) or `docsmith init jekyll`)
 94 |  - [ ] Assist in creating posts (a la Octopress or Docpad)
 95 |  - [ ] Authoring environment (a la Prose or Gitbook) [#5](https://github.com/iilab/contentascode/issues/5)
 96 |  - [ ] Validate/Check
 97 |  - [ ] Preview
 98 |  - [ ] Publish
 99 | 
100 | ### Wiki
101 | > In progress
102 | 
103 | Some features of a wiki such as the 
104 |  - [x] Submit page edits
105 |  - [ ] Submit anonymous page edits
106 |  - [x] View page history
107 |  - [ ] Create new pages
108 |  - [ ] Semantic features (a la Wagn or Semantic MediaWiki)
109 |  - [ ] Federation (a la Smallest Federated Wiki)
110 | 
111 | ### Knowledge Base
112 | > Collective Intelligence. See [Open Integrity Framework](https://code.iilab.org/openintegrity/framework)
113 | 
114 |  - [ ] User Feedback mechanisms
115 |      - [ ] Line/Section content review [#37](https://github.com/iilab/contentascode/issues/37) [#38](https://github.com/iilab/contentascode/issues/38)
116 |      - 
117 | 
118 | ### Project Management
119 | > In progress
120 | 
121 |  - [x] Create tasks (via Github/Gitlab issue)
122 |  - [ ] Follow tasks
123 |      - [x] Via github/gitlab mentions *(for free)*
124 |      - [ ] Via client side widget
125 |      - [ ] With a smart notification [#46](https://github.com/iilab/contentascode/issues/46)
126 |  - [ ] Update linked task status [#45](https://github.com/iilab/contentascode/issues/45)
127 |  - [ ] Link tasks to pages [#24](https://github.com/iilab/contentascode/issues/37) [#38](https://github.com/iilab/contentascode/issues/24)
128 |  - [x] See tasks in Kanban view [Leanlabs Kanban #35](https://github.com/iilab/contentascode/issues/35) [Waffle #36](https://github.com/iilab/contentascode/issues/36)
129 | 
130 | ### CMS
131 | 
132 |  - [ ] Content review workflows
133 |     - [ ] External review workflows [#20](https://github.com/iilab/contentascode/issues/20)
134 |  - [ ] Translation [#4](https://github.com/iilab/contentascode/issues/4)
135 |  - [ ] ...
136 | 
137 | 
138 | ## Milestones
139 | 
140 | ### Proof of Concept - v0.0.1
141 | 
142 | In the run up to the IFF the proposed tasks to help get the partnership off the ground are:
143 | 
144 | #### Design
145 | 
146 | - ~~[Iterate on the ecosystem design document #1](https://github.com/iilab/contentascode/issues/1)~~
147 | - ~~[Document translation workflow #2](https://github.com/iilab/contentascode/issues/2)~~
148 | - [Implement translation workflow scripts #3](https://github.com/iilab/contentascode/issues/3)~~
149 | - ~~[Document possible legacy technology constraints and requirements #4](https://github.com/iilab/contentascode/issues/4)~~
150 | - ~~[Choose editor(s) as a basis for the authoring environment #5](https://github.com/iilab/contentascode/issues/5)~~
151 | - ~~[Discuss Roadmap #6](https://github.com/iilab/contentascode/issues/6)~~
152 | 
153 | #### Implementation
154 | 
155 | - ~~[Implement Proof of Concept #7](https://github.com/iilab/contentascode/issues/7)~~
156 | 
157 | > ~~Milestone [Lift off](https://github.com/iilab/contentascode/milestones/Lift%20off)~~
158 | > ~~Version [v0.0.1](https://github.com/iilab/contentascode/issues/7)~~ - https://github.com/iilab/contentascode/issues/7
159 | 
160 |  -  Authoring
161 |      + [x] Github
162 |      + [x] Jekyll
163 |      + [x] Prose
164 |  - Translation
165 |      + [x] Transifex
166 | 
167 |  - Collaboration
168 |      + [x] Github - Fork and pull request
169 | 
170 |  - Management
171 |      + [x] Waffle 
172 | 
173 |  - CMS Parity
174 |      + [ ] Comments - Github issues?
175 |      + [ ] Stats - Piwik
176 | 
177 |  - Deployment
178 |      + [ ] Single repo and one click deploy 
179 | 
180 | 
181 | ### Prototype - v0.1.0
182 | 
183 | Prototype should allow to do demos and showcase how key functionalities will work and improve existing content workflows.
184 | 
185 | > Milestone [Prototype](https://github.com/iilab/contentascode/milestones/Prototype) - https://github.com/iilab/contentascode/milestones/Prototype
186 | > Version [v0.1.0](https://github.com/iilab/contentascode/issues/9) - https://github.com/iilab/contentascode/issues/9
187 | 
188 | ### Minimum Viable Implementation - v1.0.0
189 | 
190 | Minimum viable implementation which would allow partners to adopt the workflow and technology in production.
191 | 
192 | > Milestone [Minimum Viable Implementation](https://github.com/iilab/contentascode/milestones/Minimum%20Viable%20Implementation%20) - https://github.com/iilab/contentascode/milestones/Minimum%20Viable%20Implementation%20
193 | > Version [v1.0.0](https://github.com/iilab/contentascode/issues/8) - https://github.com/iilab/contentascode/issues/8
194 | 
195 | ## Follow
196 | 
197 | Follow the progress of the Content as Code partnership and contribute:
198 | 
199 |  - By [commenting and creating github issues](https://github.com/iilab/contentascode/issues) 
200 |  - By [watching the github repository](https://github.com/iilab/contentascode/subscription)
201 |  - By joining us at the [Internet Freedom Festival](https://internetfreedomfestival.org/) content re-use session.
202 | 
203 | 


--------------------------------------------------------------------------------
/technology.md:
--------------------------------------------------------------------------------
  1 | ---
  2 | layout: page
  3 | title: Technology
  4 | ---
  5 | 
  6 | > Also see the [status page](../status) and [roadmap](../status#roadmap)
  7 | 
  8 | The following sub-pages describe the various technology related aspect of the content as code project
  9 | 
 10 | * Workflow Components
 11 |   * [Authoring](authoring)
 12 |   * [Translation](translation)
 13 |   * [Collaboration]()
 14 |   * [Management]()
 15 |   * [Reuse]()
 16 | * [Implementation](implementation)
 17 | * [Existing Approaches](existing) : Descriptions of existing approaches among project partners. 
 18 | * [Inspiration](inspiration) from other projects
 19 | 
 20 | 
 21 | <!-- MarkdownTOC -->
 22 | 
 23 | - [Technical Goals](#technical-goals)
 24 |     - [CMS Parity](#cms-parity)
 25 |     - [Flexible structure](#flexible-structure)
 26 |     - [Interoperable and extensible](#interoperable-and-extensible)
 27 |     - [Streamlined and extensible](#streamlined-and-extensible)
 28 | - [Components / Stack](#components--stack)
 29 |     - [Source](#source)
 30 |     - [Author](#author)
 31 |     - [Generate](#generate)
 32 |     - [Collaborate](#collaborate)
 33 |     - [Integrate](#integrate)
 34 |     - [Publish](#publish)
 35 | 
 36 | <!-- /MarkdownTOC -->
 37 | 
 38 | ## Technical Goals
 39 | 
 40 | ### CMS Parity
 41 | 
 42 | > Having usable solutions for commonly available features in CMSes is a design goal.
 43 | 
 44 | Have clear, integrated and open source solutions to deal with comments, visit statistics, search, forms and other features traditionally managed with a database backend.
 45 | 
 46 | ### Flexible structure
 47 | 
 48 | > Allowing completely free form content structures or complex content structures is a design goal.  
 49 | 
 50 | ### Interoperable and extensible
 51 | 
 52 | > Allowing mixed workflows that allow importing/exporting/synchronising content across systems and adding software components is a design goal.
 53 | 
 54 | ### Streamlined and extensible
 55 | 
 56 | > Simplicity and ease of use and understanding are design goals.
 57 | 
 58 | Composed of many different software parts, the workflow is nonetheless streamlined and integrated. When deployed with default settings, it can be used immediately. Authors, editors, translators as well as software and systems engineer can understand how the pieces fit together.
 59 | 
 60 | ## Components / Stack
 61 | 
 62 | This table aims to represent which components affect which stages of the content as code framework.
 63 |  - Key          : means that this component is a key component for this stage.
 64 |  - Change       : means that this component modifies or applies to this stage.
 65 |  - + component : means that this component works better with the specified component.
 66 |  - = component : means that this component only works with the specified component.
 67 |  - - component : means that this component doesn't work with the specified component.
 68 | 
 69 | | Component \ Stack |  Source  | Author |  Integrate  | Collaborate | Generate | Translate |  Publish   |
 70 | |-------------------|----------|--------|-------------|-------------|----------|-----------|------------|
 71 | | github            | Key      |        | + travis    |             |          |           | + gh-pages |
 72 | | gitlab            | Key      |        | + gitlab-ci |             |          |           |            |
 73 | |-------------------|----------|--------|-------------|-------------|----------|-----------|------------|
 74 | | prose             | + github | Key    |             |             | + jekyll |           |            |
 75 | |-------------------|----------|--------|-------------|-------------|----------|-----------|------------|
 76 | | travis            |          |        | Key         |             |          |           |            |
 77 | | gitlab-ci         | - github |        | Key         |             |          |           |            |
 78 | |-------------------|----------|--------|-------------|-------------|----------|-----------|------------|
 79 | | validate          |          |        | Change      |             |          |           |            |
 80 | | validate links    |          |        | Change      |             |          |           |            |
 81 | | validate style    |          |        | Change      |             |          |           |            |
 82 | |-------------------|----------|--------|-------------|-------------|----------|-----------|------------|
 83 | | jekyll            |          |        |             |             | Key      |           |            |
 84 | | metalsmith        |          |        |             |             | Key      |           |            |
 85 | |-------------------|----------|--------|-------------|-------------|----------|-----------|------------|
 86 | | transifex         |          |        |             |             |          | Key       |            |
 87 | |-------------------|----------|--------|-------------|-------------|----------|-----------|------------|
 88 | | gh-pages          | + github |        |             |             |          |           | Key        |
 89 | |-------------------|----------|--------|-------------|-------------|----------|-----------|------------|
 90 | 
 91 | ### Source
 92 | 
 93 | Source repositories which contain the sources for the current project. 
 94 | 
 95 | Note: These are not upstream dependencies which will be managed with metadata inside and alongside the source files.
 96 | 
 97 | 
 98 | ### Author
 99 | 
100 | This is where the content is edited, manipulated and so on. Different authoring environment will have different capabilities (for instance for validation without a server round-trip or workflow aspects...). 
101 | 
102 | ### Generate
103 | 
104 | The static site generator used.
105 | 
106 | ### Collaborate
107 | 
108 | Collaborating on the planning, authoring, editing, reviewing, commenting of content.
109 | 
110 | ### Integrate
111 | 
112 | These are the tools used to prepare and validate content and give feedback to authors and editors, including presenting staging or testing environments/artifacts of various versions that are being worked on.
113 | Note: Maybe this should be included in the publish component.
114 | 
115 | ### Publish
116 | 
117 | These are the various channels where published versions will be available from.
118 | 


--------------------------------------------------------------------------------
/technology/applications.md:
--------------------------------------------------------------------------------
 1 | # Applications
 2 | 
 3 | Here are some applications for which Content as Code could be used and implementation notes about what it will take to get there.
 4 | 
 5 | > This should be transcluded from or transclude the [status page](../../status)
 6 | 
 7 | ## Blog
 8 | > In progress
 9 | >  - Docsmith (via Jekyll or Metalsmith component)
10 | 
11 | :[Status](../../status#blog)
12 | 
13 | ## Wiki
14 | > In progress
15 | > 
16 | 
17 | :[Status](../../status#wiki)
18 | 
19 | ## Knowledge Base
20 | > Collective Intelligence. See [Open Integrity Framework](https://code.iilab.org/openintegrity/framework)
21 | 
22 | :[Status](../../status#knowledge-base)
23 | 
24 | ## Project Management
25 | > In progress
26 | > 
27 | 
28 | :[Status](../../status#project-management)
29 | 
30 | ## CMS
31 | > In Progress
32 | > 
33 | 
34 | :[Status](../../status#cms)
35 | 
36 | ### Implementation Notes
37 | 
38 | Thoughts around how to match certain existing tool's features with a sophisticated Issue tracker (like Github/Gitlab Issues augmented by some form of Kanban)
39 | 
40 |  - Open Project
41 |      + Backlogs -> Could be implemented with Milestones which will also allow to display as groups on Github/Gitlab as well as Swimlanes in Leanlab's Kanban 
42 | 
43 |  - Asana
44 |      + Keyboard shortcuts and quick entry
45 |      + 
46 |  - Sprintly
47 |      + User story templates
48 |  - [Workfront](https://www.workfront.com/enterprise/features/)
49 |      + Portfolio management
50 |      + Mixed method (agile/waterfall)
51 |  - Taiga
52 |  - Trello
53 |  - Blossom
54 |  - 
55 | 
56 | 


--------------------------------------------------------------------------------
/technology/architecture.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/iilab/contentascode/48a99b3b3381270647a2cf12da0d756b7b06fb3f/technology/architecture.png


--------------------------------------------------------------------------------
/technology/authoring.md:
--------------------------------------------------------------------------------
  1 | ---
  2 | title: Authoring
  3 | issue: 5
  4 | ---
  5 | 
  6 | >  [Contribute your ideas and follow the discussion about the choice of authoring environment](https://github.com/iilab/contentascode/issues/5)
  7 | 
  8 | * TOC
  9 | {:toc}
 10 | 
 11 | ## Criteria
 12 | 
 13 | The authoring environment should be:
 14 | 
 15 |  - **Open source**
 16 |  - Running in the **browser**
 17 | 
 18 | 6 potential candidate software are considered with these additional criteria:
 19 | 
 20 |  - **Markdown support**
 21 |  - **Git support**
 22 |  - **Inplace editing**
 23 |  - **Actively maintained**
 24 |  - **Extensible**, it should be easy to add functionalities. See [Analysis below](#analysis)
 25 | 
 26 | ---
 27 | 
 28 | |                                                          | Markdown |  Git   | Inplace | Active |
 29 | |----------------------------------------------------------|----------|--------|---------|--------|
 30 | | [Prose](http://prose.io)                                 | Yes      | github | No      | No     |
 31 | | [Gitbook](https://www.gitbook.com/editor)                | Yes      | git    | No      | Yes    |
 32 | | [Dillinger](https://github.com/joemccann/dillinger)      | Yes      | github | No      |        |
 33 | | [Aloha](http://www.alohaeditor.org/demo/aloha-ui/)       |          |        | Yes     |        |
 34 | | [Pen Editor](http://sofish.github.io/pen/)               | Yes      | No     | Yes     | Yes    |
 35 | | [ContentEditable](http://html5demos.com/contenteditable) | No       | No     | Yes     | Yes    |
 36 | 
 37 | ## Feature Gaps
 38 | 
 39 | Based on the [design goals](../../approach#design-goals) the following features should be implemented:
 40 | 
 41 | ### Non negotiables
 42 | 
 43 |  - **Media**: Prose for instance manages media if in a single folder. Should have some library features. 
 44 |  - **Links**: Are too easy to break, or complicated to create. Should be checked client side.
 45 |  - **Metadata**: Even if content is made of several blocks (including reused blocks), they should be invisible and be previewable as a whole, carry invisible metadata and allow various degrees of structure to be enforced.
 46 | 
 47 | ### Nice to haves / Possible Easy Wins
 48 | 
 49 |  - **Iconography**: Having an icon library like glyphicons or font-awesome would be... not bad.
 50 |  - **Forms**: After all that's what GFM ```- [ ]``` are.
 51 |  - **Diagrams**: Mermaid is where it's at.
 52 |  - **Offline**: Work offline or with an unhosted approach (remote storage git layer?)
 53 | 
 54 | ### Unicorns
 55 | 
 56 | Let's say goodbye to google docs.
 57 | 
 58 |  - **Realtime collaboration**: Substance where have you gone... OT over Git please.
 59 |  - **Spreadsheet editing**: Quip style of course. There are a number of good looking spreadsheet.js approaches. 
 60 | 
 61 | ## Analysis
 62 | 
 63 | 
 64 | ### Project
 65 | 
 66 | |                                                          | OSS | Active |                 Comment                  |
 67 | |----------------------------------------------------------|-----|--------|------------------------------------------|
 68 | | [Prose](http://prose.io)                                 | Yes | No     | Huge community of contributors and users |
 69 | | [Gitbook](https://www.gitbook.com/editor)                | Yes | Yes    |                                          |
 70 | | [Dillinger](https://github.com/joemccann/dillinger)      | Yes |        |                                          |
 71 | | [Aloha](http://www.alohaeditor.org/demo/aloha-ui/)       |     |        |                                          |
 72 | | [Pen Editor](http://sofish.github.io/pen/)               | Yes | Yes    |                                          |
 73 | | [ContentEditable](http://html5demos.com/contenteditable) | No  | Yes    |                                          |
 74 | 
 75 | 
 76 | ### Fundamentals
 77 | 
 78 | |           | Markdown |  Git   | Branches |     Metadata     | Comment |
 79 | |-----------|----------|--------|----------|------------------|---------|
 80 | | Prose     | Yes      | Github | Yes      | YAML/Frontmatter |         |
 81 | | Gitbook   | Yes      | Yes    |          |                  |         |
 82 | | Dillinger | Yes      | Yes    |          |                  |         |
 83 | | Pen Edit  | Yes      | No     |          |                  |         |
 84 | | Substance | No       | No     |          |                  |         |
 85 | | Realms    | Yes      | No     |          |                  |         |
 86 | | PupPub    |          |        |          |                  |         |
 87 | 
 88 | 
 89 | ### UX
 90 | 
 91 | 
 92 | |           | InPlace | Preview | Toolbar |   Media    | Links | Metadata | Offline | Focused |
 93 | |-----------|---------|---------|---------|------------|-------|----------|---------|---------|
 94 | | Prose     | No      | Yes     | Yes     | Yes        |       | Yes      | No      | Yes     |
 95 | | Gitbook   | No      | Some    |         | Yes        |       | No       | Yes?    | Some    |
 96 | | Dillinger | No      |         |         | Yes        |       | Yes      | Yes     | Yes     |
 97 | | Pen Edit  | Yes     | Yes     |         | No         |       |          |         |         |
 98 | | Substance | No      | Yes     |         | Yes        |       | Yes      | Yes     | Yes     |
 99 | | Realms    | No      | Yes     |         | No toolbar |       | No       | No      | No      |
100 | | PupPub    |         |         |         |            |       |          |         |         |
101 | 
102 | 
103 | ### Tech
104 | 
105 | 
106 | |           | Lang | Frontend |     Backend     | Modular |  Style  |             Comments             |
107 | |-----------|------|----------|-----------------|---------|---------|----------------------------------|
108 | | Prose     | JS   | Backbone | Quite Stateless | Good    | Simple. | Bad code climate. Insecure deps. |
109 | | Gitbook   |      |          |                 |         |         |                                  |
110 | | Dillinger |      |          |                 |         |         |                                  |
111 | | Pen Edit  |      |          |                 |         |         |                                  |
112 | | Substance |      |          |                 |         |         |                                  |
113 | | Realms    |      |          |                 |         |         |                                  |
114 | | PupPub    |      |          |                 |         |         |                                  |
115 | 
116 | ### Misc
117 | 
118 | 
119 | |                 | Offline | Desktop | PDF | Dropbox | G Drive |         Comments         |
120 | |-----------------|---------|---------|-----|---------|---------|--------------------------|
121 | | Prose           |         |         |     |         | No      | Also has a table editor. |
122 | | Gitbook         |         | Yes     | Yes |         | Yes     |                          |
123 | | Dillinger       | Yes     |         | Yes | Yes     | Yes     |                          |
124 | | Aloha           |         |         |     |         |         |                          |
125 | | Pen Edit        |         |         |     |         | Yes     |                          |
126 | | ContentEditable |         |         |     |         | Yes     |                          |
127 | 
128 | 
129 | ### Prose
130 | 
131 | ### Dillinger
132 | 
133 | AngularJS - HTML enhanced for web apps!
134 | Ace Editor - awesome web-based text editor
135 | Marked - a super fast port of Markdown to JavaScript
136 | Twitter Bootstrap - great UI boilerplate for modern web apps
137 | node.js - evented I/O for the backend
138 | Express - fast node.js network app framework @tjholowaychuk
139 | Gulp - the streaming build system
140 | keymaster.js - awesome keyboard handler lib by @thomasfuchs
141 | jQuery - duh
142 | 
143 | ### Aloha
144 | 
145 | ### ...
146 | 


--------------------------------------------------------------------------------
/technology/existing.md:
--------------------------------------------------------------------------------
  1 | ---
  2 | title: Existing Approaches
  3 | ---
  4 | 
  5 | * TOC
  6 | {:toc}
  7 | 
  8 | ## Overview
  9 | 
 10 | |              | Content Format | Content Authoring |     Content Publication      |         Content Delivery         |
 11 | |--------------|----------------|-------------------|------------------------------|----------------------------------|
 12 | | SIAB         | Wyswiwyg       | Drupal            | Drupal                       | Drupal Web                       |
 13 | | Umbrella     | Markdown       | Manual            | SQL -> SQlite DB             | Native Android                   |
 14 | | Story Maker  | YAML           | Git / tx          | YAML -> Zipped JSON (Python) | Native Android (StoryPath/Liger) |
 15 | | SSD          | ?              | Drupal            | Drupal                       | Drupal Web                       |
 16 | | Panic Button | Markdown       | Prose / tx        | md -> JSON (Jekyll)          | Native Android (custom)          |
 17 | 
 18 |  - SIAB uses Drupal and aims to publish or manage content as markdown files. Possibly evolving towards a static Markdown files, possibly evolving to provide a Content API. https://github.com/securityinabox/siabguide
 19 |  - Umbrella is a native Android app, the content is generated from csv files into an asset database (probably sqlite) in the APK. https://github.com/securityfirst/Umbrella_android
 20 |  - Story Maker is an Android app using the StoryPath (formerly liger) library to load content packs stored as YAML files. There is a transifex workflow but I'm not sure about how the content is authored. https://github.com/StoryMaker/content-packs https://github.com/StoryMaker/storypath
 21 |  - EFF uses Drupal. The repo doesn't seem to have the content of the guide. https://github.com/EFForg/ssd 
 22 |  - Panic Button is a native Android app using a custom made JSON file parser to generate its interface (similar but less mature concept than StoryPath). Content is authored in Prose as Markdown and Jekyll generates the JSON files. There's an ongoing effort to interop with Transifex.
 23 |  - Digital First Aid Kit's source is a git repository of markdown files. Not sure about how the website and printed versions are generated. https://github.com/RaReNet/DFAK
 24 |  - Level Up uses Drupal. No source code or content I could find.
 25 | 
 26 | ## Interoperability approaches
 27 | 
 28 | 
 29 | |                       | Interop Maturity |               Rationale                |
 30 | |-----------------------|------------------|----------------------------------------|
 31 | | SIAB                  | ++               | Markdown in Git / Close to Content API |
 32 | | Umbrella              | -                | CSV / Not Git                          |
 33 | | Story Maker           | +++              | Spec and Library                       |
 34 | | SSD                   | -                | No content source ?                    |
 35 | | Panic Button          | +                | Markdown in Git                        |
 36 | | Digital First Aid Kit | +                | Markdown in Git                        |
 37 | | Level Up              | --               | No content source / No repo            |
 38 | 
 39 | ### Security in a Box.
 40 | 
 41 | Export from SIAB:
 42 | 
 43 |  - Ideally access Drupal Nodes through a granular API (at the level of sections, community snippets), keep track of upstream last modified date and translation dependencies to flag downstream update needs and generate/transform into static source for content packs.
 44 | 
 45 | Import in SIAB:
 46 | 
 47 |  - Drupal Remote Entity or Web Service Data module consuming a statically generated 
 48 | 
 49 | Integration Path
 50 | 
 51 |  - Possible to reuse Open Mentoring/StoryPath approach to generate content packs from SIAB to create a SIAB Mobile App.
 52 | 
 53 | ### Umbrella. 
 54 | 
 55 | Export from Umbrella:
 56 | 
 57 |  - Directly by transforming source csv files
 58 | 
 59 | Import in Umbrella:
 60 | 
 61 |  - Exporting Open Mentoring Content Packs as Umbrella compatible CSV
 62 | 
 63 | Integration Path
 64 | 
 65 |  - Umbrella could reuse a Content Pack approach and propose to StoryPath to integrate Checklist in the spec
 66 | 
 67 | ### Story Maker
 68 | 
 69 | Export/Import from Story Maker
 70 | 
 71 |  - Compatibility with OBB Content Pack binaries should mean that they can just be an additional source to download from.
 72 | 
 73 | Integration Path
 74 | 
 75 |  - Working with StoryPath to upstream different approaches to content management and developing NativeScript/Cordova plugins might pay off.
 76 | 
 77 | ### Panic Button
 78 | 
 79 | To be discussed but if the Panic Button help section was rewritten to allow loading StoryPath content packs that would probably be a good thing. 
 80 | 
 81 | ### TOTEM
 82 | 
 83 | Interop with practical tests is a strong lead.
 84 | 
 85 | ### Open Mentoring 
 86 | 
 87 | #### Content Requirements
 88 | 
 89 |  - Git managed static content approach
 90 |  - Transifex workflow
 91 |  - Known interop path with *all* content ecosystem
 92 | 
 93 | #### Tech Options
 94 | 
 95 | Format
 96 | 
 97 |  - Markdown with YAML Frontmatter in smaller chunks than StoryMaker Content Packs (to allow markdown bodies in cards)
 98 | 
 99 | Authoring
100 | 
101 |  - Prose
102 | 
103 | Publication
104 | 
105 |  - Maybe Liger content pack interop?
106 | 
107 | Delivery
108 | 
109 |  - Native Android with StoryPath/Liger and different git static content publication scripts.
110 |  - NativeScript App with StoryPath/Liger 
111 |  - NativeScript App with StoryPath/Liger compatible approach
112 |  - Corbova App with StoryPath/Liger
113 |  - Corbova App with StoryPath/Liger compatible approach
114 | 
115 | See [Technical Research Wiki Page](https://github.com/iilab/openmentoring-content/wiki) for more about platform choice.
116 | 


--------------------------------------------------------------------------------
/technology/foundations/git.md:
--------------------------------------------------------------------------------
 1 | ---
 2 | title: git
 3 | stage: source
 4 | ---
 5 | 
 6 | # Git
 7 | 
 8 | One of the most fundamental components of the content as code approach is the use of the distributed version control system git. It provides low level facilities for tracking changes and backing up ~~code~~ content in large file structures, create new versions (branches) as well as ways to deal with conflicts and merging different versions.
 9 | 
10 | But one of the emerging practices that both Github and Gitlab have been focusing on have added a number of buildinb blocks to the low-level mechanics of git. Some of these are:
11 |  - forks and tracking the "fork graph",
12 |  - pull requests as a first class concept,
13 |  - continuous integration reporting back at various levels (release, branches, pull requests) 
14 |  - issue tracking deeply integrated with commits,
15 |  - code review tools,
16 |  - collaboration with @mentions and #issue references across repos.
17 | 
18 | It is really these emerging tools that offer the most promise in applying "code management" concepts to "content management".
19 | 
20 | One of the strategies of content as code is, in addition to having a author-centric approach to prioritising features and improving user experience, to follow a somewhat bottom-up, tech-centric approach simultaneously which aims to iterate on the above building blocks to see how well they can be assembled to provide new useful functionalities for content management.
21 | 
22 | Some of these ideas are currently being explored in the following issues on the content as code repo:
23 |  - [Use of continuous integration to provide content verification and testing (#11)](https://github.com/iilab/contentascode/issues/11)
24 |  - [Reporting of these tests, such as link checking, in pull requests (#11)](https://github.com/iilab/contentascode/issues/11#issuecomment-196234329)
25 |  - [Implement github issues as a page discussion feature (#24)](https://github.com/iilab/contentascode/issues/24)
26 |  - [Integration with waffle.io (#35)](https://github.com/iilab/contentascode/issues/35)
27 |  - [Integration with kanban.leanlabs.io (#36)](https://github.com/iilab/contentascode/issues/36)
28 | 


--------------------------------------------------------------------------------
/technology/foundations/github.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: Github
3 | stage: source, author, collaborate, publish
4 | ---
5 | 


--------------------------------------------------------------------------------
/technology/foundations/gitlab.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: Gitlab
3 | stage: source, author, collaborate, integrate
4 | ---
5 | 


--------------------------------------------------------------------------------
/technology/foundations/markdown.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: markdown
3 | stage: author
4 | ---
5 | 
6 | # Markdown
7 | 
8 | 


--------------------------------------------------------------------------------
/technology/foundations/prose.md:
--------------------------------------------------------------------------------
 1 | ---
 2 | title: Prose
 3 | stage: author
 4 | issue: 47
 5 | ---
 6 | 
 7 | - Integrate with Gitlab backend
 8 | - Easier "Fork and Pull Request" workflow for non techies.
 9 | - Allow offline workflow
10 | - Metadata first document creation
11 | - Transclusion support (iilab/prose#1)
12 | - Prosemirror integration
13 | - Content "Integration" tests #11 (perhaps with isomorphic tests ran by prosemirror in the client)
14 | 
15 | 
16 | :[Choose editor(s) as a basis for the authoring environment #5 - Comment](https://github.com/iilab/contentascode/issues/5#issuecomment-197972547)
17 | 
18 | This [issue on ProseMirror](https://github.com/ProseMirror/prosemirror/issues/9) makes a good point about separation of concern between the editor and the backend. Substance might mean a slightly stronger coupling between document authoring, document metadata and project navigation and backend. 
19 | 
20 | In that sense Prose could be a project navigation component with ProseMirror as the authoring component (there would probably need to be some integration between the two to help for instance with navigation within a project's media or link library).  Prose would manage document metadata (in the YAML frontmatter or elsewhere) and connect to various backends (including local ones for offline editing). 
21 | 
22 | This gitbook component Repofs (https://github.com/GitbookIO/repofs) is an interesting approach to integrating the project navigation (and common features currently not in Prose like moving files, creating folders or dealing with templates.  


--------------------------------------------------------------------------------
/technology/implementation.md:
--------------------------------------------------------------------------------
 1 | ---
 2 | title: Implementation
 3 | ---
 4 | 
 5 | > See the **work in progress for the [docsmith](docsmith) reference implementation**
 6 | 
 7 | > Also see the [status page](../../status) and [roadmap](../../status#roadmap)
 8 | 
 9 | ## Developer Experience
10 | 
11 | Focus on allowing user to start from a project scaffold:
12 | 
13 |   - a Blog (Jekyll compatible) with added "Contribute to this page" links.
14 |   - a Wiki (Gollum compatible)
15 |   - a Resource website
16 |   - a Software documentation site 
17 | 
18 | We could create repos (```contentascode-blog```, ```contentascode-wiki```, ```contentascode-site```, ```contentascode-doc```) that are ready to clone with some sensible defaults. 
19 | 
20 | The default pipelines would have a travis.yml that push to a ```gh-pages``` branch.  
21 | 
22 | We could also look into Grunt-init or Yeoman Project Scaffolding tools to allow configuration of various options such as:
23 | 
24 |  - Choice of templating language and other frontend framework choices
25 |  - Choice of integration backend (Jekyll/Metalsmith/...)
26 |  - Choice of a theme (Bootstrap and variants, Foundation, GH Pages themes...)
27 |  - Adoption of metadata schemas (SPAR, Provenance, DigiSec Taxonomy).
28 |  - Configuration of tools like Prose with good usable defaults.
29 |  - Enabling of other CI backends (Gitlab CI, Jenkins, Thoughtworks Go,...)
30 |  - Configuration, integration and deployment (Heroku button style) of micro-services (like commenting, stats,...)
31 | 
32 | We also need to think about migration and various options to use [integrations](https://github.com/iilab/contentascode/labels/integration) to facilitate a progressive transition process from CMSes to the content as code approach.
33 | 
34 | ## Reference Implementation Matrix
35 | 
36 | |                Name               |               Description                |  Repo  |    Editor    | Generator  |    Build     |   Hosting   |     Services     |
37 | |-----------------------------------|------------------------------------------|--------|--------------|------------|--------------|-------------|------------------|
38 | | scaffold-github-pages             | Fork and play.                           | Github | Prose        | Jekyll     | Github Pages | Github      |                  |
39 | | scaffold-github-jekyll-travis     | With Jekyll and Travis CI                | Github | Prose        | Jekyll     | Travis       | Github      |                  |
40 | | scaffold-github-metalsmith-travis | With Metalsmith and Travis CI            | Github | Prose        | Metalsmith | Travis       | Github      |                  |
41 | | scaffold-jekyll-jenkins           | Open source stack                        | Gitlab | Hosted Prose | Jekyll     | Jenkins      | Self-Hosted |                  |
42 | | scaffold-metalsmith-gitlabci      | Open source stack with metalsmith        | Gitlab | Hosted Prose | Jekyll     | Gitlab CI    | Self-Hosted |                  |
43 | | infra-heroku                      | Push to deploy micro-service infra       | Gitlab | Hosted Prose | Jekyll     | Jenkins      | Heroku      | Single container |
44 | | infra-docker                      | Docker single server micro-service infra |        |              |            |              |             | Multi-container  |
45 | | infra-ansible                     | Distributed micro-service infra          |        |              |            |              |             | Multi-server     |
46 | 
47 | ## Modularity
48 | 
49 | Scaffold and infrastructure repos might make some choices with regards to lower level implementation approaches (make vs bash vs gulp...) and it would be good to allow this to be plug and play. i.e. Content as Code should be opinionated with regards to concepts and architecture (and maybe its pivot data format, metadata description and other declarative things about workflow configuration), but not with regards to implementation.
50 | 
51 | This table aims to represent which components affect which stages of the content as code framework.
52 |  - Key          : means that this component is a key component for this stage.
53 |  - Change       : means that this component modifies or applies to this stage.
54 |  - +1 component : means that this component works better with another component.
55 |  - -1 component : means that this component doesn't work with another component.
56 | 
57 | | Component \ Stage |   Source  | Author |   Build   |  Integrate   | Translate |   Publish   |
58 | |-------------------|-----------|--------|-----------|--------------|-----------|-------------|
59 | | github            | Key       |        |           | +1 travis    |           | +1 gh-pages |
60 | | gitlab            | Key       |        |           | +1 gitlab-ci |           |             |
61 | | prose             | +1 github | Key    | +1 jekyll |              |           |             |
62 | | jekyll            |           |        | Key       |              |           |             |
63 | | metalsmith        |           |        | Key       |              |           |             |
64 | | travis            |           |        |           | Key          |           |             |
65 | | gitlab-ci         | -1 github |        |           | Key          |           |             |
66 | | linkchecker       |           |        |           | Change       |           |             |
67 | | transifex         |           |        |           |              | Key       |             |
68 | | gh-pages          | +1 github |        |           |              |           | Key         |
69 | 
70 | | Components \ Stages | Store | Edit | Share | Check | Translate | Publish |
71 | |---------------------|-------|------|-------|-------|-----------|---------|
72 | 
73 | 
74 | 


--------------------------------------------------------------------------------
/technology/implementation/docsmith.md:
--------------------------------------------------------------------------------
  1 | ---
  2 | title: docsmith
  3 | source: https://github.com/contentascode/docsmith/README.md
  4 | ---
  5 | 
  6 | > An npm module called [docsmith](https://www.npmjs.com/package/docsmith) has been published with the following README.md
  7 | 
  8 | # This README is out of date and should benefit from dependency tracking! See the [current README here](https://github.com/contentascode/docsmith/blob/master/README.md)
  9 | 
 10 | Content as Code aims to make it easy to start a website in just a few steps but also build complex content publishing pipelines. It develops best practices to managing content workflows inspired from how code is managed in large collaborative software engineering projects.
 11 | 
 12 | **docsmith** implements the Content as Code framework using metal*smith*, pan*doc* and *doc*ker microservice deployment.
 13 | 
 14 | ## Getting Started
 15 | 
 16 | The simplest way to get started is to fork one of our sample repos on github:
 17 |  - https://github.com/contentascode/ blog: A template for a simple blog
 18 |  - https://github.com/contentascode/ wiki: A template for a wiki
 19 |  - https://github.com/contentascode/ doc: A template for software documentaiton
 20 |  - https://github.com/contentascode/ site: A template for a simple website
 21 | 
 22 | You can have these templates up and running simply by [activating Github pages on your fork](). This will make the site available after a few minutes on http://USER.github.io/REPO where ORG is the name of the user or organisation which forked the repo, and REPO is the name of the REPO (which should be blog or site, unless you renamed it.)
 23 | 
 24 | Wow, that was easy and fast. What can I do next?
 25 | 
 26 | ### Use your own domain name
 27 | 
 28 | You can make your new site available on the domain name of your choice. If you have procured a domain name you can simply create a CNAME file at the base of this repository and point your DNS following these instructions.
 29 | 
 30 | ### Collaboration
 31 | 
 32 | The Content as Code workflow uses best practices to allow different people to contribute to your content project, in the way that large software engineering projects in the open source world do it.
 33 | 
 34 | The sample repos use Github (soon Prose) to help with content editing. By default, all pages of your new website have built in links to  
 35 | 
 36 | ### Checking Links
 37 | 
 38 | You can go to the next level by using another free online service (Travis CI) to build your site. This will provide you with additional features such as using validations. For instance to check that links are working or that your content is generally well formatted and readable. You can activate travis by going to travis-ci.com signing up and activating travis for your USER/REPO project.
 39 | 
 40 | Is that it? Yes, now you'll receive emails with notifications each time there is a problem with your website build, like a broken link or possible other problems with your site. 
 41 | 
 42 | (Open an issue to report broken link, replace with an archive.org link if broken link!)
 43 | 
 44 | ### Choose a theme
 45 | 
 46 | You can change our default website layout and theme if you have activated Travis CI in the previous step. In that case, you can edit the docsmith.yml file and change the theme to another content as code enabled jekyll theme we support.
 47 | 
 48 | ### What next?
 49 | 
 50 | We're planning to implement many more features with a content as code approach for instance doing diagrams, interactive content, or integration with and migration from your existing content management system.
 51 | 
 52 | If you want to go deeper into **docsmith** and content as code, you can also help us develop the command line tool we have started designing below which will help more advanced users with more sophisticated content management needs. It is based on a modular approach
 53 | 
 54 | ## Docsmith CLI tool
 55 | 
 56 |  - ```npm install -g docsmith``` : installs content CLI tool.
 57 | 
 58 |  - ```docsmith init```: Or ```docsmith init <template>``` like ```docsmith init blog```, ```docsmith init doc``` or ```docsmith init wiki```.
 59 |  - ```docsmith install``` : in a repo would read content.yml and create package.json, metalsmith.json and docker-compose.json and run necessary installations (npm install,...). 
 60 |  - ```docsmith install validator``` : Install default plugin suite in validator (linkchecker) or the one specified in the docsmith.yml file.
 61 |  - ```docsmith install validator styleguide```: Install specific plugin (and updates the yml file)
 62 | 
 63 |  - ```docsmith build```: Build the content locally.
 64 |  - ```docsmith serve```: Serve the content locally. (Should probably open a console and allow to `pull`,`update` or `pull` within it)
 65 |  - ```docsmith publish```: Publishes the content (and configure and/or deploy needed microservices).
 66 | 
 67 |  - ```docsmith load/pull``` : Get local content updates 
 68 |  - ```docsmith load/pull <version>```: Get specific version.
 69 |  - ```docsmith update```: Get remote content dependency updates.
 70 |  - ```docsmith save/push``` : Push content source updates and advertise changes.
 71 |  - ```docsmith save/push <version>``` : Push content source updates and advertise changes.
 72 | 
 73 | Example ```docsmith.yml```:
 74 | 
 75 | ```yaml
 76 | source: .                       # By default uses current directory, should be able to pull a remote directory too.
 77 | build: 'github-pages'           # How is the build pipeline managed. could be travis, gitlab-ci, drone, local Makefile, gulp, grunt...
 78 | 
 79 | components:
 80 |   source: 'github'              # Defaults to github could also be gitlab or a local folder or a remote url. Gollum for a wiki?
 81 |   transform: ''                 # Maybe some type of pre-processing
 82 |   validate: ''                  # Defaults to empty. List of validation scripts, for instance links,...
 83 |   editor: 'github'              # What is the content authoring environment? Could be prose, realms,... 
 84 |   generate: 'github-pages'      # How is the site generated. Could be github-pages, jekyll, metalsmith, hugo... 
 85 |   publish: 'github-pages'       # Where is the content hosted? 
 86 |   discuss: 'github-issues'      # Discussion threads, comments, wiki style discuss page...
 87 |   review: 'github'              # Line based review like github code comments
 88 |   stats: 'piwik'
 89 |   dependencies: ''
 90 | ```
 91 | 
 92 |  - ```docsmith modules``` : display list of available modules.
 93 |  - ```docsmith source``` : display current source settings.
 94 |  - ```docsmith source gitlab``` : changes repo to gitlab.
 95 |  - ```docsmith build travis-ci``` : changes build system to travis ci.
 96 |  - ```docsmith validate links``` : Adds link validator module.
 97 | 
 98 | # Components API
 99 | 
100 | ## repo 
101 | 
102 | ### API
103 | 
104 |  - pull: get the latest (or default) version from the content repo.
105 |  - update: pulls dependencies (through git submodules or a package management approach or another yet to be developed approach)
106 |  - version: get a specific version (github version tag or branch or ). From docsmith's perspective all versions are really branches that can be worked on a later merged onto other versions aiming to pick the best merge strategy based on heuristics.
107 |  - push: pushes local changes to content repo.
108 | 
109 | ### Implementation
110 | 
111 | Configures the build pipeline (for now metalsmith) with the proper and desired source content version. This should allow to wrap dependency management (include with git submodules if wanted).
112 | 
113 | ### repo-github
114 | 
115 |  * This module connects docsmith to a github repository as a content source.
116 |  * Configuration options
117 |      - `repo`: 
118 |          + `url` : (Required) URL of repo.
119 |          + `branch`: (Optional - Defaults to master) 
120 | 
121 | 
122 | ## build
123 | 
124 | ### API
125 | 
126 |  - build: 
127 |  - watch:
128 | 
129 | ### build-github-pages
130 | 
131 |  * Configuration options
132 |      - `source`
133 |        +
134 | 
135 | ## validate
136 | 
137 | 


--------------------------------------------------------------------------------
/technology/inspiration.md:
--------------------------------------------------------------------------------
 1 | ---
 2 | title: Inspiration
 3 | ---
 4 | 
 5 | * TOC
 6 | {:toc}
 7 | 
 8 | ## Content Authoring
 9 | 
10 | ### Web based Editors
11 | 
12 |  - Quip
13 |  - Penflip
14 |  - Draftin
15 |  - Realms.io
16 | 
17 | ### Markdown
18 | 
19 |  - Sublime Table plugin (helps format makrdown tables)
20 |  - [Mermaid](http://knsv.github.io/mermaid/live_editor/) generates diagrams from an extended markdown-like syntax
21 |  - EdX [Multiple Choice Problem Simple Editor](http://edx.readthedocs.org/projects/edx-partner-course-staff/en/latest/exercises_tools/multiple_choice.html#use-the-simple-editor-to-create-a-multiple-choice-problem) 
22 | 
23 | ## Complex Documentation Generation Pipelines
24 | 
25 |  - [Result](http://ionicframework.com/docs/api/directive/ionTabs/)
26 |  - [Build process from the ```ionic``` repo](https://github.com/driftyco/ionic#documentation)
27 |    - [Gulp script](https://github.com/driftyco/ionic/blob/master/config/gulp-tasks/docs.js)
28 | 
29 | 


--------------------------------------------------------------------------------
/technology/taxonomies.md:
--------------------------------------------------------------------------------
 1 | # Taxonomies
 2 | 
 3 | There are a number of categorisations and naming going on so here they are grouped.
 4 | 
 5 | <!-- MarkdownTOC -->
 6 | 
 7 | - [Stages](#stages)
 8 | - [Stacks / Systems](#stacks--systems)
 9 | - [Components](#components)
10 | - [Collaboration](#collaboration)
11 | 
12 | <!-- /MarkdownTOC -->
13 | 
14 | ## Stages
15 | 
16 | These are moments in the content management workflow or life cycle, from the point of view of the authors and other content stakeholders.
17 | 
18 |  - Store
19 |  - Edit
20 |  - Share
21 |  - Check
22 |  - Translate
23 |  - Publish
24 | 
25 | ## Stacks / Systems
26 | 
27 | These are groups of software tools, formats, protocols and norms that underly content management work.
28 | 
29 |  - Source
30 |  - Author
31 |  - Integrate
32 |  - Collaborate
33 |  - Generate
34 |  - Translate
35 |  - Publish
36 | 
37 | ## Components
38 | 
39 | Are actual software tools, formats, protocols that can be added/supported by particular implementations of content as code. Such as Github. Gitlab, Prose, Markdown, Jekyll, Metalsmith... Each component might server a purpose for a stage (or several) and is generally within a particular stack. A choice of component in one particular area of a stack might enable or limit choices elsewhere in the stack.
40 | 
41 | ## Collaboration
42 | 
43 | This is very much [under heavy thinking](/technology/workflow).
44 | 
45 | Progress Tags (waffle/kanban)
46 | 
47 | Category (WBS) Tags
48 |  - `Meta`
49 |  - `Design`
50 |  - `API`
51 |  - `Documentation`
52 |  - `Features`
53 | 
54 | Milestones
55 | - 
56 | 
57 | Pull requests
58 |  - 
59 | 


--------------------------------------------------------------------------------
/technology/translation.md:
--------------------------------------------------------------------------------
 1 | ---
 2 | title: Translation
 3 | ---
 4 | 
 5 | * TOC
 6 | {:toc}
 7 | 
 8 | ## Goal
 9 | 
10 | Allow translation of content that is managed with static website generators (https://www.staticgen.com/)
11 | 
12 | With this approach the de factor standard is to have what’s called a Frontmatter which is YAML included into Markdown, allowing to store metadata together with rich text. Many keys in the front matter should be translatable (title, summary, button text and what not) while others shouldn’t.
13 | 
14 | Our approach to enable the translation of such source text with Transifex (or other standard tools) is to build a round trip transformation script which creates JSON Key Value (with language independent keys) for the documents, in order to allow their translation.
15 | 
16 | ## How Panic Button is doing it
17 | 
18 | ### Git repositories: 
19 | 
20 | 1. [panicbutton.io](https://github.com/PanicInitiative/panicbutton.io) (jekyll site)
21 | 2. [PanicButton](https://github.com/PanicInitiative/PanicButton) (Android app) 
22 | 
23 | ### Panicbutton.io Transifex Workflow
24 | 
25 | #### Markdown source
26 | 
27 | **[Status: Existing in the panicbutton.io repository]**
28 | 
29 | The markdown files in the panicbutton.io Jekyll site's _posts directory serve as the source files for the translation process. Authors use [Prose](https://admin.panicbutton.io/) to edit the markdown source files, in English, triggering a rebuild of the site on update of a markdown post. 
30 | 
31 | Files that move from the panicbutton.io repository to the PanicButton Android app through the Transifex translation process are located in _posts/mobile and _posts/help. These relevant markdown files contain the yaml "categories" assignment "mobile" or "help". 
32 | 
33 | #### Markdown -> JSON Key-Value Pair conversion
34 | 
35 | **[Status: tx_md2jsonKV.py Script in progress]**
36 | 
37 | Because the markdown files for panicbutton.io contain extensive amounts of yaml front matter, it is necessary to convert the files to JSON prior to sending them to Transifex. Transifex does not handle the mixed yaml/markdown source well. A push to the panicbutton.io repository triggers travis.yaml to launch the bash script, **tx_md2jsonKV.py**, which converts all markdown files in _posts into JSON Key-Value pairs comprising key-value pairs. **tx_md2jsonKV.py** builds these new JSON Key-Value files in the _locales directory. 
38 | 
39 | In this conversion process, there is one JSON file for each language, with each master JSON file containing yaml front-matter and content of that language's markdown files. Each item of yaml front-matter represents a new key, and the markdown content also comprises one key, "content". For example, if the folder _posts/mobile/ has ten markdown files, the resulting JSON file, **mobile.json**, will comprise all ten of the markdown files, each broken down into its yaml and markdown key-value pairs. 
40 | 
41 | #### Transifex configuration
42 | 
43 | **[Status: .tx config creation in progress]**
44 | 
45 | Transifex is hooked into panicbutton.io's root in a .tx folder that contains the [Transifex config file](http://docs.transifex.com/client/config/) (**.tx/config**). The config file alerts the Transifex client to files in the repository that are subject to translation in Transifex; dictates the naming convention for the returned, translated files; and sets the file format (here, Key-Value JSON). 
46 | 
47 | #### JSON -> Transifex: Registering a change
48 | 
49 | **[Status: TXGH Integration TODO]**
50 | 
51 | If the newly built JSON Key-Value files (in _locales, from **tx_md2jsonKV.py**) differ from the ones that they replace, [TXGH](https://github.com/transifex/txgh), a Sinatra-based transifex-github integration/server, registers this change to the files in _locales. It updates Transifex to show that each language's repository is no longer 100% translated. This cues translators to update each language's translations. 
52 | 
53 | #### Transifex: Returning translated files to repository
54 | 
55 | **[Status: TXGH integration TODO, python script tx_jsonKV2md.py in progress]**
56 | 
57 | When a translator completes a language's translation, and the Transifex repository registers 100% completion, TXGH pushes the newly translated JSON Key-Value files into panicbutton.io's git repository at _locales/\<lang\>/, overwriting the files that exist in this repository (the old translations). 
58 | 
59 | This push triggers another bash script prompted by travis.yaml, **tx_jsonKV2md.py**, which converts the JSON Key-Value files in _locales/\<lang\>/ back into markdown. The new markdown files are placed in _posts/\<lang\>/, replacing the markdown files from the previous round of translations. 
60 | 
61 | #### Pushing Markdown files to Android Panic Button App
62 | 
63 | **[Status: travis.yaml cloning and pushing to Android application TODO]**
64 | 
65 | On each push to the panicbutton.io dev branch, travis.yaml performs a process to transform and push relevant information to the PanicButton Android application repository. First, travis.yaml <code>git clones</code> the PanicButton Android application's asset repository. The script then converts all of the markdown files in \_posts/mobile and \_posts/help (including all files in the \_posts/mobile/\<lang\> and \_posts/help/\<lang\> directories) into custom, PanicButton-specific JSON following templates located in /api/help.json and /api/mobile.json. These files are named **mobile\_\<lang\>.json** and **help\_\<lang\>.json**. 
66 | 
67 | Upon creation, the files are copied into the newly cloned PanicButton App assets directory, over-writing the now-outdated, equivalently-named files. 
68 | 
69 | Next, travis.yaml calls <code>git add -A && git commit -m "Updating translations to the PanicButton Application" && git push origin dev</code>. If the newly created JSON files, mobile_\<lang\>.json, differ from the previous versions (eg if the <code>git push</code> that called the script represents an updated translation), then the changes will be committed and pushed to the PanicButton Android Application's repository. This triggers a rebuild of the app. If the JSON files, mobile_\<lang\>.json, have not changed, then the cloned directory will not register any change on <code>git add -A</code>, and so the <code>git commit && git push origin dev</code> will fail without triggering an error. 
70 | 
71 | ### Panic Button Android App Additional Transifex workflow
72 | 
73 | #### strings.XML
74 | 
75 | **[Status: .tx config creation in progress. TXGH integration TODO]**
76 | 
77 | The PanicButton Android app contains an additional Transifex workflow. The app has translatable material independent of the panicbutton.io source files in the **/src/main/res/values/strings.xml** file. 
78 | 
79 | Thus, the PanicButton Android Application repository also houses a .tx folder with its own config file, which dictates the translation source, resulting file names, and format for **strings.xml**.
80 | 
81 | A TXGH integration in the PanicButton app repository will register a pushed change in the **strings.xml** file, updating **strings.xml** in the Transifex repository to show that translation is no longer complete and alerting translators that an update to the translation is necessary. 
82 | 
83 | Upon completion of the translation, TXGH will return the translated files to the PanicButton repository, placing them in the directories **/src/main/res/values-\<lang\>**, with each language's file named **strings.xml**. Existing translations in each of these directories will be overwritten by this action from TXGH. The app will be rebuilt upon return of new files. 
84 | 


--------------------------------------------------------------------------------
/technology/workflow.md:
--------------------------------------------------------------------------------
  1 | ---
  2 | title: Workflow
  3 | ---
  4 | 
  5 | # Content as Code Implementation Workflows
  6 | 
  7 | The contentascode repo should track overall framework discussions. It should use a tagging structure that helps follow the right level of interest or focus of work, for instance:
  8 | - `Meta` - Focus on organisational aspects, partnerships,...
  9 | - `Design` - Overall contentascode framework discussions such as use cases, users stories
 10 | - `API` - Discussion about shared APIs across implementations (`content update` or the `_content.yml` structures).
 11 | - `Documentation` - About the contentascode website as the main source of documentation for the effort, including onboarding, visual explanations, approach to communication.
 12 | - `Features` - Discussion and tracking of the progress of specific features across contentascode implementations. For instance `link checking` or `project scaffolding` or `automatic anchors`
 13 | - Logical grouping of `Features` or *Parity* with well known tools or stacks. Such as Blogging (or Octopress, Medium), or Wiki (or MediaWiki or Gollum), or CMSes (Drupal,...). 
 14 | > Right now I'm trying to use different tags for each "parity goals" but maybe having a `parity` tag and have several issues underneath would be better. Each issue linking to the other constituting issues, which raises the effort of linking slightly. 
 15 | 
 16 | ## Progress
 17 | 
 18 | I suspect there's a smart use of Pull Requests. 
 19 |  - Tracking implementations progress. Maybe implementations fork the contentascode repo inside their organisation repo (or maybe a smaller "implementation" repo?) and "check" features or compatible APIs as they progress. This way users that want to follow progress of a particular implementation at a higher level can do so by subscribing to a pull request...
 20 | 
 21 | With the waffle approach, we might be able, and have an incentive to for display purposes on the board, to have another mechanism to group issues which is more task driven. This needs more thinking.
 22 | 
 23 | ## Notifications
 24 | 
 25 | Piggy backing on the Githb/[Gitlab notifications](http://doc.gitlab.com/ee/workflow/notifications.html) seems like the low hanging fruit. These various levels are available:
 26 | 
 27 | *Participating* notifications are those in which you are directly involved in a conversation. You will automatically receive these notifications when:
 28 | 
 29 | - Someone mentions you or a team you're a member of
 30 | - You are assigned to an issue or pull request
 31 | - Someone makes a comment in a conversation you're subscribed to
 32 | 
 33 | *Watching* notifications are those in which you are actively watching a repository, but aren't necessarily participating. You will automatically receive these notifications for:
 34 | 
 35 | - Opened issues and their comments
 36 | - Opened pull requests and their comments
 37 | - Comments on any commits
 38 | - Published releases
 39 | 
 40 | Thoughts:
 41 |  - Watching the whole repo is an argument in favor of small modules/repos, but if so it might make subscription to a master repo harder.
 42 |  - Watching an issue thread, therefore navigation in issues - through tags, milestone - is key, and should also feed into the static generation
 43 |  - Watch a pull request, something well suited for external contributions.
 44 | 
 45 | ## Public Chat
 46 | 
 47 |  - Rocket.Chat dedicated instance
 48 |  - IRC Bridge -> IRC public logs.
 49 |  - 
 50 | 
 51 | ## RSS
 52 | 
 53 | It's interesting to think about how RSS could be used to track changes on the static website at various levels too.
 54 | 
 55 | ## Notes
 56 | 
 57 | Semantics
 58 |  - Watch/Subscribe
 59 |     - Item
 60 |     - Group
 61 |  - Participate/Mentions
 62 |  - Configure Delivery
 63 |    - Channels
 64 |      - Email
 65 |      - RSS
 66 |      - IRC/Chat
 67 |      - Third party platform (Github/Gitlab/...)
 68 |    - Frequency
 69 |      - Immediately
 70 |      - Batch
 71 | 
 72 | The first step is to depend on an external service for notifications (despite the need to register/login). Good candidates are the Github/Gitlab issue trackers (Gitlab self-hosted allowing to avoid third party authentication dependencies). 
 73 | 
 74 | In that case there should be mappings of content items to issues (#24) and notifications can be managed through the issue subscription mechanism. Here are possible approaches:
 75 | 
 76 | #### Approach A
 77 | > Example for one master repo
 78 | 
 79 | Repo: https://github.com/iilab/contentascode
 80 | Issues: https://github.com/iilab/contentascode/issues
 81 | 
 82 | One issue could be mapped to one page.
 83 |  - PROS: The issue can be used as a discussion page. 
 84 |  - CONS: Lots of issues. 
 85 | 
 86 | Implementation:
 87 |  - At first an `issue` metadata key could be added with the issue number.
 88 |  - Later an issue could be created automatically via the issue tracker's API.
 89 |  - Commits could be checked and amended with the proper issue number so that they appear in the issue thread.
 90 | 
 91 | #### Approach B
 92 | > One master repo, issues are orthogonal to the content (a more classical setup between code and issue tracking or documentation and issues)
 93 | 
 94 | Repo: https://github.com/iilab/openmentoring-mobile
 95 | Issues: https://github.com/iilab/openmentoring-mobile/issues
 96 | 
 97 | #### Approach C
 98 | > Multiple subrepos, corresponding to "areas of interest"
 99 | 
100 | Repo: https://code.iilab.org/openintegrity/openintegrity.org
101 | Subrepos:
102 |  - https://code.iilab.org/openintegrity/framework
103 |  - https://code.iilab.org/openintegrity/design
104 |  - https://code.iilab.org/openintegrity/practices
105 |  - https://code.iilab.org/openintegrity/impact
106 | 
107 | 


--------------------------------------------------------------------------------