Browse Source

(doc) update docs

Rob Reynolds 7 years ago
parent
commit
037d7bc1c5
7 changed files with 44 additions and 1 deletions
  1. 2 0
      README.md
  2. 12 1
      automatic/README.md
  3. 3 0
      icons/README.md
  4. 5 0
      ketarin/README.md
  5. 3 0
      manual/README.md
  6. 9 0
      ops/README.md
  7. 10 0
      setup/README.md

+ 2 - 0
README.md

@@ -15,6 +15,8 @@ For setting up your own automatic package repository, please see [Automatic Pack
 
 ### Special Notes
 
+#### Ketarin
+
 * In `Settings -> Global variables` the variable `autoPackagesFolder` is used to determine where your automatic packages are. It doesn't matter what `chocopkgup` is using, this folder is passed through. Ensure this is set appropriately.
 * In `Settings -> Global variables` the variable `saveDir` is used to determine where to save the downloaded files from Ketarin. Please ensure the folder exists.
 * In `Settings -> Global variables` the variable `nopush` is set to `--nopush`, which allows checksum calculations to occur and then a custom script will push the files.

+ 12 - 1
automatic/README.md

@@ -2,4 +2,15 @@
 
 This is where you put your Chocolatey packages that are automatically packaged up by either [AU](https://chocolatey.org/packages/au) or [Ketarin](https://chocolatey.org/packages/ketarin)/[ChocolateyPackageUpdater](https://chocolatey.org/packages/chocolateypackageupdater).
 
-You may want to drop the actual ketarin files in the top-level Ketarin folder to keep them separate from the packages themselves.
+### Ketarin / ChocolateyPackageUpdater (chocopkgup)
+
+You want to drop the actual Ketarin files (job file exports) in the top-level ketarin folder to keep them separate from the packages themselves.
+
+The following packages implement this strategy of auto updates:
+
+* 1password
+* git.install
+
+### Automatic Updater (AU)
+
+TBD

+ 3 - 0
icons/README.md

@@ -0,0 +1,3 @@
+## Icons
+
+Images / Icons go here. This is done so that the image isn't being copied around inside the auto packages

+ 5 - 0
ketarin/README.md

@@ -0,0 +1,5 @@
+## Ketarin Jobs
+
+This is where the ketarin xml job exports go. This allows it to be easier to contribute when Ketarin jobs are available for exporting.
+
+This is also the folder that ops/ketarinupdate.cmd is using to import all of the jobs into Ketarin silently, so that things stay updated on a server running this.

+ 3 - 0
manual/README.md

@@ -0,0 +1,3 @@
+## Manual Folder
+
+This is where you put packages that are manually kept up to date or don't require updates. Icons still go in the icon folder.

+ 9 - 0
ops/README.md

@@ -0,0 +1,9 @@
+## Operations
+
+### Ketarin/ChocolateyPackageUpdater Ops
+
+* Use ketarinupdate.cmd or another file to set up a scheduled task for daily, hourly, or whatever schedule you best feel will work appropriately.
+
+### AutomaticUpdater
+
+Nothing to do here, jobs run automatically by AppVeyor on commit.

+ 10 - 0
setup/README.md

@@ -0,0 +1,10 @@
+## Setup
+
+### Ketarin/ChocolateyPackageUpdater Automatic Packaging
+
+* Run setup.ps1 (review the file first to ensure the folder being created)
+* Open ketarin after installing it, open the settings and import KetarinSettings.xml.
+
+### Automatic Updater (AU)
+
+* Set up an appveyor job.