Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Changed link to forum to https as the http link was failing #1

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Changed link to forum to https as the http link was failing #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# Welcome to the OctoPosh wiki!
# Welcome to the OctoPosh Wiki!

OctoPosh is a Powershell module that provides cmdlet to do basic tasks on Octopus Deploy. All the cmdlets use a combination of calls to the [Octopus REST API](https://github.com/OctopusDeploy/OctopusDeploy-Api/wiki) and some occasional uses of the [Octopus.Client](http://www.nuget.org/packages/Octopus.Client/)(which in the end, also uses the REST API)
OctoPosh is a Powershell module that provides a cmdlet to do basic tasks on Octopus Deploy. All the cmdlets use a combination of calls to the [Octopus REST API](https://github.com/OctopusDeploy/OctopusDeploy-Api/wiki) and some occasional uses of the [Octopus.Client](http://www.nuget.org/packages/Octopus.Client/)(which in the end, also uses the REST API)

The goal of this module is for it to be the go-to place to programatically get information about your Octopus instance, as well as to automate tasks to help you get your Deployment environment up and running fast and easy. If you go to [Octopus' super amazing support site](http://help.octopusdeploy.com/), you'll notice that there are plenty of questions of the kind `How do I do [this] using the REST API?`. One of the objectives of this module is to create tools to help the user be able to do things in Octopus from Powershell in a rather intuitive way.
The goal of this module is for it to be the go-to place to programmatically get information about your Octopus instance, as well as to automate tasks to help you get your Deployment environment up and running fast and easy. If you go to [Octopus' super amazing support site](https://help.octopusdeploy.com/), you'll notice that there are plenty of questions of the kind `How do I do [this] using the REST API?`. One of the objectives of this module is to create tools to help the user be able to do things in Octopus from Powershell in a rather intuitive way.

## Getting Started

Use the sidebar on the right to learn more about the cmdlets that are inside of the module.
You can use the sidebar on the right to learn more about the cmdlets that are inside the module.

You might wanna start by reading:
- [How to Install the module](https://github.com/Dalmirog/OctoPosh/wiki/Installing-the-module)
Expand All @@ -16,4 +16,4 @@ You might wanna start by reading:

Once you install the module and setup your credentials, you can either use the articles on this wiki to learn the syntax of each cmdlet, or you can run `Get-Help [cmdlet name] -full` from Powershell.

This wiki is programatically populated using the cmdlets built-in help. So all the examples and descriptions will always be identical between the wiki and the cmdlets.
This wiki is programmatically populated using the cmdlet's built-in help. So all the examples and descriptions will always be identical between the wiki and the cmdlets.