Skip to content

Commit 7a06adf

Browse files
zeusongitzeusongit
authored
Document experience marking node libraries when publishing a package in Documentation browser (#11539)
* Update PublishPackageDocumentation.html * Update doc wording; review changes
1 parent 959130d commit 7a06adf

File tree

8 files changed

+316
-8
lines changed

8 files changed

+316
-8
lines changed

‎src/DynamoCoreWpf/DynamoCoreWpf.csproj

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1313,6 +1313,7 @@
13131313
<Content Include="sharpdx_direct3d11_effects_x86.dll">
13141314
<CopyToOutputDirectory>Always</CopyToOutputDirectory>
13151315
</Content>
1316+
<EmbeddedResource Include="ViewModels\PackageManager\Docs\PublishPackageDocumentation.html" />
13161317
<Resource Include="UI\Images\undock_hover.png" />
13171318
<Resource Include="UI\Images\undock_normal.png" />
13181319
<None Include="ViewModels\Watch3D\shaderSource\helix_shader_defs\COMMON\Common.hlsl" />

‎src/DynamoCoreWpf/Properties/Resources.Designer.cs

Lines changed: 18 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎src/DynamoCoreWpf/Properties/Resources.en-US.resx

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2281,6 +2281,9 @@ Uninstall the following packages: {0}?</value>
22812281
<data name="PublishPackageSelectNodeLibraries" xml:space="preserve">
22822282
<value>Select Node Libraries</value>
22832283
</data>
2284+
<data name="PublishPackageMoreInfoFile" xml:space="preserve">
2285+
<value>DynamoCoreWpf;PublishPackageDocumentation.html</value>
2286+
</data>
22842287
<data name="DynamoViewDynamoMenu" xml:space="preserve">
22852288
<value>_Dynamo</value>
22862289
<comment>Dynamo menu</comment>
@@ -2297,6 +2300,9 @@ Uninstall the following packages: {0}?</value>
22972300
<value>_Export</value>
22982301
<comment>File menu | Export</comment>
22992302
</data>
2303+
<data name="PublishPackageDocTooltipText" xml:space="preserve">
2304+
<value>Learn More about publishing a package</value>
2305+
</data>
23002306
<data name="PreferencesViewFeaturesTab" xml:space="preserve">
23012307
<value>Features</value>
23022308
</data>
@@ -2313,4 +2319,4 @@ Uninstall the following packages: {0}?</value>
23132319
<value>_Extensions</value>
23142320
<comment>Extensions menu</comment>
23152321
</data>
2316-
</root>
2322+
</root>

‎src/DynamoCoreWpf/Properties/Resources.resx

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2287,6 +2287,9 @@ Uninstall the following packages: {0}?</value>
22872287
<data name="PublishPackageSelectNodeLibraries" xml:space="preserve">
22882288
<value>Select Node Libraries</value>
22892289
</data>
2290+
<data name="PublishPackageMoreInfoFile" xml:space="preserve">
2291+
<value>DynamoCoreWpf;PublishPackageDocumentation.html</value>
2292+
</data>
22902293
<data name="DynamoViewDynamoMenu" xml:space="preserve">
22912294
<value>_Dynamo</value>
22922295
<comment>Dynamo menu</comment>
@@ -2299,6 +2302,9 @@ Uninstall the following packages: {0}?</value>
22992302
<value>_Export</value>
23002303
<comment>File menu | Export</comment>
23012304
</data>
2305+
<data name="PublishPackageDocTooltipText" xml:space="preserve">
2306+
<value>Learn More about publishing a package</value>
2307+
</data>
23022308
<data name="PreferencesViewFeaturesTab" xml:space="preserve">
23032309
<value>Features</value>
23042310
</data>
@@ -2315,4 +2321,4 @@ Uninstall the following packages: {0}?</value>
23152321
<value>_Extensions</value>
23162322
<comment>Extensions menu</comment>
23172323
</data>
2318-
</root>
2324+
</root>

‎src/DynamoCoreWpf/ViewModels/PackageManager/Docs/PublishPackageDocumentation.html

Lines changed: 227 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,227 @@
1+
<!--
2+
There are two versions of this HTML file. One that is part of the Dynamo Dictionary
3+
codebase and one that is part of the Dynamo codebase, used for displaying additional
4+
error information in the Dynamo side panel.
5+
6+
These files need to kept in sync manually: if making edits to one version of the file,
7+
make sure to update the other version as well.
8+
9+
Dynamo: https://github.com/DynamoDS/Dynamo
10+
Dynamo Dictionary: https://github.com/DynamoDS/DynamoDictionary_React
11+
-->
12+
<!-- These headers are required to force the browser embedded in the DocumentationBrowser extension to render in modern IE11 mode. -->
13+
14+
<head>
15+
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
16+
<meta name="viewport" content="width=device-width initial-scale=1">
17+
<meta charset="UTF-8" />
18+
</head>
19+
20+
<style>
21+
body {
22+
color: white;
23+
font-size: 14px;
24+
font-family: "Artifakt Element";
25+
src: url("fonts/ArtifaktElement-Regular.woff") format("woff");
26+
padding: 1%;
27+
}
28+
29+
a {
30+
color: lightgray;
31+
cursor: pointer;
32+
background-color: transparent;
33+
}
34+
35+
table {
36+
border-collapse: collapse;
37+
border: 1px solid white;
38+
}
39+
40+
th,
41+
td {
42+
border: 1px solid white;
43+
padding-right: 10px;
44+
padding-left: 10px;
45+
padding-bottom: 10px;
46+
padding-top: 10px;
47+
}
48+
49+
samp {
50+
margin-top: 10px;
51+
display: block;
52+
color: lightgrey;
53+
}
54+
55+
code .k {
56+
color: #dcdcaa;
57+
font-weight: bold;
58+
}
59+
60+
code .s {
61+
color: #ce9178;
62+
}
63+
64+
code .v {
65+
color: #b5cea8;
66+
}
67+
68+
code .o {
69+
color: #c586c0;
70+
font-weight: bold;
71+
}
72+
73+
code .i {
74+
color: #569cd6;
75+
font-weight: bold;
76+
}
77+
78+
code .b {
79+
color: #9cdcfe;
80+
font-weight: bold;
81+
}
82+
83+
code .e {
84+
color: #43c9b0;
85+
}
86+
87+
code > .nl .nl {
88+
padding-left: 10px;
89+
}
90+
91+
code .nl {
92+
display: block;
93+
}
94+
95+
thead {
96+
text-align: center;
97+
}
98+
99+
.hidden-lg {
100+
display: none;
101+
}
102+
103+
.button {
104+
background-color: transparent;
105+
border-color: #3c3c3c;
106+
color: #bbbbbb;
107+
}
108+
109+
.button:hover {
110+
border-color: #656565;
111+
background-color: #373737;
112+
opacity: 1.0;
113+
}
114+
115+
@media screen and (max-width: 600px) {
116+
table {
117+
width: 100%;
118+
}
119+
120+
table,
121+
th,
122+
td {
123+
border: none;
124+
}
125+
126+
tr {
127+
border: 1px solid white;
128+
display: block;
129+
}
130+
131+
td,
132+
th {
133+
display: block;
134+
}
135+
136+
.hidden-lg {
137+
display: block;
138+
font-weight: bold;
139+
text-align: center;
140+
border-bottom: 1px solid white;
141+
}
142+
143+
.hidden-sm {
144+
display: none;
145+
}
146+
147+
.spaced-sm {
148+
margin-top: 20px;
149+
}
150+
151+
tbody tr:first-of-type {
152+
border-bottom: none;
153+
}
154+
}
155+
</style>
156+
157+
<!-- Use inline styles to keep Dynamo Dictionary styling in the dictionary -->
158+
<!-- and custom styling in Dynamo sidepanel. -->
159+
160+
<body style="background-color: #353535; font-family: 'Artifakt Element', 'Open Sans';">
161+
<h3>Publishing Dynamo Packages</h3>
162+
<p>
163+
Dynamo offers a vast number of features out of the box and also maintains an extensive package library, to which the community can contribute, that can significantly extend Dynamo's capability.
164+
This documentation describes how a user can publish a package from Dynamo.
165+
</p>
166+
<p>
167+
The menu option to publish a package can be found at: "Packages > Publish New Package...".
168+
Clicking this menu item will open a dialog box that will ask for all the information related to the package the user wants to publish.
169+
</p>
170+
<h4>Package Name:</h4>
171+
<p>
172+
Name of the package you want to publish. This will appear in the library and on the package manager website.
173+
</p>
174+
<p>
175+
<b>Description:</b><br />
176+
The description is a great place to add more details about your package, including listing any exceptions and pre-requisites.
177+
It can also be used to educate users on what the package does and how it can be utilised into their workspaces.
178+
</p>
179+
<p>
180+
<b>Version:</b><br />
181+
The version field is split into three sections, major, minor and build, which allows you as a package author to upload new versions of your
182+
package that follow versioning semantics - Users may want to publish more versions for their packages with new and improved features,
183+
polish some corners which were left out in the first version, or fix a bug.
184+
</p>
185+
<p>
186+
<b>Group:</b><br />
187+
This field can be used to specify a group that a package belongs to such as the company/organization.
188+
</p>
189+
<p>
190+
<b>External Dependency (optional):</b><br />
191+
Your package may depend on a host or its API as Dynamo can be integrated with a bunch of different optional
192+
hosts such as Revit or Civil 3D, so this field can be used to specify which other host(s) your package depends upon.
193+
</p>
194+
<p>
195+
<b>Keywords (optional):</b><br />
196+
Some keywords that can be used as tags related to your package. For e.g Generative Design, ML etc.
197+
</p>
198+
<p>
199+
<b>Website (optional):</b><br />
200+
Website that may provide the user with more info regarding the package or the organization/author.
201+
</p>
202+
<p>
203+
<b>Repository URL (optional):</b><br />
204+
A link to package's repository that can help users to view or contribute to the package development.
205+
</p>
206+
<p>
207+
<b>License (optional):</b><br />
208+
A license under which the package is released. Default license : MIT.
209+
</p>
210+
<p>
211+
<b>Package Contents (optional):</b><br />
212+
This section includes the right sidebar of the dialog box.
213+
</p>
214+
<p>
215+
<b>Add File:</b><br />
216+
Select and add all the files that are related to your package; generally the bin folder, binaries and dependencies are added.
217+
</p>
218+
<p>
219+
<b>Select Node Libraries:</b><br />
220+
Select the node libraries/DLLs from the list of added files.
221+
</p>
222+
<p>
223+
After filling in all the required details user can publish the package locally or online.
224+
When publishing locally the package will be published in the local root directory,
225+
whereas while publishing online the package will be uploaded to the package manager.
226+
</p>
227+
</body>

0 commit comments

Comments
 (0)