Skip to content

Commit bec56c1

Browse files
committed
Updating install documentation
1 parent ca56458 commit bec56c1

File tree

11 files changed

+772
-179
lines changed

11 files changed

+772
-179
lines changed

docs/CNAME

Lines changed: 0 additions & 1 deletion
This file was deleted.

docs/api/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ <h1 id="codefactory-sdk-documentation">CodeFactory SDK Documentation</h1>
8989
<hr>
9090
<p>You will also need to have the CodeFactory SDK installed.
9191
If you do not have the SDK installed see the following guidance.</p>
92-
<p><a href="../guidance/howto/Install/CodeFactorySDK.html">CodeFactory SDK Installation</a></p>
92+
<p><a href="../guidance/howto/Install/CodeFactorySDK.md">CodeFactory SDK Installation</a></p>
9393
<hr>
9494
</article>
9595
</div>

docs/guidance/howto/Install/CodeFactoryForVisualStudio.html

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -82,10 +82,9 @@ <h1 id="codefactory-install-and-setup">CodeFactory Install and Setup</h1>
8282

8383
<p>Use the following steps to install the CodeFactory Runtime Visual Studio Extension:</p>
8484
<h2 id="step-1-download-the-codefactory-for-visual-studio-runtime">Step 1: Download the CodeFactory for Visual Studio Runtime</h2>
85-
<p>Get the latest release of the CodeFactory Runtime installer from <a href="https://github.com/CodeFactoryLLC/CodeFactory/releases">here</a>.</p>
85+
<p>Get the latest release of the CodeFactory Runtime installer from <a href="https://github.com/CodeFactoryLLC/CodeFactory/releases/latest">here</a>.</p>
8686
<h2 id="step-2-execute-the-vsix-installer">Step 2: Execute the VSIX Installer</h2>
8787
<p>Simply run the VSIX installer that was downloaded in Step 1 on the same machine that your copy of Visual Studio is installed on.</p>
88-
<p>There is also a video tutorial that guides the install process <a href="https://www.youtube.com/watch?v=sJTFVW2kxKE&amp;t=1s&amp;ab_channel=CodeFactory">here</a></p>
8988
<h2 id="step-3-license-key-activation">Step 3: License Key Activation</h2>
9089
<p>Once the VSIX has installed CodeFactory Runtime, launch Visual Studio 2019, and follow these steps to add your license key (which was included in the email confirmation).</p>
9190
<ul>
@@ -109,9 +108,6 @@ <h2 id="step-3-license-key-activation">Step 3: License Key Activation</h2>
109108
</ul>
110109
<p>Click “Close” and your CodeFactory license is now activated.</p>
111110
<hr>
112-
<h2 id="install-codefactory-sdk">Install Codefactory SDK</h2>
113-
<p>Once you have completed the setup of CodeFactory RunTime, the next step is to install the CodeFactory SDK.
114-
<a href="CodeFactorySDK.html">CodeFactory SDK Install Instructions</a></p>
115111
<h2 id="guidance">Guidance</h2>
116112
<p>Once you have completed the setup of CodeFactory you can return to guidance here.</p>
117113
<p><a href="../Overview.html">CodeFactory Guidance</a></p>

docs/guidance/howto/Install/CodeFactorySDK.html

Lines changed: 0 additions & 129 deletions
This file was deleted.

docs/guidance/toc.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@
5454
<a href="howto/Install/CodeFactoryForVisualStudio.html" name="" title="CodeFactory for Visual Studio">CodeFactory for Visual Studio</a>
5555
</li>
5656
<li>
57-
<a href="howto/Install/CodeFactorySDK.html" name="" title="CodeFactory SDK">CodeFactory SDK</a>
57+
<a href="howto/Install/CodeFactorySDK.md" name="" title="CodeFactory SDK">CodeFactory SDK</a>
5858
</li>
5959
</ul>
6060
</li>

docs/index.json

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1087,12 +1087,7 @@
10871087
"guidance/howto/Install/CodeFactoryForVisualStudio.html": {
10881088
"href": "guidance/howto/Install/CodeFactoryForVisualStudio.html",
10891089
"title": "CodeFactory Install and Setup | CodeFactory Guidance",
1090-
"keywords": "CodeFactory Install and Setup Use the following steps to install the CodeFactory Runtime Visual Studio Extension: Step 1: Download the CodeFactory for Visual Studio Runtime Get the latest release of the CodeFactory Runtime installer from here . Step 2: Execute the VSIX Installer Simply run the VSIX installer that was downloaded in Step 1 on the same machine that your copy of Visual Studio is installed on. There is also a video tutorial that guides the install process here Step 3: License Key Activation Once the VSIX has installed CodeFactory Runtime, launch Visual Studio 2019, and follow these steps to add your license key (which was included in the email confirmation). From Visual Studio 2019, click the Extensions menu, select CodeFactory > License Information From the [cF] License Information screen, click “Activate License” Copy the license key that was included in your email receipt/confirmation and “Paste From Clipboard” as shown below. Once the license key is pasted/visible in the Enter License text box click “Activate License”. From the [cF] License Information screen you should now see your license information displayed. Click “Close” and your CodeFactory license is now activated. Install Codefactory SDK Once you have completed the setup of CodeFactory RunTime, the next step is to install the CodeFactory SDK. CodeFactory SDK Install Instructions Guidance Once you have completed the setup of CodeFactory you can return to guidance here. CodeFactory Guidance"
1091-
},
1092-
"guidance/howto/Install/CodeFactorySDK.html": {
1093-
"href": "guidance/howto/Install/CodeFactorySDK.html",
1094-
"title": "Install CodeFactory SDK | CodeFactory Guidance",
1095-
"keywords": "Install CodeFactory SDK The CodeFactory SDK is now installed by default during the Runtime installation. Please see the linked instructions for any questions around how to install the CodeFactory Runtime. Install CodeFactory for Visual Studio Guidance Once you have completed the setup of CodeFactory SDK you can return to guidance here. CodeFactory Guidance"
1090+
"keywords": "CodeFactory Install and Setup Use the following steps to install the CodeFactory Runtime Visual Studio Extension: Step 1: Download the CodeFactory for Visual Studio Runtime Get the latest release of the CodeFactory Runtime installer from here . Step 2: Execute the VSIX Installer Simply run the VSIX installer that was downloaded in Step 1 on the same machine that your copy of Visual Studio is installed on. Step 3: License Key Activation Once the VSIX has installed CodeFactory Runtime, launch Visual Studio 2019, and follow these steps to add your license key (which was included in the email confirmation). From Visual Studio 2019, click the Extensions menu, select CodeFactory > License Information From the [cF] License Information screen, click “Activate License” Copy the license key that was included in your email receipt/confirmation and “Paste From Clipboard” as shown below. Once the license key is pasted/visible in the Enter License text box click “Activate License”. From the [cF] License Information screen you should now see your license information displayed. Click “Close” and your CodeFactory license is now activated. Guidance Once you have completed the setup of CodeFactory you can return to guidance here. CodeFactory Guidance"
10961091
},
10971092
"guidance/howto/Overview.html": {
10981093
"href": "guidance/howto/Overview.html",

docs/manifest.json

Lines changed: 11 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"homepages": [],
3-
"source_base_path": "C:/github/CodeFactoryLLC/CodeFactory/src/CodeFactoryVisualStudio/Documentation",
3+
"source_base_path": "c:/github/codefactoryllc/CodeFactory/src/CodeFactoryVisualStudio/Documentation",
44
"xrefmap": "xrefmap.yml",
55
"files": [
66
{
@@ -13,12 +13,15 @@
1313
"is_incremental": false
1414
},
1515
{
16+
"log_codes": [
17+
"InvalidFileLink"
18+
],
1619
"type": "Conceptual",
1720
"source_relative_path": "api/index.md",
1821
"output": {
1922
".html": {
2023
"relative_path": "api/index.html",
21-
"hash": "k6uhtlZ4mB60af227EYFuw=="
24+
"hash": "b4+flD+vznkKpb+3r9etEA=="
2225
}
2326
},
2427
"is_incremental": false,
@@ -623,19 +626,7 @@
623626
"output": {
624627
".html": {
625628
"relative_path": "guidance/howto/Install/CodeFactoryForVisualStudio.html",
626-
"hash": "XggCH/iQq9c/OsPNdQ3I2A=="
627-
}
628-
},
629-
"is_incremental": false,
630-
"version": ""
631-
},
632-
{
633-
"type": "Conceptual",
634-
"source_relative_path": "guidance/howto/Install/CodeFactorySDK.md",
635-
"output": {
636-
".html": {
637-
"relative_path": "guidance/howto/Install/CodeFactorySDK.html",
638-
"hash": "ZG3lWHUCOs3ZbJYHncuiGQ=="
629+
"hash": "SBvhplwRTZCCdMo4IzgoRA=="
639630
}
640631
},
641632
"is_incremental": false,
@@ -710,12 +701,15 @@
710701
"version": ""
711702
},
712703
{
704+
"log_codes": [
705+
"InvalidFileLink"
706+
],
713707
"type": "Toc",
714708
"source_relative_path": "guidance/toc.md",
715709
"output": {
716710
".html": {
717711
"relative_path": "guidance/toc.html",
718-
"hash": "HqvsTRLhIbOl8pKxNPcndw=="
712+
"hash": "J6tucRjfjpocRk/Iphnjhg=="
719713
}
720714
},
721715
"is_incremental": false,
@@ -3339,7 +3333,7 @@
33393333
"ConceptualDocumentProcessor": {
33403334
"can_incremental": false,
33413335
"incrementalPhase": "build",
3342-
"total_file_count": 16,
3336+
"total_file_count": 15,
33433337
"skipped_file_count": 0
33443338
},
33453339
"ManagedReferenceDocumentProcessor": {

src/CodeFactoryVisualStudio/Documentation/Documentation.csproj

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,6 @@
5757
<None Include="guidance\howto\CreateProject\CreateProject.md" />
5858
<None Include="guidance\howto\CreateProject\Overview.md" />
5959
<None Include="guidance\howto\Install\CodeFactoryForVisualStudio.md" />
60-
<None Include="guidance\howto\Install\CodeFactorySDK.md" />
6160
<None Include="guidance\howto\Overview.md" />
6261
<None Include="guidance\intro.md" />
6362
<None Include="guidance\Introduction\Commands\Overview.md" />

src/CodeFactoryVisualStudio/Documentation/guidance/howto/Install/CodeFactoryForVisualStudio.md

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,11 @@
22
Use the following steps to install the CodeFactory Runtime Visual Studio Extension:
33

44
## Step 1: Download the CodeFactory for Visual Studio Runtime
5-
Get the latest release of the CodeFactory Runtime installer from [here](https://github.com/CodeFactoryLLC/CodeFactory/releases).
5+
Get the latest release of the CodeFactory Runtime installer from [here](https://github.com/CodeFactoryLLC/CodeFactory/releases/latest).
66

77
## Step 2: Execute the VSIX Installer
88
Simply run the VSIX installer that was downloaded in Step 1 on the same machine that your copy of Visual Studio is installed on.
99

10-
There is also a video tutorial that guides the install process [here](https://www.youtube.com/watch?v=sJTFVW2kxKE&t=1s&ab_channel=CodeFactory)
11-
1210
## Step 3: License Key Activation
1311
Once the VSIX has installed CodeFactory Runtime, launch Visual Studio 2019, and follow these steps to add your license key (which was included in the email confirmation).
1412

@@ -30,10 +28,6 @@ ___
3028
Click “Close” and your CodeFactory license is now activated.
3129
___
3230

33-
## Install Codefactory SDK
34-
Once you have completed the setup of CodeFactory RunTime, the next step is to install the CodeFactory SDK.
35-
[CodeFactory SDK Install Instructions](CodeFactorySDK.md)
36-
3731
## Guidance
3832
Once you have completed the setup of CodeFactory you can return to guidance here.
3933

src/CodeFactoryVisualStudio/Documentation/guidance/howto/Install/CodeFactorySDK.md

Lines changed: 0 additions & 11 deletions
This file was deleted.

0 commit comments

Comments
 (0)