From 948f1e2065295ea29f342b2e58bcd21078913767 Mon Sep 17 00:00:00 2001 From: jcamiel Date: Fri, 2 Sep 2022 14:45:54 +0200 Subject: [PATCH] Rename manual-page.md to manual.md --- README.md | 4 ++-- bin/docs/build_man_md.py | 2 +- bin/docs/build_readme.py | 2 +- bin/release/gen_manpage.py | 2 +- bin/release/man.sh | 4 ++-- .../chocolatey/hurl/hurl.nuspec | 2 +- docs/README.md | 12 ++++++++---- docs/asserting-response.md | 2 +- docs/capturing-response.md | 2 +- docs/entry.md | 8 ++++---- docs/index.md | 2 +- docs/{manual-page.md => manual.md} | 0 docs/manual/hurl.1 | 2 +- docs/manual/hurlfmt.1 | 2 +- docs/request.md | 12 ++++++------ docs/response.md | 2 +- docs/running-tests.md | 14 +++++++------- docs/samples.md | 4 ++-- docs/templates.md | 4 ++-- docs/tutorial/captures.md | 2 +- docs/tutorial/chaining-requests.md | 2 +- docs/tutorial/debug-tips.md | 14 +++++++------- docs/tutorial/your-first-hurl-file.md | 2 +- packages/hurl/README.md | 4 ++-- 24 files changed, 55 insertions(+), 51 deletions(-) rename docs/{manual-page.md => manual.md} (100%) diff --git a/README.md b/README.md index efb1394cc..d71555b9c 100644 --- a/README.md +++ b/README.md @@ -969,10 +969,10 @@ Please follow the [contrib on Windows section]. [`Authorization` header]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Authorization [Hurl tests suite]: https://github.com/Orange-OpenSource/hurl/tree/master/integration/tests_ok [Authorization]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Authorization -[`-u/--user` option]: https://hurl.dev/docs/manual-page.html#user +[`-u/--user` option]: https://hurl.dev/docs/manual.html#user [curl]: https://curl.se [entry]: https://hurl.dev/docs/entry.html -[`--test` option]: https://hurl.dev/docs/manual-page.html#test +[`--test` option]: https://hurl.dev/docs/manual.html#test [GitHub]: https://github.com/Orange-OpenSource/hurl [hurl-1.6.1-win64.zip]: https://github.com/Orange-OpenSource/hurl/releases/download/1.6.1/hurl-1.6.1-win64.zip [hurl-1.6.1-win64-installer.exe]: https://github.com/Orange-OpenSource/hurl/releases/download/1.6.1/hurl-1.6.1-win64-installer.exe diff --git a/bin/docs/build_man_md.py b/bin/docs/build_man_md.py index 6032d7a03..ce2061176 100644 --- a/bin/docs/build_man_md.py +++ b/bin/docs/build_man_md.py @@ -6,7 +6,7 @@ This script converts Hurl manual file to Markdown suitable for the Hurl canonica This tool takes the Hurl manual file as a first argument. Examples: - $ python3 bin/docs/build_man_md.py docs/manual/hurl.md > docs/manual-page.md + $ python3 bin/docs/build_man_md.py docs/manual/hurl.md > docs/manual.md """ import re diff --git a/bin/docs/build_readme.py b/bin/docs/build_readme.py index 0d18db4c5..85758ace4 100755 --- a/bin/docs/build_readme.py +++ b/bin/docs/build_readme.py @@ -75,7 +75,7 @@ def main(dest: str) -> int: home_md.remove_nodes(logo_nodes) samples_md = parse_markdown(text=Path("docs/samples.md").read_text()) - usage_md = parse_markdown(text=Path("docs/manual-page.md").read_text()) + usage_md = parse_markdown(text=Path("docs/manual.md").read_text()) installation_md = parse_markdown(text=Path("docs/installation.md").read_text()) diff --git a/bin/release/gen_manpage.py b/bin/release/gen_manpage.py index c6ea6f265..8c1c68129 100755 --- a/bin/release/gen_manpage.py +++ b/bin/release/gen_manpage.py @@ -6,7 +6,7 @@ This script creates Hurl man file from a Markdown source. This tool takes the Hurl man Markdown source file as a first argument. Examples: - $ python3 bin/release/gen_manpage.py docs/man/hurl.md > ../../docs/man-page.md + $ python3 bin/release/gen_manpage.py docs/manual/hurl.md > ../../docs/manual.md """ import sys diff --git a/bin/release/man.sh b/bin/release/man.sh index 63fd5d07c..072977186 100755 --- a/bin/release/man.sh +++ b/bin/release/man.sh @@ -3,8 +3,8 @@ set -e rm -rf target/man mkdir -p target/man -bin/release/gen_manpage.py docs/man/hurl.md > target/man/hurl.1 -bin/release/gen_manpage.py docs/man/hurlfmt.md > target/man/hurlfmt.1 +bin/release/gen_manpage.py docs/manual/hurl.md > target/man/hurl.1 +bin/release/gen_manpage.py docs/manual/hurlfmt.md > target/man/hurlfmt.1 gzip -n -9 target/man/hurl.1 gzip -n -9 target/man/hurlfmt.1 diff --git a/contrib/windows/windows_package_managers/chocolatey/hurl/hurl.nuspec b/contrib/windows/windows_package_managers/chocolatey/hurl/hurl.nuspec index d3e09bb5a..efcedeed6 100644 --- a/contrib/windows/windows_package_managers/chocolatey/hurl/hurl.nuspec +++ b/contrib/windows/windows_package_managers/chocolatey/hurl/hurl.nuspec @@ -12,7 +12,7 @@ false https://github.com/Orange-OpenSource/hurl https://github.com/Orange-OpenSource/hurl/tree/master/contrib/windows/windows_package_managers/chocolatey/hurl - https://hurl.dev/docs/manual-page.html + https://hurl.dev https://github.com/Orange-OpenSource/hurl/issues hurl curl http https cli http-client testing-tool integration-tool automation-tool api-testing cross-platform Hurl is a command line tool that runs HTTP requests defined in a simple plain text format diff --git a/docs/README.md b/docs/README.md index 3e0e9f465..0c46f87ce 100644 --- a/docs/README.md +++ b/docs/README.md @@ -9,11 +9,13 @@ The canonical source for the Hurl manual pages is at +- to generate Markdown documentation page [`manual.md`] for + +Dependencies: ``` docs/manual/hurl.md => docs/manual/hurl.1 -docs/manual/hurl.md => docs/manual-page.md +docs/manual/hurl.md => docs/manual.md docs/manual/hurlfmt.md => docs/manual/hurlfmt.1 ``` @@ -22,6 +24,8 @@ docs/manual/hurlfmt.md => docs/manual/hurlfmt.1 [GitHub README] and [crates.io README] are generated from the canonical docs. +Dependencies: + ``` docs/*.md => README.md docs/*.md => packages/hurl/README.md @@ -37,7 +41,7 @@ docs/*.md => packages/hurl/README.md ```bash $ python3 bin/release/gen_manpage.py docs/manual/hurl.md > docs/manual/hurl.1 $ python3 bin/release/gen_manpage.py docs/manual/hurlfmt.md > docs/manual/hurlfmt.1 -$ python3 bin/docs/build_man_md.py docs/manual/hurl.md > docs/manual-page.md +$ python3 bin/docs/build_man_md.py docs/manual/hurl.md > docs/manual.md $ python3 bin/docs/build_readme.py github > README.md $ python3 bin/docs/build_readme.py crates > packages/hurl/README.md ``` @@ -47,7 +51,7 @@ $ python3 bin/docs/build_readme.py crates > packages/hurl/README.md [`hurlfmt.md`]: https://github.com/Orange-OpenSource/hurl/tree/master/docs/manual/hurlfmt.md [`hurl.1`]: https://github.com/Orange-OpenSource/hurl/tree/master/docs/manual/hurl.1 [`hurlfmt.1`]: https://github.com/Orange-OpenSource/hurl/tree/master/docs/manual/hurlfmt.1 -[`manual-page.md`]: https://github.com/Orange-OpenSource/hurl/blob/master/docs/manual-page.md +[`manual.md`]: https://github.com/Orange-OpenSource/hurl/blob/master/docs/manual.md [GitHub README]: https://github.com/Orange-OpenSource/hurl/blob/master/README.md [crates.io README]: https://github.com/Orange-OpenSource/hurl/blob/master/packages/hurl/README.md diff --git a/docs/asserting-response.md b/docs/asserting-response.md index 47d1b68ca..e20b174d4 100644 --- a/docs/asserting-response.md +++ b/docs/asserting-response.md @@ -671,7 +671,7 @@ of all file nodes. [JSON]: https://www.json.org [XML]: https://en.wikipedia.org/wiki/XML [Base64]: https://en.wikipedia.org/wiki/Base64 -[`--file-root` option]: /docs/manual-page.md#file-root +[`--file-root` option]: /docs/manual.md#file-root [`count`]: /docs/capturing-response.md#count-subquery [Javascript-like Regular expression syntax]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions [MD5]: https://en.wikipedia.org/wiki/MD5 diff --git a/docs/capturing-response.md b/docs/capturing-response.md index 199b4d181..a9f8edd72 100644 --- a/docs/capturing-response.md +++ b/docs/capturing-response.md @@ -326,7 +326,7 @@ cats_size: jsonpath "$.cats" count [CSRF tokens]: https://en.wikipedia.org/wiki/Cross-site_request_forgery -[variable values]: /docs/manual-page.md#variable +[variable values]: /docs/manual.md#variable [templates]: /docs/templates.md [`Set-Cookie`]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie [XPath]: https://en.wikipedia.org/wiki/XPath diff --git a/docs/entry.md b/docs/entry.md index 5493533b8..076c94cdf 100644 --- a/docs/entry.md +++ b/docs/entry.md @@ -110,7 +110,7 @@ HTTP/* 200 [response]: /docs/response.md [capture values]: /docs/capturing-response.md [add asserts to HTTP responses]: /docs/asserting-response.md -[`--location`]: /docs/manual-page.md#location -[`--max-redirs`]: /docs/manual-page.md#max-redirs -[Options]: /docs/man-page.html#options -[`--location` option]: /docs/man-page.html#location +[`--location`]: /docs/manual.md#location +[`--max-redirs`]: /docs/manual.md#max-redirs +[Options]: /docs/manual.md#options +[`--location` option]: /docs/manual.md#location diff --git a/docs/index.md b/docs/index.md index a30d3c98e..249328188 100644 --- a/docs/index.md +++ b/docs/index.md @@ -9,7 +9,7 @@ ## [Resources] -[Getting Started]: /docs/manual-page.md +[Getting Started]: /docs/manual.md [File Format]: /docs/hurl-file.md [Tutorial]: /docs/tutorial/your-first-hurl-file.md [Resources]: /docs/license.md diff --git a/docs/manual-page.md b/docs/manual.md similarity index 100% rename from docs/manual-page.md rename to docs/manual.md diff --git a/docs/manual/hurl.1 b/docs/manual/hurl.1 index f679ee4f7..cf1125903 100644 --- a/docs/manual/hurl.1 +++ b/docs/manual/hurl.1 @@ -1,4 +1,4 @@ -.TH hurl 1 "01 Sep 2022" "hurl 1.7.0-snapshot" " Hurl Manual" +.TH hurl 1 "02 Sep 2022" "hurl 1.7.0-snapshot" " Hurl Manual" .SH NAME hurl - run and test HTTP requests. diff --git a/docs/manual/hurlfmt.1 b/docs/manual/hurlfmt.1 index c32d90470..ab07124ce 100644 --- a/docs/manual/hurlfmt.1 +++ b/docs/manual/hurlfmt.1 @@ -1,4 +1,4 @@ -.TH hurl 1 "01 Sep 2022" "hurl 1.7.0-snapshot" " Hurl Manual" +.TH hurl 1 "02 Sep 2022" "hurl 1.7.0-snapshot" " Hurl Manual" .SH NAME hurlfmt - format Hurl files diff --git a/docs/request.md b/docs/request.md index 7f820d6b5..3c1649b6e 100644 --- a/docs/request.md +++ b/docs/request.md @@ -525,17 +525,17 @@ very-verbose: true # allow more verbose output [multiline string body]: #multiline-string-body [body section]: #body [multipart/form-data on MDN]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/POST -[`--file-root` option]: /docs/manual-page.md#file-root +[`--file-root` option]: /docs/manual.md#file-root [JSON]: https://www.json.org [XML]: https://en.wikipedia.org/wiki/XML [Base64]: https://en.wikipedia.org/wiki/Base64 [hexadecimal string]: #hex-body [included file]: #file-body -[`--file-root` option]: /docs/manual-page.md#file-root -[`-u/--user` option]: /docs/manual-page.md#user +[`--file-root` option]: /docs/manual.md#file-root +[`-u/--user` option]: /docs/manual.md#user [Hurl unicode literals \u{20}]: /docs/hurl-file.md#special-character-in-strings [Authorization]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Authorization -[`--location`]: /docs/man-page.html#location -[`--verbose`]: /docs/man-page.html#verbose -[`--insecure`]: /docs/man-page.html#insecure +[`--location`]: /docs/manual.md#location +[`--verbose`]: /docs/manual.md#verbose +[`--insecure`]: /docs/manual.md#insecure diff --git a/docs/response.md b/docs/response.md index 57ed4f1d2..91d60f720 100644 --- a/docs/response.md +++ b/docs/response.md @@ -100,5 +100,5 @@ header by example) and add assert and captures on the decoded body as if there w [capture value from headers, body]: /docs/capturing-response.md [add assert on status code, body or headers]: /docs/asserting-response.md [br, gzip, deflate]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Encoding -[`--compressed` option]: /docs/manual-page.md#compressed +[`--compressed` option]: /docs/manual.md#compressed [`Accept-Encoding`]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Encoding diff --git a/docs/running-tests.md b/docs/running-tests.md index 652e84764..809b89d18 100644 --- a/docs/running-tests.md +++ b/docs/running-tests.md @@ -86,11 +86,11 @@ To use variables in your tests, you can: You will find a detail description in the [Injecting Variables] section of the doc. -[`--output /dev/null`]: /docs/manual-page.md#output -[`--test`]: /docs/manual-page.md#test -[`--report-html HTML_DIR`]: /docs/manual-page.md#report-html -[`--test` option]: /docs/manual-page.md#test -[`--glob` option]: /docs/manual-page.md#glob -[`--variable` option]: /docs/manual-page.md#variable -[`--variables-file` option]: /docs/manual-page.md#variables-file +[`--output /dev/null`]: /docs/manual.md#output +[`--test`]: /docs/manual.md#test +[`--report-html HTML_DIR`]: /docs/manual.md#report-html +[`--test` option]: /docs/manual.md#test +[`--glob` option]: /docs/manual.md#glob +[`--variable` option]: /docs/manual.md#variable +[`--variables-file` option]: /docs/manual.md#variables-file [Injecting Variables]: /docs/templates.md#injecting-variables \ No newline at end of file diff --git a/docs/samples.md b/docs/samples.md index 9e50d6a78..ae4b16ccc 100644 --- a/docs/samples.md +++ b/docs/samples.md @@ -380,7 +380,7 @@ bytes startsWith hex,efbbbf; [`Authorization` header]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Authorization [Hurl tests suite]: https://github.com/Orange-OpenSource/hurl/tree/master/integration/tests_ok [Authorization]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Authorization -[`-u/--user` option]: /docs/manual-page.md#user +[`-u/--user` option]: /docs/manual.md#user [curl]: https://curl.se [entry]: /docs/entry.md -[`--test` option]: /docs/manual-page.md#test \ No newline at end of file +[`--test` option]: /docs/manual.md#test \ No newline at end of file diff --git a/docs/templates.md b/docs/templates.md index 5cb2f3193..a78a0fb7c 100644 --- a/docs/templates.md +++ b/docs/templates.md @@ -187,8 +187,8 @@ Resulting in a PUT request with the following JSON body: } ``` -[`--variable` option]: /docs/manual-page.md#variable -[`--variables-file` option]: /docs/manual-page.md#variables-file +[`--variable` option]: /docs/manual.md#variable +[`--variables-file` option]: /docs/manual.md#variables-file [CSRF token]: https://en.wikipedia.org/wiki/Cross-site_request_forgery [JSONPath]: /docs/asserting-response.md#jsonpath-assert [JSON body]: /docs/request.md#json-body diff --git a/docs/tutorial/captures.md b/docs/tutorial/captures.md index d555a24f6..42f309448 100644 --- a/docs/tutorial/captures.md +++ b/docs/tutorial/captures.md @@ -325,5 +325,5 @@ of a redirection. [curl]: https://curl.se [header capture]: /docs/capturing-response.md#header-capture [`Location`]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Location -[`-L / --location` option]: /docs/manual-page.md#location +[`-L / --location` option]: /docs/manual.md#location [capture response data]: /docs/capturing-response.md \ No newline at end of file diff --git a/docs/tutorial/chaining-requests.md b/docs/tutorial/chaining-requests.md index 9f89c8ca5..230eea431 100644 --- a/docs/tutorial/chaining-requests.md +++ b/docs/tutorial/chaining-requests.md @@ -276,4 +276,4 @@ for your applications. [JsonPath assert]: /docs/asserting-response.md#jsonpath-assert [JsonPath query]: https://goessner.net/articles/JsonPath/ [query parameter section]: /docs/request.md#query-parameters -[`--test`]: /docs/manual-page.md#test +[`--test`]: /docs/manual.md#test diff --git a/docs/tutorial/debug-tips.md b/docs/tutorial/debug-tips.md index d1a809e9d..2c072bdf8 100644 --- a/docs/tutorial/debug-tips.md +++ b/docs/tutorial/debug-tips.md @@ -436,11 +436,11 @@ The web interface of mitmproxy allows you to inspect, intercept any requests run the returned response to Hurl. -[`-v/--verbose` option]: /docs/manual-page.md#verbose -[`--very-verbose`]: /docs/manual-page.md#very-verbose -[`--verbose`]: /docs/manual-page.md#verbose -[`--interactive` option]: /docs/manual-page.md#interactive -[`-i/--include` option]: /docs/manual-page.md#include -[`--to-entry` option]: /docs/manual-page.md#to-entry +[`-v/--verbose` option]: /docs/manual.md#verbose +[`--very-verbose`]: /docs/manual.md#very-verbose +[`--verbose`]: /docs/manual.md#verbose +[`--interactive` option]: /docs/manual.md#interactive +[`-i/--include` option]: /docs/manual.md#include +[`--to-entry` option]: /docs/manual.md#to-entry [mitmproxy]: https://mitmproxy.org -[`-x/--proxy` option]: /docs/manual-page.md#proxy +[`-x/--proxy` option]: /docs/manual.md#proxy diff --git a/docs/tutorial/your-first-hurl-file.md b/docs/tutorial/your-first-hurl-file.md index bf56924b7..3d1d04941 100644 --- a/docs/tutorial/your-first-hurl-file.md +++ b/docs/tutorial/your-first-hurl-file.md @@ -225,5 +225,5 @@ We're going to see in the next section how to improve our tests while keeping it [response description]: /docs/response.md [`500 Internal Server Error`]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500 [`200 OK`]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/200 -[`--test`]: /docs/manual-page.md#test +[`--test`]: /docs/manual.md#test [curl]: https://curl.se \ No newline at end of file diff --git a/packages/hurl/README.md b/packages/hurl/README.md index 932d8f4a8..5e88c9934 100644 --- a/packages/hurl/README.md +++ b/packages/hurl/README.md @@ -969,10 +969,10 @@ Please follow the [contrib on Windows section]. [`Authorization` header]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Authorization [Hurl tests suite]: https://github.com/Orange-OpenSource/hurl/tree/master/integration/tests_ok [Authorization]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Authorization -[`-u/--user` option]: https://hurl.dev/docs/manual-page.html#user +[`-u/--user` option]: https://hurl.dev/docs/manual.html#user [curl]: https://curl.se [entry]: https://hurl.dev/docs/entry.html -[`--test` option]: https://hurl.dev/docs/manual-page.html#test +[`--test` option]: https://hurl.dev/docs/manual.html#test [GitHub]: https://github.com/Orange-OpenSource/hurl [hurl-1.6.1-win64.zip]: https://github.com/Orange-OpenSource/hurl/releases/download/1.6.1/hurl-1.6.1-win64.zip [hurl-1.6.1-win64-installer.exe]: https://github.com/Orange-OpenSource/hurl/releases/download/1.6.1/hurl-1.6.1-win64-installer.exe