hacktoberfest – dbatools edition

During the month of October 2018 DigitalOcean is again running Hacktoberfest to support open source projects. They are offering a limited edition T-Shirt for any person making five pull requests to any public repo on GitHub.

To get a shirt, you must make five pull requests (PRs) between October 1–31 in any timezone. PRs can be to any public repo on GitHub, not just the ones highlighted. The PR must contain commits you made yourself. This year, the first 50,000 of you can earn a T-shirt (compared with 30,000 in 2017).

Full details can be found here.

dbatools

As part of dbatools participation in this event we are encouraging contributors to assist “the road towards 1.0” by improving the examples available in the comment-based help, which power the new docs site at docs.dbatools.io.

The activity is available to anyone who wants to help and does not require any expertise in PowerShell. Any of the following actions are desirable:

  •  Fix typos in examples
  •  Fix obvious errors in examples
  •  Add examples to illustrate use of all possible parameters
  •  Add examples to illustrate use of pipeline support
  •  Add examples to illustrate combining multiple dbatools commands.
  •  Add examples that illustrate use of dbatools commands in new or interesting ways.

We are a looking for a max of 6-8 examples per command.

Not sure how to commit?

If you’d like to participate but aren’t familiar with GitHub, cloning and repos, we’ve got good news! You can update our help files using the web interface at GitHub.com. Here’s how:

First, create an account. GitHub is free and you do not need to pay to participate. Then head over to the dbatools repository using the shortlink dbatools.io/git.

After creating your GitHub account don’t forget to register at hacktoberfest if you want your contributions to be recorded and to qualify for a T-Shirt.

Find the command you want to edit

In this case, we’ll add an example to Get-DbaClientAlias. We can do this by clicking on the functions directory.


Next, click on the Get-DbaClientAlias function.


Then the edit button.

Add an example

If you haven’t forked our repo before, you’ll get a notice that GitHub has done all the work for you.


Proceed to adding the example by scrolling down to find the list of examples.


Copy/paste/modify.

If you are unsure of how to write or format examples you can look at some existing examples. eg

Then proceed to saving your changes by filling out the form at the bottom. Click the green “Propose file changes”. Congrats! You’ve made your first commit.

Create the pull request

You will now be prompted to create a Pull Request. Click the button that says “Create pull request”.


Things are filled out for you already.


Modify as necessary and click “Create Pull Request”.

Celebrate

After a review is complete and the changes are approved, your request will be merged 👍

And now they will show up on docs.dbatools.io

If you’d like more examples, check out Mötz Jensen’s last two pull requests where he added some useful examples.

Remember you will need five pull requests before end of October for a T-Shirt!

One thought on “hacktoberfest – dbatools edition

  1. Pingback: Help Make dbatools Even Better – Curated SQL

Leave a Reply

Your email address will not be published. Required fields are marked *

This site uses Akismet to reduce spam. Learn how your comment data is processed.