Clean up documentation, move changelog archive to GitHub releases #458
Conversation
There was a problem hiding this comment.
I am requesting changes because of the CHANGELOG.md file. Unless you want to move it to GitHub releases entirely, my suggestion is to revert the chance and mark the file as archive. Later it can be moved out of the repo root to avoid confusion (e.g. in 3.0?). Moving all changelogs to GitHub Releases may make sense, but it will cause a notification spam for release subscribers. My recommendation would be to avoid it if possible
CHANGELOG.md
Outdated
|
|
||
| Internal changes: | ||
| ## Internal changes |
There was a problem hiding this comment.
Wrong header levels here and below. Version header is h5 while this one is h2
There was a problem hiding this comment.
So I'm going to delete these since they're now present in Releases.
|
|
||
| **NOTE.** _Starting from WinSW `2.0` the release offers a new binary, which targets the .NET Framework 4.0. | ||
| Such configuration is no longer required._ | ||
| #### Making WinSW v1 compatible with .NET runtime 4.0+ |
There was a problem hiding this comment.
Should just archive it later
| @@ -170,40 +180,42 @@ For servers requiring authentication some parameters must be specified depending | |||
|
|
|||
| The parameter “unsecureAuth” is only effective when the transfer protocol is HTTP - unencrypted data transfer. This is a security vulnerability because the credentials are send in clear text! For a SSPI authentication this is not relevant because the authentication tokens are encrypted. | |||
|
|
|||
| For target servers using the HTTPS transfer protocol it is necessary, that the CA which issued the server certificate is trusted by the client. This is normally the situation when the server ist located in the Internet. When an organisation is using a self issued CA for the intranet this probably is not the case. In this case it is necessary to import the CA to the Certificate MMC of the Windows client. Have a look to the instructions on this [site](https://technet.microsoft.com/en-us/library/cc754841.aspx). The self issued CA must be imported to the Trusted Root Certification Authorities for the computer. | |||
| For target servers using the HTTPS transfer protocol it is necessary, that the CA which issued the server certificate is trusted by the client. This is normally the situation when the server ist located in the Internet. When an organisation is using a self issued CA for the intranet this probably is not the case. In this case it is necessary to import the CA to the Certificate MMC of the Windows client. Have a look to the instructions on this [site](https://technet.microsoft.com/en-us/library/cc754841.aspx). The self issued CA must be imported to the Trusted Root Certification Authorities for the computer. | |||
There was a problem hiding this comment.
For the future we need to splitting docs to one sentence-per-line
| @@ -1,217 +1,107 @@ | |||
| Release Notes | |||
| ==== | |||
| # Release Notes | |||
There was a problem hiding this comment.
| # Release Notes | |
| # Release Notes (Archive) |
|
Editing existing releases doesn't raise notifications. I have already copied the change logs to releases entirely. Could you look over there first? |
Oh right. It is not a problem for Existing releases, only for newly created ones if there is no GitHub release associated with a tag. Sorry for confusion. |
|
So yes, then I am fine with the change, except the header levels which need to be fixed. I can do it on the top of your pull request if you are fine with it |
|
Most headers in the Markdown files should be promoted by one level. |
oleg-nenashev
changed the title
oleg-nenashev
changed the title
Please review the CHANGELOG first. You can preview the changes in Releases.
Note that relative links in Releases are all permanent links,
e.g. https://github.com/winsw/winsw/blob/v2.1.0/doc/xmlConfigFile.md#delayedautostart