Inedo / inedox-windows

Windows extension for Otter and BuildMaster.
BSD 3-Clause "New" or "Revised" License
7 stars 4 forks source link

Documentation? #89

Closed mcascone closed 2 years ago

mcascone commented 2 years ago

Is there any documentation for this extension, or any other ProGet extensions?

inedodean commented 2 years ago

The Windows extension isn't used by ProGet, just BuildMaster and Otter.

We have extension development documentation here; https://docs.inedo.com/docs/inedosdk-overview

inedodean commented 2 years ago

What extension are you looking for info on? For example, the Sonatype extension is used here:

https://docs.inedo.com/docs/proget-compliance-ossindex

mcascone commented 2 years ago

I suppose that's part of the problem, there's no indication what the plugins do, what product they're intended for, or how to use them. Where can i look for this kind of info?

thanks

On Thu, Oct 14, 2021 at 3:28 AM Dean Houston @.***> wrote:

What extension are you looking for info on? For example, the Sonatype extension is used here:

https://docs.inedo.com/docs/proget-compliance-ossindex

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://github.com/Inedo/inedox-windows/issues/89#issuecomment-943132902, or unsubscribe https://github.com/notifications/unsubscribe-auth/AB7S5Z4V65EVN74KMTFMNRTUG2IDBANCNFSM5F55GKOA .

-- Thanks, Max

inedodean commented 2 years ago

We can definitely improve on this here, but for now the best ways to discover extension functionality...

  1. Check Admin > Extensions in the product, and you'll see the available extensions; with ProGet, they're almost all shipped with the Product, and they extensions are tightly integrated to ProGet's features; there's almost always a documentation page on them.
  2. Follow Documentation for a Feature, and it will guide to install an extension sometimes
  3. Follow Application Templates in BuildMaster; these will guide you on which extension to install

For BuildMaster and Otter, the Windows extension (along with Scripting and InedoCore) are considered "core" extensions, and the product will warn if you don't have it installed (like if you go out of your way to delete it). ProGet has InedoCore as a built-in.