<head>
<meta charset="UTF-8">
<title>Project Structure and Ontology</title>
- <link href="https://fonts.googleapis.com/css2?family=Noto+Sans+JP&display=swap" rel="stylesheet">
<script src="setup.js"></script>
- <script> window.StyleRT.body_visibility_hidden(); </script>
<script>
window.StyleRT.include('RT/theme');
window.StyleRT.include('RT/layout/article_tech_ref');
<h1>Top-Level Repository Layout</h1>
<p>
- A team member will source the project setup file to take on a role. As of this writing, the supported roles are: <RT-code>administrator</RT-code>, <RT-code>developer</RT-code>, <RT-code>tester</RT-code>, and <RT-code>user</RT-code>.
+ A team member will source the project setup file to take on a role. As of this writing, the supported roles are: <RT-code>administrator</RT-code>, <RT-code>developer</RT-code>, <RT-code>tester</RT-code>, and <RT-code>consumer</RT-code>.
</p>
<ul>
<li><RT-code>administrator/</RT-code> — Project-local tools and skeleton maintenance.</li>
<li><RT-code>developer/</RT-code> — Primary workspace for developers.</li>
<li><RT-code>tester/</RT-code> — Regression and validation workspace for testers.</li>
- <li><RT-code>user/</RT-code> — Consumption workspace holding the <RT-code>release</RT-code> directory.</li>
+ <li><RT-code>consumer/</RT-code> — Consumption workspace holding the <RT-code>release</RT-code> directory.</li>
<li><RT-code>shared/</RT-code> — Shared ecosystem tools and global environments.</li>
</ul>
- <h1>The User Tree</h1>
+ <h1>The Consumer Tree</h1>
<p>
- The <RT-code>user/release/</RT-code> tree is where developers put work product that is ready to be consumed. The entire <RT-code>user/release</RT-code> directory is git-ignored and treated as a transient deployment target.
+ The <RT-code>consumer/release/</RT-code> tree is where developers put work product that is ready to be consumed. The entire <RT-code>consumer/release</RT-code> directory is git-ignored and treated as a transient deployment target.
</p>
<p>
Artifacts arrive in the <RT-code>release/</RT-code> tree <em>only</em> when the developer invokes the <RT-code>release</RT-code> script, which performs a flat-copy from the developer's <RT-code>scratchpad/stage</RT-code> directory.
<head>
<meta charset="UTF-8">
<title>Workflow and Build Contract</title>
- <link href="https://fonts.googleapis.com/css2?family=Noto+Sans+JP&display=swap" rel="stylesheet">
- <script src="../../style/body_visibility_hidden.js"></script>
- <script> window.StyleRT.body_visibility_hidden(); </script>
+ <script src="setup.js"></script>
+ <script>
+ window.StyleRT.include('RT/theme');
+ window.StyleRT.include('RT/layout/article_tech_ref');
+ </script>
</head>
<body>
<RT-article>
<li>Write and modify <RT-code>authored/</RT-code> source.</li>
<li>Run builds and stage artifacts in <RT-code>scratchpad/stage</RT-code>.</li>
<li>Spot test in <RT-code>experiment/</RT-code>.</li>
- <li>Execute the <RT-code>release write</RT-code> script to copy artifacts to <RT-code>user/release</RT-code> for consumption/testing.</li>
+ <li>Execute the <RT-code>release write</RT-code> script to copy artifacts to <RT-code>consumer/release</RT-code> for consumption/testing.</li>
</ol>
<h2>Tester Role</h2>
<p>Responsibilities:</p>
<ol>
- <li>Validate candidates under <RT-code>user/release/</RT-code>.</li>
+ <li>Validate candidates under <RT-code>consumer/release/</RT-code>.</li>
<li>Run regression suites.</li>
<li>Approve for quality and completeness, and create release branches.</li>
</ol>
. setup administrator
. setup developer
. setup tester
-. setup user
+. setup consumer
</RT-code>
<p>
It is common to have multiple terminal sessions or IDEs open, each running under a different role environment.
<h1>Release Promotion</h1>
<p>
- Building and promotion are separate activities. The developer compiles and stages files in <RT-code>developer/scratchpad/stage</RT-code>. The developer then runs <RT-code>release write</RT-code> to transfer those files to <RT-code>user/release</RT-code>.
+ Building and promotion are separate activities. The developer compiles and stages files in <RT-code>developer/scratchpad/stage</RT-code>. The developer then runs <RT-code>release write</RT-code> to transfer those files to <RT-code>consumer/release</RT-code>.
</p>
<p>
- The <RT-code>user/release</RT-code> directory is strictly an untracked deployment target. No tools may rebuild during promotion, and no builds are run directly inside the release directory.
+ The <RT-code>consumer/release</RT-code> directory is strictly an untracked deployment target. No tools may rebuild during promotion, and no builds are run directly inside the release directory.
</p>
-
- <script src="../../style/style_orchestrator.js"></script>
</RT-article>
</body>
</html>
window.RT_REPO_ROOT = "../../";
-
document.write('<script src="' + window.RT_REPO_ROOT + 'shared/style_directory_dict.js"></script>');
document.write('<script src="' + window.RT_REPO_ROOT + 'shared/third_party/RT-style-JS_public/consumer/release/RT/core/loader.js"></script>');
document.write('<script src="' + window.RT_REPO_ROOT + 'shared/third_party/RT-style-JS_public/consumer/release/RT/core/body_visibility_hidden.js"></script>');
<head>
<meta charset="UTF-8">
<title>RT Prescriptive Code Format Guide</title>
- <link href="https://fonts.googleapis.com/css2?family=Noto+Sans+JP&display=swap" rel="stylesheet">
- <script src="../../style/body_visibility_hidden.js"></script>
- <script> window.StyleRT.body_visibility_hidden(); </script>
+ <script src="setup.js"></script>
+ <script>
+ window.StyleRT.include('RT/theme');
+ window.StyleRT.include('RT/layout/article_tech_ref');
+ </script>
</head>
<body>
<RT-article>
<li>Never use tabs.</li>
<li>Nest lines under the syntactic element that opened them.</li>
</ul>
-
- <script src="../../style/style_orchestrator.js"></script>
</RT-article>
</body>
</html>
<head>
<meta charset="UTF-8">
<title>RT Prescriptive Code Format Guide</title>
- <link href="https://fonts.googleapis.com/css2?family=Noto+Sans+JP&display=swap" rel="stylesheet">
- <script src="../../style/body_visibility_hidden.js"></script>
- <script> window.StyleRT.body_visibility_hidden(); </script>
+ <script src="setup.js"></script>
+ <script>
+ window.StyleRT.include('RT/theme');
+ window.StyleRT.include('RT/layout/article_tech_ref');
+ </script>
</head>
<body>
<RT-article>
<li>Never use tabs.</li>
<li>Nest lines under the syntactic element that opened them.</li>
</ul>
-
- <script src="../../style/style_orchestrator.js"></script>
</RT-article>
</body>
</html>
<head>
<meta charset="UTF-8">
<title>Naming and Directory Conventions</title>
- <link href="https://fonts.googleapis.com/css2?family=Noto+Sans+JP&display=swap" rel="stylesheet">
- <script src="../../style/body_visibility_hidden.js"></script>
- <script> window.StyleRT.body_visibility_hidden(); </script>
+ <script src="setup.js"></script>
+ <script>
+ window.StyleRT.include('RT/theme');
+ window.StyleRT.include('RT/layout/article_tech_ref');
+ </script>
</head>
<body>
<RT-article>
<p>
The RT C coding environment does not use separate source and header files. Instead, a variable is set that gates off the implementation if the source code is to be used as a header. Hence, all of our C source fits fine within an <RT-code>authored</RT-code> directory.
</p>
-
- <script src="../../style/style_orchestrator.js"></script>
</RT-article>
</body>
</html>
<head>
<meta charset="UTF-8">
<title>Language Addenda (C, Python, Bash, Lisp)</title>
- <link href="https://fonts.googleapis.com/css2?family=Noto+Sans+JP&display=swap" rel="stylesheet">
- <script src="../../style/body_visibility_hidden.js"></script>
- <script> window.StyleRT.body_visibility_hidden(); </script>
+ <script src="setup.js"></script>
+ <script>
+ window.StyleRT.include('RT/theme');
+ window.StyleRT.include('RT/layout/article_tech_ref');
+ </script>
</head>
<body>
<RT-article>
<p>
When in doubt, start with <RT-code>02_RT_Code_Format.html</RT-code> for the core rules, then apply the relevant language section here. If a language requires deviation from the generic rules, document that deviation in this file instead of ad-hoc decisions.
</p>
-
- <script src="../../style/style_orchestrator.js"></script>
</RT-article>
</body>
</html>
--- /dev/null
+window.RT_REPO_ROOT = "../../";
+document.write('<script src="' + window.RT_REPO_ROOT + 'shared/style_directory_dict.js"></script>');
+document.write('<script src="' + window.RT_REPO_ROOT + 'shared/third_party/RT-style-JS_public/consumer/release/RT/core/loader.js"></script>');
+document.write('<script src="' + window.RT_REPO_ROOT + 'shared/third_party/RT-style-JS_public/consumer/release/RT/core/body_visibility_hidden.js"></script>');
--- /dev/null
+window.RT_REPO_ROOT = "../";
+document.write('<script src="' + window.RT_REPO_ROOT + 'shared/style_directory_dict.js"></script>');
+document.write('<script src="' + window.RT_REPO_ROOT + 'shared/third_party/RT-style-JS_public/consumer/release/RT/core/loader.js"></script>');
+document.write('<script src="' + window.RT_REPO_ROOT + 'shared/third_party/RT-style-JS_public/consumer/release/RT/core/body_visibility_hidden.js"></script>');
--- /dev/null
+window.RT_REPO_ROOT = "../../";
+document.write('<script src="' + window.RT_REPO_ROOT + 'shared/style_directory_dict.js"></script>');
+document.write('<script src="' + window.RT_REPO_ROOT + 'shared/third_party/RT-style-JS_public/consumer/release/RT/core/loader.js"></script>');
+document.write('<script src="' + window.RT_REPO_ROOT + 'shared/third_party/RT-style-JS_public/consumer/release/RT/core/body_visibility_hidden.js"></script>');
projects / RT-style-JS_public / commitdiff