#
86d33001 |
| 31-Mar-2024 |
Daniel Stenberg |
reuse: add copyright + license info to individual docs/*.md files Instead of use 'docs/*.md' in dep5. For clarity and avoiding a wide- matching wildcard. + Remove mention of old
reuse: add copyright + license info to individual docs/*.md files Instead of use 'docs/*.md' in dep5. For clarity and avoiding a wide- matching wildcard. + Remove mention of old files from .reuse/dep5 + add info to .github/dependabot.yml + make scripts/copyright.pl warn on non-matching patterns Closes #13245
show more ...
|
#
6f685f04 |
| 04-Mar-2024 |
Daniel Stenberg |
CONTRIBUTE: update the section on documentation format ... since most of it is markdown now. Closes #13046
|
#
2097a095 |
| 27-Feb-2024 |
Daniel Stenberg |
docs: use present tense avoid "will", detect "will" as a bad word in the CI Also line wrapped a bunch of paragraphs Closes #13001
|
#
e5000e79 |
| 23-Jan-2024 |
Daniel Stenberg |
GHA: add a job scanning for "bad words" in markdown This means words, phrases or things we have decided not to use - words that are spelled right according to the dictionary but we want
GHA: add a job scanning for "bad words" in markdown This means words, phrases or things we have decided not to use - words that are spelled right according to the dictionary but we want to avoid. In the name of consistency and better documentation. Closes #12764
show more ...
|
#
eefcc1bd |
| 17-Jan-2024 |
Daniel Stenberg |
docs: introduce "curldown" for libcurl man page format curldown is this new file format for libcurl man pages. It is markdown inspired with differences: - Each file has a set of
docs: introduce "curldown" for libcurl man page format curldown is this new file format for libcurl man pages. It is markdown inspired with differences: - Each file has a set of leading headers with meta-data - Supports a small subset of markdown - Uses .md file extensions for editors/IDE/GitHub to treat them nicely - Generates man pages very similar to the previous ones - Generates man pages that still convert nicely to HTML on the website - Detects and highlights mentions of curl symbols automatically (when their man page section is specified) tools: - cd2nroff: converts from curldown to nroff man page - nroff2cd: convert an (old) nroff man page to curldown - cdall: convert many nroff pages to curldown versions - cd2cd: verifies and updates a curldown to latest curldown This setup generates .3 versions of all the curldown versions at build time. CI: Since the documentation is now technically markdown in the eyes of many things, the CI runs many more tests and checks on this documentation, including proselint, link checkers and tests that make sure we capitalize the first letter after a period... Closes #12730
show more ...
|
#
5b060a41 |
| 22-Aug-2023 |
Daniel Stenberg |
docs: rewrite to present tense ... instead of using future tense. + numerous cleanups and improvements + stick to "reuse" not "re-use" + fewer contractions Closes #
docs: rewrite to present tense ... instead of using future tense. + numerous cleanups and improvements + stick to "reuse" not "re-use" + fewer contractions Closes #11713
show more ...
|
#
3c0a9107 |
| 23-Jul-2023 |
Andrei Rybak |
CONTRIBUTE: drop mention of copyright year ranges Year ranges in copyrights were dropped in commits [1] and [2]. Verification of year ranges in copyrights was dropped from script 'sc
CONTRIBUTE: drop mention of copyright year ranges Year ranges in copyrights were dropped in commits [1] and [2]. Verification of year ranges in copyrights was dropped from script 'scripts/copyright.pl' in commit [3]. However, the corresponding passages in file 'docs/CONTRIBUTE.md' weren't updated. Drop mentions of copyright year ranges from 'docs/CONTRIBUTE.md'. [1] 2bc1d775f (copyright: update all copyright lines and remove year ranges, 2023-01-02) [2] c46761bd8 (tests/http: remove year ranges from copyrights, 2023-03-14) [3] 0e293bacb (copyright.pl: cease doing year verifications, 2023-01-28) Closes #11504
show more ...
|
#
971f03e5 |
| 23-Jul-2023 |
Andrei Rybak |
CONTRIBUTE: fix syntax in commit message description File 'docs/CONTRIBUTE.md' includes a description of how one should write commit messages in the curl project. Different possible par
CONTRIBUTE: fix syntax in commit message description File 'docs/CONTRIBUTE.md' includes a description of how one should write commit messages in the curl project. Different possible parts of the message are enclosed in square brackets. One exception is the section describing how the curl project doesn't use "Signed-off-by" commit trailers [1], which is enclosed in an opening curly brace paired with a closing square bracket. Fix the enclosing square brackets in description of "Signed-off-by" trailers in commit messages in file 'docs/CONTRIBUTE.md'. [1] See description of option '--signoff' in Git documentation: https://git-scm.com/docs/git-commit Closes #11504
show more ...
|
#
4578ada4 |
| 27-Apr-2023 |
Daniel Stenberg |
docs: minor polish - "an HTTP*" (not "a") - remove a few contractions - remove a spurious "a" - reduce use of "I" in texts Closes #11040
|
#
1807eb5e |
| 11-Feb-2023 |
Dan Fandrich |
CONTRIBUTE: More formally specify the commit description This codifies what people have actually used in git commits over the past 6 years. I've left off some lesser-used headers that ap
CONTRIBUTE: More formally specify the commit description This codifies what people have actually used in git commits over the past 6 years. I've left off some lesser-used headers that appear to duplicate others and tried to describe a consistent use for several others that were used more arbitrarily. This makes it easier for new committers to find out the kinds of things we want to acknowledge, makes it easier to perform statistical analysis on commits, and opens the possibility of performing lint checks on descriptions before submission. Reviewed-by: Daniel Stenberg Reviewed-by: Jay Satiro Closes #10478
show more ...
|
#
4484270a |
| 26-Oct-2022 |
Ayesh Karunaratne |
misc: typo and grammar fixes - Replace `Github` with `GitHub`. - Replace `windows` with `Windows` - Replace `advice` with `advise` where a verb is used. - A few fixes on removing
misc: typo and grammar fixes - Replace `Github` with `GitHub`. - Replace `windows` with `Windows` - Replace `advice` with `advise` where a verb is used. - A few fixes on removing repeated words. - Replace `a HTTP` with `an HTTP` Closes #9802
show more ...
|
#
fd1ce3d4 |
| 20-Sep-2022 |
Daniel Stenberg |
docs: spellfixes Pointed by the new CI job
|
#
fda897f5 |
| 19-Sep-2022 |
Daniel Stenberg |
docs: fix proselint complaints
|
#
c717975e |
| 21-Jun-2022 |
Daniel Stenberg |
CONTRIBUTE: mention how we maintain REUSE compliance for copyright and license information of all files stored in git Closes #9032
|
#
267d560b |
| 24-May-2022 |
Daniel Stenberg |
docs/CONTRIBUTE.md: document the 'needs-votes' concept A pull request sent to the project might get labeled `needs-votes` by a project maintainer. This label means that in addition to me
docs/CONTRIBUTE.md: document the 'needs-votes' concept A pull request sent to the project might get labeled `needs-votes` by a project maintainer. This label means that in addition to meeting all other checks and qualifications this pull request must also receive proven support/thumbs-ups from more community members to be considered for merging. Closes #8910
show more ...
|
#
e30b2064 |
| 09-Dec-2021 |
Daniel Stenberg |
docs: fix proselint nits - remove a lot of exclamation marks - use consistent spaces (1, not 2) - use better words at some places Closes #8123
|
#
76d6e719 |
| 26-Nov-2021 |
Daniel Stenberg |
docs: address proselint nits - avoid exclamation marks - use consistent number of spaces after periods: one - avoid clichés - avoid using 'very' Closes #8060
|
#
cc2870e2 |
| 16-Nov-2021 |
Kevin Burke |
tests/CI.md: add more information on CI environments Fixes #8012 Closes #8022
|
#
a28464ae |
| 31-Oct-2021 |
Daniel Stenberg |
docs: reduce/avoid English contractions You're => You are Hasn't => Has not Doesn't => Does not Don't => Do not You'll => You will etc Closes #7930
|
#
92efb3db |
| 01-Nov-2021 |
Daniel Stenberg |
docs: reduce use of "very" "Very" should be avoided in most texts. If intensifiers are needed, try find better words instead. Closes #7936
|
#
8749ce65 |
| 18-Jul-2021 |
Nyholm |
docs: correct spelling errors and a broken link Update grammar and spelling in docs and source code comments. Closes: #7427 Reviewed-by: Daniel Stenberg <daniel@haxx.se>
|
#
b7ca0cfe |
| 29-Jun-2021 |
Daniel Stenberg |
CI: remove travis details Rename still used leftovers to "zuul" as that's now the CI using them. Closes #7313
|
#
b03b82a8 |
| 23-May-2021 |
Daniel Stenberg |
docs/tests: remove freenode references
|
#
3d3f4efb |
| 18-May-2021 |
Emil Engler |
docs: replace dots with dashes in markdown enums We use dashes instead of dots nearly everywhere except for those few cases. This commit addresses this issues and brings more coherency i
docs: replace dots with dashes in markdown enums We use dashes instead of dots nearly everywhere except for those few cases. This commit addresses this issues and brings more coherency into it. Closes #7093
show more ...
|
#
6aae7b17 |
| 27-Apr-2021 |
Ayushman Singh Chauhan |
docs: camelcase it like GitHub everywhere Closes #6979
|