Skip to content

Commit

Permalink
(doc) Added structure to docs
Browse files Browse the repository at this point in the history
- Based on the work that was done by Stephen
  • Loading branch information
gep13 committed Feb 13, 2019
1 parent b2361e9 commit a32e589
Show file tree
Hide file tree
Showing 12 changed files with 269 additions and 64 deletions.
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,5 @@ yarn.lock
.DS_Store

# License file copied to chocolatey directory
chocolatey/tools/LICENSE.txt
chocolatey/tools/LICENSE.txt
config.wyam.hash
Binary file added config.wyam.dll
Binary file not shown.
181 changes: 181 additions & 0 deletions config.wyam.packages.xml

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/input/_Bottom.cshtml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
</div>
<script>
((window.gitter = {}).chat = {}).options = {
room: 'gep13/chocolatey-vscode'
room: 'gep13-oss/community'
};
</script>
<script src="https://sidecar.gitter.im/dist/sidecar.v1.js" async defer></script>
13 changes: 13 additions & 0 deletions docs/input/docs/commands/create.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
Order: 10
Title: Create new Chocolatey package
Description: Usage instructions for the create new package command
---

Open a folder in VSCode. Failure to do so will cause the extension to throw an error.

Press `Ctrl+Shift+P` to bring up the Command Pallete. Type `Chocolatey: Create new Chocolatey Package`. The extension will ask you to give the Package a name. This should match closely with the name of the application you are pacakging. Version in the name is not necessary, and should be avoided as this is handled in the nuspec file with the `<version></version>` tag.

The extension then creates a new folder with the name you typed into the extension's prompt and generates template installation, modification, and uninstallation scripts, as well as the nuspec file and some other miscellaneous files.

The generated files are well-documented inside, and have all the information required inside of them to build a successful package.
9 changes: 9 additions & 0 deletions docs/input/docs/commands/delete.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
Order: 30
Title: Delete Chocolatey package(s)
Description: Usage instructions for the delete Chocolatey package(s) command
---

Sometimes, you no longer need a package, or an older version of a package. `choco delete` makes it easy to remove those unnecessary packages. The extension has this capability built in

Press `Ctrl+Shift+P` to bring up the Command Pallete and type `Chocolatey: Delete Package`. Select the Chocolatey package nupkg to remove and it will be deleted from disk.
7 changes: 7 additions & 0 deletions docs/input/docs/commands/index.cshtml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
Order: 30
Description: How to use the Chocolatey VSCode Extension
---
<p>@Html.Raw(Model.String(DocsKeys.Description))</p>

@Html.Partial("_ChildPages")
11 changes: 11 additions & 0 deletions docs/input/docs/commands/install.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
Order: 50
Title: Install Template package(s)
Description: Usage instructions for the install Template package(s) command
---

Press `Ctrl+Shift+P` to bring up the Command Pallete. Type `Chocolatey: Install Template packages(s)`*

* _VSCode must be ran as Administrator for access to C:\ProgramData\chocolatey\lib_

This will pull down all the templates for creating different Chocolatey package types.
11 changes: 11 additions & 0 deletions docs/input/docs/commands/pack.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
Order: 20
Title: Pack Chocolatey package(s)
Description: Usage instructions for the package Chocolatey package(s) command
---

Once you have your package built to your liking and the nuspec file properly filled in (again review the comments in the nuspec file for more information) it is time to Pack the package, which bundles everything into the needed nupkg.

Press `Ctrl+Shift+P` to bring up the Command Pallete. Type `Chocolatey: Pack Chocolatey Package(s)`. The extension will ask you for any additional arguments you require for the pack operation. Documentation on those additional arguments and their usage can be found [here]('https://github.com/chocolatey/choco/wiki/CommandsPack').

The package operation will bundle everything, and you should see a new file created in the folder named _packagename.nupkg_.
17 changes: 17 additions & 0 deletions docs/input/docs/commands/push.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
Order: 40
Title: Push Chocolatey package(s)
Description: Usage instructions for the push Chocolatey package(s) command
---

Pushing a package to the Community Repository requires the use of an API Key. You can head over to the [Community Repository]('https://chocolatey.org/packages') and create an account. Once you have your account, you will see the API listed in your Profile.

*Add your API key to your local chocolatey installation*

Run the following command to add your api key for the community repository to your Chocolatey installation:

`choco apikey -k <your key here> -s https://push.chocolatey.org/`

Note that we have covered the Community Repository here. For other sources, information for pushing to them can be found [here]('https://github.com/chocolatey/choco/wiki/CommandsPush').

When you are ready to push a package press `Ctrl+Shift+P` to bring up the Command Pallete and type `Chocolatey: Push Package(s)`. This will add your new package to the repository.
17 changes: 17 additions & 0 deletions docs/input/index.cshtml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
Title: Chocolatey Visual Studio Code Extension
NoSidebar: true
NoContainer: true
NoGutter: true
---

<div class="jumbotron">
<div class="container">
<h1 class="display-4">Chocolatey Visual Studio Code Extension</h1>
<p>
This extension brings support for Chocolatey to Visual Studio Code.<br/>
</p>
<a class="btn btn-primary btn-lg" href="docs" role="button">Learn more</a>
<a class="btn btn-primary btn-lg" href="docs/commands" role="button">Commands</a>
</div>
</div>
62 changes: 0 additions & 62 deletions docs/input/index.md

This file was deleted.

0 comments on commit a32e589

Please sign in to comment.