Add a changelog for SQL Server Setup Guide

[brentozarultd]

Add a changelog for SQL Server Setup Guide

[peschkaj]

Just throwing this out there so I don't have to think about it later -

Some kind of text diff is going to be the easiest way to track this.
Pages/word docs are awful for diffing.
It could be possible to investigate one of the many markdown -> "book" formatting tools to see about autogenerating this document.

• pros: automatic, diffs are easy, easy content regeneration for multiple formats
• cons: moving all content, successfully, into markdown is going to be hella difficult.

[LitKnd]

I feel strongly about not wanting to do this.

I don't mind keeping one internally, but I don't want to publish a change
log for three reasons:

1. I don't want to summarize every typo i fix or URL I correct
2. The document is long enough already
3. The changelog makes it even easier for people to rip off the content and
   republish it under their own brand or to their consulting clients, and just
   edit anything that changes as they go along.

Founder, Brent Ozar Unlimited®
Microsoft Certified Master (SQL Server 2008)
Microsoft Certified Solutions Expert, Data Platform (SQL Server 2012)

On Mon, Jul 28, 2014 at 9:53 AM, BrentOzar [email protected] wrote:

Created by George Stocker ([email protected]) at 2014/07/28 16:49:14
+0000:

Currently, the SQL Server Setup guide has a date it's been changed, but
not a summary of changes since that last version.

The summary of changes is helpful for the following reasons:

1 . Tells us if there's any out of date or incorrect information(!)
2. Tells us what's changed, so we don't need to reread the whole document
or try to retain multiple versions.

Please add a changelog to the guide that details the changes between each
version

Uservoice URL:
http://brentozarultd.uservoice.com/forums/250742-general/suggestions/6225318-add-a-changelog-for-sql-server-setup-guide

—
Reply to this email directly or view it on GitHub
#25.

[BrentOzar]

I would kinda like just a plain English one, like you get with updates to
phone apps. "Typos and fixes" type things when we're only making small
changes, and then notes for really big changes like adding new sections.

On Mon, Jul 28, 2014 at 12:01 PM, Kendra Little [email protected]
wrote:

I feel strongly about not wanting to do this.

I don't mind keeping one internally, but I don't want to publish a change
log for three reasons:

1. I don't want to summarize every typo i fix or URL I correct
2. The document is long enough already
3. The changelog makes it even easier for people to rip off the content
   and
   republish it under their own brand or to their consulting clients, and
   just
   edit anything that changes as they go along.

Founder, Brent Ozar Unlimited®
Microsoft Certified Master (SQL Server 2008)
Microsoft Certified Solutions Expert, Data Platform (SQL Server 2012)

On Mon, Jul 28, 2014 at 9:53 AM, BrentOzar [email protected]
wrote:

Created by George Stocker ([email protected]) at 2014/07/28 16:49:14
+0000:

Currently, the SQL Server Setup guide has a date it's been changed, but
not a summary of changes since that last version.

The summary of changes is helpful for the following reasons:

1 . Tells us if there's any out of date or incorrect information(!)
2. Tells us what's changed, so we don't need to reread the whole
document
or try to retain multiple versions.

Please add a changelog to the guide that details the changes between
each
version

Uservoice URL:

http://brentozarultd.uservoice.com/forums/250742-general/suggestions/6225318-add-a-changelog-for-sql-server-setup-guide

—
Reply to this email directly or view it on GitHub
#25.

—
Reply to this email directly or view it on GitHub
#25 (comment)
.

Brent Ozar - Microsoft Certified Master, MVP
Managing Director, Brent Ozar Unlimited http://www.BrentOzar.com

[LitKnd]

For really big changes, I'm fine with doing a blog post saying "here's what
we added". I think we'd do that anyway.

When it comes to the change log, I'd rather just turn this back into a blog
post and get rid of the PDF, to be honest. The point of this document is
that it's NOT republished and if you're going to set up a sql server that
you do read the whole document and walk through it-- every single time.

Founder, Brent Ozar Unlimited®
Microsoft Certified Master (SQL Server 2008)
Microsoft Certified Solutions Expert, Data Platform (SQL Server 2012)

On Mon, Jul 28, 2014 at 10:16 AM, BrentOzar [email protected]
wrote:

I would kinda like just a plain English one, like you get with updates to
phone apps. "Typos and fixes" type things when we're only making small
changes, and then notes for really big changes like adding new sections.

On Mon, Jul 28, 2014 at 12:01 PM, Kendra Little [email protected]

wrote:

I feel strongly about not wanting to do this.

I don't mind keeping one internally, but I don't want to publish a
change
log for three reasons:

1. I don't want to summarize every typo i fix or URL I correct
2. The document is long enough already
3. The changelog makes it even easier for people to rip off the content
   and
   republish it under their own brand or to their consulting clients, and
   just
   edit anything that changes as they go along.

Founder, Brent Ozar Unlimited®
Microsoft Certified Master (SQL Server 2008)
Microsoft Certified Solutions Expert, Data Platform (SQL Server 2012)

On Mon, Jul 28, 2014 at 9:53 AM, BrentOzar [email protected]
wrote:

Created by George Stocker ([email protected]) at 2014/07/28
16:49:14
+0000:

Currently, the SQL Server Setup guide has a date it's been changed,
but
not a summary of changes since that last version.

The summary of changes is helpful for the following reasons:

1 . Tells us if there's any out of date or incorrect information(!)
2. Tells us what's changed, so we don't need to reread the whole
document
or try to retain multiple versions.

Please add a changelog to the guide that details the changes between
each
version

Uservoice URL:

http://brentozarultd.uservoice.com/forums/250742-general/suggestions/6225318-add-a-changelog-for-sql-server-setup-guide

—
Reply to this email directly or view it on GitHub
#25.

—
Reply to this email directly or view it on GitHub
<
https://github.com/BrentOzarULTD/PublicTools/issues/25#issuecomment-50366462>

.

Brent Ozar - Microsoft Certified Master, MVP
Managing Director, Brent Ozar Unlimited http://www.BrentOzar.com

—
Reply to this email directly or view it on GitHub
#25 (comment)
.

[peschkaj]

I'd think that anything we're adding to the document is probably worth a
blog post anyway.

I'm not a big fan of changelogs in the actual document itself - that's not
where it belongs. We could have a page on the site with a high level
overview of changes and links to the appropriate blog posts as a further
way of getting good links between our content and to keep people diving
through the site.

[LitKnd]

The last change that I made was to add: 11.3 "Make Sure the TCP/IP Protocol
is enabled"

It was a very small change and I didn't really want to write a post
announcing that it hadn't been in there before and I just wanted to take
care of it for super newbie people using the guide.

I put a ton of time into formatting that PDF, I just really don't want to
make it easier for people to rip it off or maintain an "un-branded" copy
that they claim as their own work. I know that's probably not George's
purpose but I know LOTS of people who would use a change log to do it very
easily.

On Mon, Jul 28, 2014 at 10:24 AM, Jeremiah Peschka <[email protected]

wrote:

I'd think that anything we're adding to the document is probably worth a
blog post anyway.

I'm not a big fan of changelogs in the actual document itself - that's not
where it belongs. We could have a page on the site with a high level
overview of changes and links to the appropriate blog posts as a further
way of getting good links between our content and to keep people diving
through the site.

—
Reply to this email directly or view it on GitHub
#25 (comment)
.

[BrentOzar]

This is just me, but if I was going to rip it off, I wouldn't take the
trouble to keep it up to date, hahaha.

I'm totally okay with adding what's been changed lately to the setup guide
page itself at /go/setup - just saying something like, "Recently added:
more info on ___" or whatever.

On Mon, Jul 28, 2014 at 12:29 PM, Kendra Little [email protected]
wrote:

The last change that I made was to add: 11.3 "Make Sure the TCP/IP
Protocol
is enabled"

It was a very small change and I didn't really want to write a post
announcing that it hadn't been in there before and I just wanted to take
care of it for super newbie people using the guide.

I put a ton of time into formatting that PDF, I just really don't want to
make it easier for people to rip it off or maintain an "un-branded" copy
that they claim as their own work. I know that's probably not George's
purpose but I know LOTS of people who would use a change log to do it very
easily.

On Mon, Jul 28, 2014 at 10:24 AM, Jeremiah Peschka <
[email protected]

wrote:

I'd think that anything we're adding to the document is probably worth a
blog post anyway.

I'm not a big fan of changelogs in the actual document itself - that's
not
where it belongs. We could have a page on the site with a high level
overview of changes and links to the appropriate blog posts as a further
way of getting good links between our content and to keep people diving
through the site.

—
Reply to this email directly or view it on GitHub
<
https://github.com/BrentOzarULTD/PublicTools/issues/25#issuecomment-50369483>

.

—
Reply to this email directly or view it on GitHub
#25 (comment)
.

Brent Ozar - Microsoft Certified Master, MVP
Managing Director, Brent Ozar Unlimited http://www.BrentOzar.com

[LitKnd]

Sure. And I'll just not change the last updated date sometimes, too :P

Founder, Brent Ozar Unlimited®
Microsoft Certified Master (SQL Server 2008)
Microsoft Certified Solutions Expert, Data Platform (SQL Server 2012)

On Mon, Jul 28, 2014 at 10:32 AM, BrentOzar [email protected]
wrote:

This is just me, but if I was going to rip it off, I wouldn't take the
trouble to keep it up to date, hahaha.

I'm totally okay with adding what's been changed lately to the setup guide
page itself at /go/setup - just saying something like, "Recently added:
more info on ___" or whatever.

On Mon, Jul 28, 2014 at 12:29 PM, Kendra Little [email protected]

wrote:

The last change that I made was to add: 11.3 "Make Sure the TCP/IP
Protocol
is enabled"

It was a very small change and I didn't really want to write a post
announcing that it hadn't been in there before and I just wanted to take
care of it for super newbie people using the guide.

I put a ton of time into formatting that PDF, I just really don't want
to
make it easier for people to rip it off or maintain an "un-branded" copy
that they claim as their own work. I know that's probably not George's
purpose but I know LOTS of people who would use a change log to do it
very
easily.

On Mon, Jul 28, 2014 at 10:24 AM, Jeremiah Peschka <
[email protected]

wrote:

I'd think that anything we're adding to the document is probably worth
a
blog post anyway.

I'm not a big fan of changelogs in the actual document itself - that's
not
where it belongs. We could have a page on the site with a high level
overview of changes and links to the appropriate blog posts as a
further
way of getting good links between our content and to keep people
diving
through the site.

—
Reply to this email directly or view it on GitHub
<

https://github.com/BrentOzarULTD/PublicTools/issues/25#issuecomment-50369483>

.

—
Reply to this email directly or view it on GitHub
<
https://github.com/BrentOzarULTD/PublicTools/issues/25#issuecomment-50370121>

.

Brent Ozar - Microsoft Certified Master, MVP
Managing Director, Brent Ozar Unlimited http://www.BrentOzar.com

—

Reply to this email directly or view it on GitHub
#25 (comment)
.

[BrentOzar]

Hell yeah. Plus that part will be on accident, and now we can say it was on
purpose, hahaha.

On Mon, Jul 28, 2014 at 12:35 PM, Kendra Little [email protected]
wrote:

Sure. And I'll just not change the last updated date sometimes, too :P

Founder, Brent Ozar Unlimited®
Microsoft Certified Master (SQL Server 2008)
Microsoft Certified Solutions Expert, Data Platform (SQL Server 2012)

On Mon, Jul 28, 2014 at 10:32 AM, BrentOzar [email protected]
wrote:

This is just me, but if I was going to rip it off, I wouldn't take the
trouble to keep it up to date, hahaha.

I'm totally okay with adding what's been changed lately to the setup
guide
page itself at /go/setup - just saying something like, "Recently added:
more info on ___" or whatever.

On Mon, Jul 28, 2014 at 12:29 PM, Kendra Little <
[email protected]>

wrote:

The last change that I made was to add: 11.3 "Make Sure the TCP/IP
Protocol
is enabled"

It was a very small change and I didn't really want to write a post
announcing that it hadn't been in there before and I just wanted to
take
care of it for super newbie people using the guide.

I put a ton of time into formatting that PDF, I just really don't want
to
make it easier for people to rip it off or maintain an "un-branded"
copy
that they claim as their own work. I know that's probably not George's
purpose but I know LOTS of people who would use a change log to do it
very
easily.

On Mon, Jul 28, 2014 at 10:24 AM, Jeremiah Peschka <
[email protected]

wrote:

I'd think that anything we're adding to the document is probably
worth
a
blog post anyway.

I'm not a big fan of changelogs in the actual document itself -
that's
not
where it belongs. We could have a page on the site with a high level
overview of changes and links to the appropriate blog posts as a
further
way of getting good links between our content and to keep people
diving
through the site.

—
Reply to this email directly or view it on GitHub
<

https://github.com/BrentOzarULTD/PublicTools/issues/25#issuecomment-50369483>

.

—
Reply to this email directly or view it on GitHub
<

https://github.com/BrentOzarULTD/PublicTools/issues/25#issuecomment-50370121>

.

Brent Ozar - Microsoft Certified Master, MVP
Managing Director, Brent Ozar Unlimited http://www.BrentOzar.com

—

Reply to this email directly or view it on GitHub
<
https://github.com/BrentOzarULTD/PublicTools/issues/25#issuecomment-50370586>

.

—
Reply to this email directly or view it on GitHub
#25 (comment)
.

Brent Ozar - Microsoft Certified Master, MVP
Managing Director, Brent Ozar Unlimited http://www.BrentOzar.com