Skip to content

Commit

Permalink
docs: publish from 3bdbe41
Browse files Browse the repository at this point in the history
  • Loading branch information
AWS PDK Automation committed Sep 8, 2023
1 parent 3e80380 commit b459f37
Show file tree
Hide file tree
Showing 19 changed files with 23 additions and 22 deletions.
2 changes: 1 addition & 1 deletion api/java/infrastructure/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -19914,7 +19914,7 @@ <h5 id="default_taskrequired_2"><code>DEFAULT_TASK</code><sup>Required</sup> <a
<small>

Last update:
2023-09-07
2023-09-08

</small>
</div>
Expand Down
2 changes: 1 addition & 1 deletion api/java/monorepo/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -20517,7 +20517,7 @@ <h5 id="dependencies"><code>DEPENDENCIES</code> <a name="DEPENDENCIES" id="@aws/
<small>

Last update:
2023-09-07
2023-09-08

</small>
</div>
Expand Down
2 changes: 1 addition & 1 deletion api/java/pdk-nag/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -4501,7 +4501,7 @@ <h6 id="stackrequired_4"><code>stack</code><sup>Required</sup> <a name="stack" i
<small>

Last update:
2023-09-07
2023-09-08

</small>
</div>
Expand Down
2 changes: 1 addition & 1 deletion api/java/static-website/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -5133,7 +5133,7 @@ <h6 id="_optionsrequired"><code>_options</code><sup>Required</sup> <a name="_opt
<small>

Last update:
2023-09-07
2023-09-08

</small>
</div>
Expand Down
2 changes: 1 addition & 1 deletion api/python/aws-arch/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -6867,7 +6867,7 @@ <h5 id="tertiary_1"><code>TERTIARY</code> <a name="TERTIARY" id="@aws/aws-arch.a
<small>

Last update:
2023-09-07
2023-09-08

</small>
</div>
Expand Down
2 changes: 1 addition & 1 deletion api/python/cdk-graph-plugin-diagram/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -4431,7 +4431,7 @@ <h5 id="category"><code>CATEGORY</code> <a name="CATEGORY" id="@aws/cdk-graph-pl
<small>

Last update:
2023-09-07
2023-09-08

</small>
</div>
Expand Down
2 changes: 1 addition & 1 deletion api/python/cdk-graph/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -29448,7 +29448,7 @@ <h5 id="import_arn"><code>IMPORT_ARN</code> <a name="IMPORT_ARN" id="@aws/cdk-gr
<small>

Last update:
2023-09-07
2023-09-08

</small>
</div>
Expand Down
2 changes: 1 addition & 1 deletion api/python/cloudscape-react-ts-website/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -11289,7 +11289,7 @@ <h5 id="default_taskrequired"><code>DEFAULT_TASK</code><sup>Required</sup> <a na
<small>

Last update:
2023-09-07
2023-09-08

</small>
</div>
Expand Down
2 changes: 1 addition & 1 deletion api/python/identity/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -5018,7 +5018,7 @@ <h5 id="user_verificationoptional_1"><code>user_verification</code><sup>Optional
<small>

Last update:
2023-09-07
2023-09-08

</small>
</div>
Expand Down
2 changes: 1 addition & 1 deletion api/python/infrastructure/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -20266,7 +20266,7 @@ <h5 id="default_taskrequired_2"><code>DEFAULT_TASK</code><sup>Required</sup> <a
<small>

Last update:
2023-09-07
2023-09-08

</small>
</div>
Expand Down
2 changes: 1 addition & 1 deletion api/python/monorepo/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -22141,7 +22141,7 @@ <h5 id="dependencies"><code>DEPENDENCIES</code> <a name="DEPENDENCIES" id="@aws/
<small>

Last update:
2023-09-07
2023-09-08

</small>
</div>
Expand Down
2 changes: 1 addition & 1 deletion api/python/pdk-nag/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -4680,7 +4680,7 @@ <h6 id="stackrequired_4"><code>stack</code><sup>Required</sup> <a name="stack" i
<small>

Last update:
2023-09-07
2023-09-08

</small>
</div>
Expand Down
2 changes: 1 addition & 1 deletion api/python/static-website/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -5144,7 +5144,7 @@ <h6 id="origin_idrequired"><code>origin_id</code><sup>Required</sup> <a name="or
<small>

Last update:
2023-09-07
2023-09-08

</small>
</div>
Expand Down
2 changes: 1 addition & 1 deletion api/typescript/aws-arch/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -6507,7 +6507,7 @@ <h5 id="tertiary_1"><code>TERTIARY</code> <a name="TERTIARY" id="@aws/pdk/aws-ar
<small>

Last update:
2023-09-07
2023-09-08

</small>
</div>
Expand Down
2 changes: 1 addition & 1 deletion api/typescript/cdk-graph-plugin-diagram/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -4389,7 +4389,7 @@ <h5 id="category"><code>CATEGORY</code> <a name="CATEGORY" id="@aws/pdk/cdk-grap
<small>

Last update:
2023-09-07
2023-09-08

</small>
</div>
Expand Down
2 changes: 1 addition & 1 deletion api/typescript/cdk-graph/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -27878,7 +27878,7 @@ <h5 id="import_arn"><code>IMPORT_ARN</code> <a name="IMPORT_ARN" id="@aws/pdk/cd
<small>

Last update:
2023-09-07
2023-09-08

</small>
</div>
Expand Down
2 changes: 1 addition & 1 deletion api/typescript/cloudscape-react-ts-website/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -8905,7 +8905,7 @@ <h5 id="default_taskrequired"><code>DEFAULT_TASK</code><sup>Required</sup> <a na
<small>

Last update:
2023-09-07
2023-09-08

</small>
</div>
Expand Down
9 changes: 5 additions & 4 deletions contributing/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -3443,7 +3443,7 @@ <h3 id="projenrc"><strong>projenrc</strong></h3>
<h3 id="packages"><strong>packages</strong></h3>
<p>Where each of the projects are synthesized.</p>
<h3 id="packagespdk"><strong>packages/pdk</strong></h3>
<p>A special 'uber' package which pulls in all of the other packages into a single distributable. This package shoudl only ever have edits to <code>scripts</code> as all src and lib are dynamically created.</p>
<p>A special 'uber' package which pulls in all of the other packages into a single distributable. This package should only ever have edits to <code>_scripts</code> as all content is dynamically created.</p>
<h2 id="creating-a-new-construct">Creating a new construct</h2>
<p>Creating a new construct is a two step process:</p>
<ol>
Expand All @@ -3453,9 +3453,9 @@ <h2 id="creating-a-new-construct">Creating a new construct</h2>
<h3 id="creating-a-new-project">Creating a new Project</h3>
<p>To create a new project, create a file in the <code>projects</code> directory called <code>&lt;your-package&gt;-project.ts</code>. Ensure <code>&lt;your-package&gt;</code> is the same name of the package you are creating to maintain consistency.</p>
<p>Create a new class as follows:</p>
<div class="highlight"><pre><span></span><code><span class="k">import</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="nx">PDKProject</span><span class="w"> </span><span class="p">}</span><span class="w"> </span><span class="kr">from</span><span class="w"> </span><span class="s2">&quot;../abstract/pdk-project&quot;</span><span class="p">;</span>
<span class="k">import</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="nx">Project</span><span class="w"> </span><span class="p">}</span><span class="w"> </span><span class="kr">from</span><span class="w"> </span><span class="s2">&quot;projen&quot;</span><span class="p">;</span>
<div class="highlight"><pre><span></span><code><span class="k">import</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="nx">Project</span><span class="w"> </span><span class="p">}</span><span class="w"> </span><span class="kr">from</span><span class="w"> </span><span class="s2">&quot;projen&quot;</span><span class="p">;</span>
<span class="k">import</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="nx">Stability</span><span class="w"> </span><span class="p">}</span><span class="w"> </span><span class="kr">from</span><span class="w"> </span><span class="s2">&quot;projen/lib/cdk&quot;</span><span class="p">;</span>
<span class="k">import</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="nx">PDKProject</span><span class="w"> </span><span class="p">}</span><span class="w"> </span><span class="kr">from</span><span class="w"> </span><span class="s2">&quot;../abstract/pdk-project&quot;</span><span class="p">;</span>

<span class="k">export</span><span class="w"> </span><span class="kd">class</span><span class="w"> </span><span class="nx">MyPackageProject</span><span class="w"> </span><span class="k">extends</span><span class="w"> </span><span class="nx">PDKProject</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="kr">constructor</span><span class="p">(</span><span class="nx">parent</span><span class="o">:</span><span class="w"> </span><span class="kt">Project</span><span class="p">)</span><span class="w"> </span><span class="p">{</span>
Expand Down Expand Up @@ -3494,7 +3494,8 @@ <h4 id="note-regarding-dependencies">Note regarding dependencies</h4>
<p>The jsii runtimes in non-javascript languages do not use <code>pnpm i</code>, and as a consequence cannot rely on <code>pnpm i</code> bringing in a packages dependencies. As a consequence, dependencies that are not themselves jsii modules, must also be referenced in the <code>bundledDependencies</code> section, so that they are bundled within the NPM package.</p>
<h3 id="write-your-code-and-tests">Write your code and tests</h3>
<p>At a minimum, your package should include a <code>index.ts</code> file which exports all of your public classes/constructs. Please refer to existing packages for reference.</p>
<p>Your package should also include a <code>docs/developer_guides/index.md</code> file which describes your constructs at a high level and optionally provide a tutorial on how to use it. This is very important as this content will be rendered on the docuemntation website and is the first port of call for end users.</p>
<p>Your package should also include a <code>docs/developer_guides/&lt;your-package&gt;/index.md</code> file which describes your constructs at a high level and optionally provide a tutorial on how to use it. This is very important as this content will be rendered on the docuemntation website and is the first port of call for end users.</p>
<p>If creating either a <code>scripts</code>, <code>samples</code> or <code>assets</code> folder within you package, please be sure to add a subdirectory underneath with you package name to ensure correct bundling of the uber package. For example: <code>scripts/&lt;package-name&gt;</code>.</p>
<p>In terms of testing, it is desired for each package to aim for a <em>minimum of 80% coverage</em> in unit tests.</p>
<h4 id="testing-cdk-constructs">Testing CDK constructs</h4>
<p>A simple way to test CDK constructs is to use snapshot testing as follows:</p>
Expand Down
2 changes: 1 addition & 1 deletion search/search_index.json

Large diffs are not rendered by default.

0 comments on commit b459f37

Please sign in to comment.