Browse Source

Update links in documentation

Remove references to "Google Groups" - it is effectively no longer used,
since all discussions already moved to GitHub issues.

Update contribution guidelines.
bel2125 4 năm trước cách đây
mục cha
commit
8ef4d891c5
4 tập tin đã thay đổi với 29 bổ sung23 xóa
  1. 9 7
      README.md
  2. 13 10
      docs/Contribution.md
  3. 3 2
      docs/README.md
  4. 4 4
      examples/https/civetweb.conf

+ 9 - 7
README.md

@@ -55,10 +55,11 @@ CivetWeb must be used with an earlier or later version (see also [here](https://
 Trouble tickets should be filed on GitHub
 [https://github.com/civetweb/civetweb/issues](https://github.com/civetweb/civetweb/issues)
 
-Announcements are at Google Groups
-[https://groups.google.com/d/forum/civetweb](https://groups.google.com/d/forum/civetweb). 
-Some older support and discussion threads are there as well. 
-However, recently support questions and discussions are usually [GitHub issues](https://github.com/civetweb/civetweb/issues).
+New releases are announced at Google Groups
+[https://groups.google.com/d/forum/civetweb](https://groups.google.com/d/forum/civetweb)
+
+Formerly some support question and discussion threads have been at [Google groups](https://groups.google.com/d/forum/civetweb).
+Recent questions and discussions use [GitHub issues](https://github.com/civetweb/civetweb/issues).
 
 Source releases can be found on GitHub
 [https://github.com/civetweb/civetweb/releases](https://github.com/civetweb/civetweb/releases)
@@ -140,12 +141,13 @@ simplicity by a carefully selected list of features:
 Support
 -------
 
-This project is very easy to install and use. 
+This project is very easy to install and use.
 Please read the [documentation](https://github.com/civetweb/civetweb/blob/master/docs/)
 and have a look at the [examples](https://github.com/civetweb/civetweb/blob/master/examples/).
 
-Some information may be found on the [mailing list](https://groups.google.com/d/forum/civetweb),
-However, since questions and discussions moved to [GitHub issues](https://github.com/civetweb/civetweb/issues), information there may be out of date.
+Recent questions and discussions usually use [GitHub issues](https://github.com/civetweb/civetweb/issues).
+Some old information may be found on the [mailing list](https://groups.google.com/d/forum/civetweb), 
+but this information may be outdated.
 
 Note: We do not take any liability or warranty for any linked contents.  Visit these pages and try the community support suggestions at your own risk.
 Any link provided in this project (including source and documentation) is provided in the hope that this information will be helpful.

+ 13 - 10
docs/Contribution.md

@@ -3,12 +3,13 @@ Contributing to CivetWeb
 
 Contributions to CivetWeb are welcome, provided all contributions carry the MIT license.
 
-- Please report issues on GitHub. If the issue you want to report is already reported there, add a note with your specific details to that issue. In case of doubt, please create a new issue.
-- If you know how to fix the issue, please create a pull request on GitHub. Please take care your modifications pass the continuous integration checks. These checks are performed automatically when you create a pull request, but it may take some hours until all tests are completed. Please provide a description for every pull request.
-- Alternatively, you can post a patch or describe the required modifications in a GitHub issue.
-However, a pull request would be preferred.
-- Contributor names are listed in CREDITS.md, unless you explicitly state you don't want your name to be listed there. This file is occasionally updated, adding new contributors, using author names from git commits and GitHub comments.
+- Please report [issues](https://github.com/civetweb/civetweb/issues) on GitHub. If the issue you want to report is already reported there, add a comment with your specific details to that issue. In case of doubt, please create a new issue.
+- If you know how to fix the issue, please create a pull request on GitHub. Please take care your modifications pass the continuous integration checks. These checks are performed automatically when you create a pull request, but it may take some hours until all tests are completed. Please provide a description for every pull request (see below).
+- Alternatively, you can post a patch or describe the required modifications in a GitHub issue. However, a pull request would be preferred.
 
+- Improving documentation, tests and examples are welcome.
+
+- Contributor names are listed in [CREDITS.md](https://github.com/civetweb/civetweb/blob/master/CREDITS.md), unless you explicitly state you don't want your name to be listed there. This file is occasionally updated, adding new contributors, using author names from git commits and GitHub comments.
 
 - In case your modifications either
   1. modify or extend the API,
@@ -16,17 +17,19 @@ However, a pull request would be preferred.
   3. imply structural changes,
   or
   4. have significant influence on maintenance,
-  
-  please first create an issue on GitHub or create a thread on the CivetWeb discussion group, to discuss the planned changed.
 
-- In case you think you found a security issue that should be evaluated and fixed before public disclosure, feel free to write an email.  Although CivetWeb is a fork from Mongoose from 2013, the code bases are different now, so security vulnerabilities of Mongoose usually do not affect CivetWeb.  Open an issue for Mongoose vulnerabilities you want to have checked if CivetWeb is affected.
+  please first create an issue on GitHub to discuss the planned changed.
+
+- In case you think you found a security issue that should be evaluated and fixed before public disclosure, feel free to write an email.  Although CivetWeb is a fork from Mongoose from 2013, the code bases are different now, so security vulnerabilities of Mongoose usually do not affect CivetWeb. See also [SECURITY.md](https://github.com/civetweb/civetweb/blob/master/SECURITY.md).
 
 
 Why does a pull request need a description?
 ---
 
-I'm asking for this, because I usually review all pull requests.
+I'm asking for this, because I review most pull requests.
 The first thing I check is: "What is the intention of the fix **according to the description**?" and "Does the code really fix it?".
 Second: "Do I except side effects?".
 Third: "Is there a better way to fix the issue **explained in the description**?"
-I don't like to "reverse engineer" the intention of the fix from the diff (although it may be obvious to the author of the PR, sometimes it's not for others). But you should also do it for yourself: You will get early feedback if your changes are not doing what you expect, or if there is a much more effective way to reach the same goal. Finally it will help all other users, since it helps writing better release notes.
+I don't like to "reverse engineer" the intention of the fix from the diff (although it may be obvious to the author of the PR, sometimes it's not for others).
+Writing a description will also help you to get early feedback if your changes are not doing what you expect, or if there is a much more effective way to reach the same goal.
+Finally it will help all other users, since it allows to write better release notes.

+ 3 - 2
docs/README.md

@@ -19,10 +19,11 @@ Developers can contribute to CivetWeb via GitHub
 Trouble tickets should be filed on GitHub
 [https://github.com/civetweb/civetweb/issues](https://github.com/civetweb/civetweb/issues)
 
-Announcements are at Google Groups
+New releases are announced at Google Groups
 [https://groups.google.com/d/forum/civetweb](https://groups.google.com/d/forum/civetweb)
 
-While older support question and discussion threads have been at [Google groups](https://groups.google.com/d/forum/civetweb), most newer ones are [GitHub issues](https://github.com/civetweb/civetweb/issues).
+Formerly some support question and discussion threads have been at [Google groups](https://groups.google.com/d/forum/civetweb).
+Recent questions and discussions use [GitHub issues](https://github.com/civetweb/civetweb/issues).
 
 Source releases can be found on GitHub
 [https://github.com/civetweb/civetweb/releases](https://github.com/civetweb/civetweb/releases)

+ 4 - 4
examples/https/civetweb.conf

@@ -1,5 +1,5 @@
 # Instructions to run (on Linux) to reproduce test results:
-# 
+#
 # 1) copy civetweb executable here (examples/https directory)
 # 2) sudo ./civetweb
 #
@@ -23,8 +23,8 @@
 #    proper certificate. Don't use it for your public home page, but
 #    consider it for your private remote access server.
 # 7) run civetweb, like above - or better create your own start script
-# You are welcome to share your thoughts and experience on GitHub 
-# (or Google groups) - see README.md in CivetWeb main directory
+#    You are welcome to share your thoughts and experience on GitHub
+#    (see README.md in CivetWeb main directory).
 
 # Don't run as super user, switch back to a regular user
 run_as_user user
@@ -48,7 +48,7 @@ ssl_protocol_version 4
 ssl_cipher_list ECDH+AESGCM+AES256:!aNULL:!MD5:!DSS
 
 # Tell all browsers to access this site only as HTTPS for the next 180 days
-strict_transport_security_max_age 15552000                                  
+strict_transport_security_max_age 15552000
 
 # Set some HTTP security header, see https://securityheaders.io
 additional_header Content-Security-Policy: script-src 'self'