Skip to content

Commit

Permalink
github.com/sqlcollaborative -> github.com/dataplat (dataplat#8074)
Browse files Browse the repository at this point in the history
  • Loading branch information
potatoqualitee authored Jan 13, 2022
1 parent 7760566 commit 716b716
Show file tree
Hide file tree
Showing 143 changed files with 449 additions and 449 deletions.
2 changes: 1 addition & 1 deletion .devcontainer/dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -28,5 +28,5 @@ RUN $ErrorActionPreference='Stop'; Install-Module -Name PSScriptAnalyzer -Force

# Git command prompt
# Change this if you want to utilize your fork
RUN git clone https://github.com/sqlcollaborative/dbatools.git ~/.bash-git-prompt --depth=1 \
RUN git clone https://github.com/dataplat/dbatools.git ~/.bash-git-prompt --depth=1 \
&& echo "if [ -f \"$HOME/.bash-git-prompt/gitprompt.sh\" ]; then GIT_PROMPT_ONLY_IN_REPO=1 && source $HOME/.bash-git-prompt/gitprompt.sh; fi" >> "/root/.bashrc"
8 changes: 4 additions & 4 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
blank_issues_enabled: false
contact_links:
- name: Issues found with dbatools.io?
url: https://github.com/sqlcollaborative/web/issues/new
url: https://github.com/dataplat/web/issues/new
about: Website is hosted via GitHub Pages under sqlcollaborative/web
- name: Issues found with docs.dbatools.io?
url: https://github.com/sqlcollaborative/docs/issues/new
url: https://github.com/dataplat/docs/issues/new
about: Website is hosted under sqlcollaborative/docs
- name: Ask a question about dbatools or get support
url: https://github.com/sqlcollaborative/dbatools/discussions/new
url: https://github.com/dataplat/dbatools/discussions/new
about: Get support via forums
- name: Get an invite to our Slack channel
url: https://dbatools.io/slack/
about: Get support via chat
- name: Say thank you
url: https://github.com/sqlcollaborative/dbatools/discussions/new
url: https://github.com/dataplat/dbatools/discussions/new
about: Show and Tell us how you use dbatools & support our efforts in maintaining dbatools
2 changes: 1 addition & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
- [ ] Ran manual Pester test and has passed (`.\tests\manual.pester.ps1`)
- [ ] Adding code coverage to existing functionality
- [ ] Pester test is included
- [ ] If new file reference added for test, has is been added to github.com/sqlcollaborative/appveyor-lab ?
- [ ] If new file reference added for test, has is been added to github.com/dataplat/appveyor-lab ?
- [ ] Unit test is included
- [ ] Documentation
- [ ] Build system
Expand Down
2 changes: 1 addition & 1 deletion bin/build/vsts-build.ps1
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ if ($previousVersion -ne $currentVersion) {

git add .
git commit -m "VSTS Library Compile ***NO_CI***"
$errorMessage = git push "https://$env:SYSTEM_ACCESSTOKEN@github.com/sqlcollaborative/dbatools.git" head:$branch 2>&1
$errorMessage = git push "https://$env:SYSTEM_ACCESSTOKEN@github.com/dataplat/dbatools.git" head:$branch 2>&1
if ($LASTEXITCODE -gt 0) { throw $errorMessage }
} else {
Write-Host "Version: $currentVersion | Library is up to date"
Expand Down
2 changes: 1 addition & 1 deletion bin/dbatools-index.json.REMOVED.git-id
Original file line number Diff line number Diff line change
@@ -1 +1 @@
17bb314d42613d195f5b0c871b8810a27b63468e
26d969f8e0287f42a1b0e069ec53a6c47c8b4997
2 changes: 1 addition & 1 deletion bin/library.ps1
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ yet. We have taken great pains to avoid this issue but this notification indicat
we have failed.
Please, in order to help us prevent this from happening again, visit us at:
https://github.com/sqlcollaborative/dbatools/issues
https://github.com/dataplat/dbatools/issues
and tell us about this failure. All information will be appreciated, but
especially valuable are:
- Exports of the exception: $Error | Export-Clixml error.xml -Depth 4
Expand Down
486 changes: 243 additions & 243 deletions changelog.md

Large diffs are not rendered by default.

8 changes: 4 additions & 4 deletions contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Documentation is an area that is a good starting point whether you are new to op

## Contributing New Commands

Start out reviewing the [list of functions and documentation](https://docs.dbatools.io), or pulling the list from the module with `Get-Command -Module dbatools -CommandType Function | Out-GridView`. If you find something similar already exists, open [a new issue on GitHub](https://GitHub.com/sqlcollaborative/dbatools/issues/new) to request an enhancement to that command. New ideas already accepted can be found on [Feature](https://github.com/sqlcollaborative/dbatools/labels/Feature) tagged issues. If nothing similar pops up, you can start a new issue for discussion or ping us in Slack with the details or requirements you need. (_GitHub issue is preferred to just have the history around._)
Start out reviewing the [list of functions and documentation](https://docs.dbatools.io), or pulling the list from the module with `Get-Command -Module dbatools -CommandType Function | Out-GridView`. If you find something similar already exists, open [a new issue on GitHub](https://github.com/dataplat/dbatools/issues/new) to request an enhancement to that command. New ideas already accepted can be found on [Feature](https://github.com/dataplat/dbatools/labels/Feature) tagged issues. If nothing similar pops up, you can start a new issue for discussion or ping us in Slack with the details or requirements you need. (_GitHub issue is preferred to just have the history around._)

## Reporting Bugs

Expand All @@ -27,7 +27,7 @@ Start out reviewing the [list of functions and documentation](https://docs.dbato
## Fix Bugs

We have a [step-by-step guide](https://dbatools.io/firstpull) if you don't know Github enough.
[Open a PR](https://GitHub.com/sqlcollaborative/dbatools/pulls) targeting ideally just one ps1 file (the PR needs to target the *development* branch), with the name of the function being fixed as a title. Everyone will chime in reviewing the code and either approve the PR or request changes. The more targeted and focused the PR, the easier to merge, the fastest to go into the next release. Keep them as simple as possible to speed up the process.
[Open a PR](https://github.com/dataplat/dbatools/pulls) targeting ideally just one ps1 file (the PR needs to target the *development* branch), with the name of the function being fixed as a title. Everyone will chime in reviewing the code and either approve the PR or request changes. The more targeted and focused the PR, the easier to merge, the fastest to go into the next release. Keep them as simple as possible to speed up the process.

## Parameters and Variables

Expand All @@ -42,7 +42,7 @@ We chose to follow the standards below when creating parameters and variables fo

When you are working with "objects" in SQL Server, say with databases, what variable name you use should be based on what operation you are doing. You can find examples of various situations in the current code of the module to see more detailed examples. As an example: in situations where you are looping over the databases for an instance, try to use a plural variable name for the collection and then single or abbreviated name in the loop for each object of that collection. e.g. `foreach ($db in $databases) {...`.

[This page](https://github.com/sqlcollaborative/dbatools/wiki/Standard-Documentation) sums up what we currently use. We aim at standardizing and reducing to a set of self-documenting and reusable parameters. If you have any questions around the above do not hesitate to ask in Slack.
[This page](https://github.com/dataplat/dbatools/wiki/Standard-Documentation) sums up what we currently use. We aim at standardizing and reducing to a set of self-documenting and reusable parameters. If you have any questions around the above do not hesitate to ask in Slack.

## Formatting and indentation

Expand All @@ -61,7 +61,7 @@ To save resources and be more flexible, we split tests with tags into two main c
- Every resource should be named with the `dbatoolsci_` prefix. _The test should attempt to clean up after itself leaving a pristine environment._
- Try to write tests thinking they may run in each and every user's test environment.

The [dbatools-templates repository](https://github.com/sqlcollaborative/dbatools-templates) holds examples, but you can also inspect/copy/cannibalize existing tests. You'll see that every test file is named with a simple convention `Verb-Noun*.Tests.ps1`, and this is required by [Pester](https://GitHub.com/pester/Pester), which is the de-facto standard for running tests in PowerShell.
The [dbatools-templates repository](https://github.com/dataplat/dbatools-templates) holds examples, but you can also inspect/copy/cannibalize existing tests. You'll see that every test file is named with a simple convention `Verb-Noun*.Tests.ps1`, and this is required by [Pester](https://GitHub.com/pester/Pester), which is the de-facto standard for running tests in PowerShell.

Tests make sure a "contract" is made between the code and its behavior: once a test is formalized, changes to the code itself or enhancement will be written making sure existing functionality is retained, making the entire dbatools experience more stable.

Expand Down
2 changes: 1 addition & 1 deletion dbatools.psm1
Original file line number Diff line number Diff line change
Expand Up @@ -1062,7 +1062,7 @@ while ($script:smoRunspace.Runspace.RunspaceAvailability -eq 'Busy') {
The module import has hit a timeout while waiting for some background tasks to finish.
This may result in some commands not working as intended.
This should not happen under reasonable circumstances, please file an issue at:
https://github.com/sqlcollaborative/dbatools/issues
https://github.com/dataplat/dbatools/issues
Or contact us directly in the #dbatools channel of the SQL Server Community Slack Channel:
https://dbatools.io/slack/
Timeout waiting for temporary runspaces reached! The Module import will complete, but some things may not work as intended
Expand Down
108 changes: 54 additions & 54 deletions en-us/about_dbatools_support.help.txt
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
TOPIC
about_dbatools_support

SHORT DESCRIPTION
Describes how to contact support and what information we need

LONG DESCRIPTION
Welcome to the dbatools support guide.
If you are reading this, odds are, something went wrong and you are looking
for support. Sorry for the inconvenience - we try our best to have dbatools
as free of bugs as we can manage. Doesn't always work out.

This article describes how you can reach us and what information we need
when you do.


#-------------------------------------------------------------------------#
# Table of Contents #
#-------------------------------------------------------------------------#
Expand All @@ -23,37 +23,37 @@ LONG DESCRIPTION
- A matter of timing
- What happens now?
- The world need not burn


#-------------------------------------------------------------------------#
# Getting Help #
#-------------------------------------------------------------------------#

When something breaks unexpectedly, you'll probably want help. Well, most of
us in the team work on dbatools, because we a) have fun coding and b) like
the community (there is no pay involved whatsoever). So, come see us in our
Slack channel or file an issue on github. We will gladly attempt to help you
with any technical issues using our module (we love our module, we'll remove
any malfunctioning blemishes that we can!).

In order to find us, you can visit us on Slack by following this link:
https://dbatools.io/slack/
This has the advantage of the easiest interaction and often the fastest
resolution times for smaller issues.

Alternatively, you can file an issue on github:
https://github.com/sqlcollaborative/dbatools/issues
https://github.com/dataplat/dbatools/issues
(Don't worry: It's relatively straightforward and easy to do)

When you describe an error, please be prepared to provide some information,
such as what code you were trying to execute and what the error was. For
more details on this, see the next chapter: "Troubleshooting Support"


#-------------------------------------------------------------------------#
# Troubleshooting Support #
#-------------------------------------------------------------------------#

When trying to figure out, what went wrong, we usually need information,
quite a bit of it, in fact. Usual information we care about:
- Code/line you were running
Expand All @@ -66,106 +66,106 @@ LONG DESCRIPTION
before looking at it in more detail. That said, I highly recommend providing
the first three points immediately, as they are fast to gather and already
help a lot. We may ask for more as it comes up.

# Code/line you were running #
#----------------------------#

Literally the code you executed. Make it as simple as possible and still
produce the error. Make sure to replace sensitive data before posting it.
If you can reduce it to a single line, that's great! (But don't sweat it if
it's still more)

# Output / Error / Warning received #
#-----------------------------------#

Generally, we catch errors and write warnings by default. Report what it
wrote if that is the case. Same for red exception textes. Sometimes however,
a command may just refuse to do anything at all. In that case it might just
return nothing. If it doesn't write a warning or throw an exception, tell us
what you expected it to do and what it did instead.
Screenshots work very well for this.

# Exception Contents #
#--------------------#

If the code threw an exception or wrote a warning, behind the scenes some
code failed to work as designed. This failure information is usually the
most valuable piece of information for troubleshooting. Generally, you can
see that exception content by running the following line:

$error[0] | Select-Object *

Directly after the command failed. Screenshot it.

# Execution Log #
#---------------#

Dbatools logs a lot of information about how a function processes its logic.
You can access that information by running Get-DbatoolsLog. In order to
You can access that information by running Get-DbatoolsLog. In order to
send in this information, start a new process and produce the error, then
execute the following line:

Get-DbatoolsLog | Export-Csv messagelog.csv

This will export the entire log into a csv file. You may want to edit out
confidential information (replace it with something harmles) before
submitting it.

# PowerShell Version #
#--------------------#

We try to support versions 3-5.1 of PowerShell. Sometimes however we mess up
and something doesn't work on all versions. Thus the actual PowerShell
version is often of interest. You can find this information by running the
following line:

$PSVersionTable

# Operating System #
#------------------#

What version of Windows are you running your code on?

# Ugh, this is a bit much, can't you just gather what you need yourself?! #
#-------------------------------------------------------------------------#

Yes, we can! We've got a command that gathers all the data that it can and
bundles it in a zip file for submission. Beware though: It is seriously hard
to hide or redact data from it, as it gathers a lot and stores it in an XML
file that must be edited from PowerShell, if at all. If you don't
particularly worry about sharing the data though, simply run this command:

New-DbatoolsSupportPackage

It'll handle the gathering. Just submit the resultant zip file and we have
all the information your console has to give.


#-------------------------------------------------------------------------#
# A matter of timing #
#-------------------------------------------------------------------------#

When gathering information for an error, we highly recommend taking the
following steps:

- Start a new PowerShell console
- Perform the action necessary to reproduce the error
- Gather data

This has two key benefits:
- The least amount of data gets collected, meaning we have to search through
less material to find the cause.
- Reduces the likelyhood of accidentally sharing confidential data


#-------------------------------------------------------------------------#
# What happens now? #
#-------------------------------------------------------------------------#

Alright, you've gathered the data needed and told us about the issue? Good.
What happens next usually depends on what kind of issue it is and where you
went to report it:

Reported on Slack
- Minor bug: When you report what turns out to be a minor bug (minor
refering to the technical complexity of the issue, not your problem that
Expand All @@ -178,31 +178,31 @@ LONG DESCRIPTION
whichever you prefer. We'll try to see it resolved in a timely manner and
inform you as it has been resolved or ask you to try out a current build
and confirm it.

Reported on GitHub
The key differences between reporting a problem on Github and doing so on
Slack is that are:

a) We cannot ask questions directly as you post.
b) Reporting the issue does not require team members to be present.

We often ARE there, hanging out in Slack, but it is not automatically
guaranteed. That being said, after you have filed an issue on GitHub, please
keep track of that issue, as we will likely ask questions or ask you to test
out solutions. Really, the process is mostly the same, only that since we
can't make sure all the information we need is there when you report it, we
may need to ask for it.


#-------------------------------------------------------------------------#
# The world need not burn #
#-------------------------------------------------------------------------#

Thank you for reading our advisory on receiving support. Note however: It is
totally not necessary to wait until something breaks to contact us: Come on
over into the slack channels and hang out, discuss sql server or the
benefits of the local breweries.


KEYWORDS
dbatools general support help
2 changes: 1 addition & 1 deletion en-us/dbatools-help.xml.REMOVED.git-id
Original file line number Diff line number Diff line change
@@ -1 +1 @@
ae563c3a0bc163d83aaa2e85e06b0344909cc84f
e986be105c6570706a6df1fe75fb1f82428dc55a
Loading

0 comments on commit 716b716

Please sign in to comment.