Rename manual-page.md to manual.md

This commit is contained in:
jcamiel 2022-09-02 14:45:54 +02:00
parent 2e3eaca3d4
commit 948f1e2065
No known key found for this signature in database
GPG Key ID: 07FF11CFD55356CC
24 changed files with 55 additions and 51 deletions

View File

@ -969,10 +969,10 @@ Please follow the [contrib on Windows section].
[`Authorization` header]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Authorization [`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 [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 [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 [curl]: https://curl.se
[entry]: https://hurl.dev/docs/entry.html [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 [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.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 [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

View File

@ -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. This tool takes the Hurl manual file as a first argument.
Examples: 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 import re

View File

@ -75,7 +75,7 @@ def main(dest: str) -> int:
home_md.remove_nodes(logo_nodes) home_md.remove_nodes(logo_nodes)
samples_md = parse_markdown(text=Path("docs/samples.md").read_text()) 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()) installation_md = parse_markdown(text=Path("docs/installation.md").read_text())

View File

@ -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. This tool takes the Hurl man Markdown source file as a first argument.
Examples: 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 import sys

View File

@ -3,8 +3,8 @@ set -e
rm -rf target/man rm -rf target/man
mkdir -p 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/manual/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/hurlfmt.md > target/man/hurlfmt.1
gzip -n -9 target/man/hurl.1 gzip -n -9 target/man/hurl.1
gzip -n -9 target/man/hurlfmt.1 gzip -n -9 target/man/hurlfmt.1

View File

@ -12,7 +12,7 @@
<requireLicenseAcceptance>false</requireLicenseAcceptance> <requireLicenseAcceptance>false</requireLicenseAcceptance>
<projectSourceUrl>https://github.com/Orange-OpenSource/hurl</projectSourceUrl> <projectSourceUrl>https://github.com/Orange-OpenSource/hurl</projectSourceUrl>
<packageSourceUrl>https://github.com/Orange-OpenSource/hurl/tree/master/contrib/windows/windows_package_managers/chocolatey/hurl</packageSourceUrl> <packageSourceUrl>https://github.com/Orange-OpenSource/hurl/tree/master/contrib/windows/windows_package_managers/chocolatey/hurl</packageSourceUrl>
<docsUrl>https://hurl.dev/docs/manual-page.html</docsUrl> <docsUrl>https://hurl.dev</docsUrl>
<bugTrackerUrl>https://github.com/Orange-OpenSource/hurl/issues</bugTrackerUrl> <bugTrackerUrl>https://github.com/Orange-OpenSource/hurl/issues</bugTrackerUrl>
<tags>hurl curl http https cli http-client testing-tool integration-tool automation-tool api-testing cross-platform</tags> <tags>hurl curl http https cli http-client testing-tool integration-tool automation-tool api-testing cross-platform</tags>
<summary>Hurl is a command line tool that runs HTTP requests defined in a simple plain text format</summary> <summary>Hurl is a command line tool that runs HTTP requests defined in a simple plain text format</summary>

View File

@ -9,11 +9,13 @@ The canonical source for the Hurl manual pages is at <https://github.com/Orange-
The markdown files [`hurl.md`] and [`hurlfmt.md`] are used : The markdown files [`hurl.md`] and [`hurlfmt.md`] are used :
- to generate manual pages [`hurl.1`] and [`hurlfmt.1`] - to generate manual pages [`hurl.1`] and [`hurlfmt.1`]
- to generate Markdown documentation page [`manual-page.md`] for <https://hurl.dev> - to generate Markdown documentation page [`manual.md`] for <https://hurl.dev>
Dependencies:
``` ```
docs/manual/hurl.md => docs/manual/hurl.1 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 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. [GitHub README] and [crates.io README] are generated from the canonical docs.
Dependencies:
``` ```
docs/*.md => README.md docs/*.md => README.md
docs/*.md => packages/hurl/README.md docs/*.md => packages/hurl/README.md
@ -37,7 +41,7 @@ docs/*.md => packages/hurl/README.md
```bash ```bash
$ python3 bin/release/gen_manpage.py docs/manual/hurl.md > docs/manual/hurl.1 $ 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/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 github > README.md
$ python3 bin/docs/build_readme.py crates > packages/hurl/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 [`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 [`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 [`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 [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 [crates.io README]: https://github.com/Orange-OpenSource/hurl/blob/master/packages/hurl/README.md

View File

@ -671,7 +671,7 @@ of all file nodes.
[JSON]: https://www.json.org [JSON]: https://www.json.org
[XML]: https://en.wikipedia.org/wiki/XML [XML]: https://en.wikipedia.org/wiki/XML
[Base64]: https://en.wikipedia.org/wiki/Base64 [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 [`count`]: /docs/capturing-response.md#count-subquery
[Javascript-like Regular expression syntax]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions [Javascript-like Regular expression syntax]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions
[MD5]: https://en.wikipedia.org/wiki/MD5 [MD5]: https://en.wikipedia.org/wiki/MD5

View File

@ -326,7 +326,7 @@ cats_size: jsonpath "$.cats" count
[CSRF tokens]: https://en.wikipedia.org/wiki/Cross-site_request_forgery [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 [templates]: /docs/templates.md
[`Set-Cookie`]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie [`Set-Cookie`]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie
[XPath]: https://en.wikipedia.org/wiki/XPath [XPath]: https://en.wikipedia.org/wiki/XPath

View File

@ -110,7 +110,7 @@ HTTP/* 200
[response]: /docs/response.md [response]: /docs/response.md
[capture values]: /docs/capturing-response.md [capture values]: /docs/capturing-response.md
[add asserts to HTTP responses]: /docs/asserting-response.md [add asserts to HTTP responses]: /docs/asserting-response.md
[`--location`]: /docs/manual-page.md#location [`--location`]: /docs/manual.md#location
[`--max-redirs`]: /docs/manual-page.md#max-redirs [`--max-redirs`]: /docs/manual.md#max-redirs
[Options]: /docs/man-page.html#options [Options]: /docs/manual.md#options
[`--location` option]: /docs/man-page.html#location [`--location` option]: /docs/manual.md#location

View File

@ -9,7 +9,7 @@
## [Resources] ## [Resources]
[Getting Started]: /docs/manual-page.md [Getting Started]: /docs/manual.md
[File Format]: /docs/hurl-file.md [File Format]: /docs/hurl-file.md
[Tutorial]: /docs/tutorial/your-first-hurl-file.md [Tutorial]: /docs/tutorial/your-first-hurl-file.md
[Resources]: /docs/license.md [Resources]: /docs/license.md

View File

@ -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 .SH NAME
hurl - run and test HTTP requests. hurl - run and test HTTP requests.

View File

@ -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 .SH NAME
hurlfmt - format Hurl files hurlfmt - format Hurl files

View File

@ -525,17 +525,17 @@ very-verbose: true # allow more verbose output
[multiline string body]: #multiline-string-body [multiline string body]: #multiline-string-body
[body section]: #body [body section]: #body
[multipart/form-data on MDN]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/POST [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 [JSON]: https://www.json.org
[XML]: https://en.wikipedia.org/wiki/XML [XML]: https://en.wikipedia.org/wiki/XML
[Base64]: https://en.wikipedia.org/wiki/Base64 [Base64]: https://en.wikipedia.org/wiki/Base64
[hexadecimal string]: #hex-body [hexadecimal string]: #hex-body
[included file]: #file-body [included file]: #file-body
[`--file-root` option]: /docs/manual-page.md#file-root [`--file-root` option]: /docs/manual.md#file-root
[`-u/--user` option]: /docs/manual-page.md#user [`-u/--user` option]: /docs/manual.md#user
[Hurl unicode literals \u{20}]: /docs/hurl-file.md#special-character-in-strings [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 [Authorization]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Authorization
[`--location`]: /docs/man-page.html#location [`--location`]: /docs/manual.md#location
[`--verbose`]: /docs/man-page.html#verbose [`--verbose`]: /docs/manual.md#verbose
[`--insecure`]: /docs/man-page.html#insecure [`--insecure`]: /docs/manual.md#insecure

View File

@ -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 [capture value from headers, body]: /docs/capturing-response.md
[add assert on status code, body or headers]: /docs/asserting-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 [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 [`Accept-Encoding`]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Encoding

View File

@ -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. You will find a detail description in the [Injecting Variables] section of the doc.
[`--output /dev/null`]: /docs/manual-page.md#output [`--output /dev/null`]: /docs/manual.md#output
[`--test`]: /docs/manual-page.md#test [`--test`]: /docs/manual.md#test
[`--report-html HTML_DIR`]: /docs/manual-page.md#report-html [`--report-html HTML_DIR`]: /docs/manual.md#report-html
[`--test` option]: /docs/manual-page.md#test [`--test` option]: /docs/manual.md#test
[`--glob` option]: /docs/manual-page.md#glob [`--glob` option]: /docs/manual.md#glob
[`--variable` option]: /docs/manual-page.md#variable [`--variable` option]: /docs/manual.md#variable
[`--variables-file` option]: /docs/manual-page.md#variables-file [`--variables-file` option]: /docs/manual.md#variables-file
[Injecting Variables]: /docs/templates.md#injecting-variables [Injecting Variables]: /docs/templates.md#injecting-variables

View File

@ -380,7 +380,7 @@ bytes startsWith hex,efbbbf;
[`Authorization` header]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Authorization [`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 [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 [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 [curl]: https://curl.se
[entry]: /docs/entry.md [entry]: /docs/entry.md
[`--test` option]: /docs/manual-page.md#test [`--test` option]: /docs/manual.md#test

View File

@ -187,8 +187,8 @@ Resulting in a PUT request with the following JSON body:
} }
``` ```
[`--variable` option]: /docs/manual-page.md#variable [`--variable` option]: /docs/manual.md#variable
[`--variables-file` option]: /docs/manual-page.md#variables-file [`--variables-file` option]: /docs/manual.md#variables-file
[CSRF token]: https://en.wikipedia.org/wiki/Cross-site_request_forgery [CSRF token]: https://en.wikipedia.org/wiki/Cross-site_request_forgery
[JSONPath]: /docs/asserting-response.md#jsonpath-assert [JSONPath]: /docs/asserting-response.md#jsonpath-assert
[JSON body]: /docs/request.md#json-body [JSON body]: /docs/request.md#json-body

View File

@ -325,5 +325,5 @@ of a redirection.
[curl]: https://curl.se [curl]: https://curl.se
[header capture]: /docs/capturing-response.md#header-capture [header capture]: /docs/capturing-response.md#header-capture
[`Location`]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Location [`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 [capture response data]: /docs/capturing-response.md

View File

@ -276,4 +276,4 @@ for your applications.
[JsonPath assert]: /docs/asserting-response.md#jsonpath-assert [JsonPath assert]: /docs/asserting-response.md#jsonpath-assert
[JsonPath query]: https://goessner.net/articles/JsonPath/ [JsonPath query]: https://goessner.net/articles/JsonPath/
[query parameter section]: /docs/request.md#query-parameters [query parameter section]: /docs/request.md#query-parameters
[`--test`]: /docs/manual-page.md#test [`--test`]: /docs/manual.md#test

View File

@ -436,11 +436,11 @@ The web interface of mitmproxy allows you to inspect, intercept any requests run
the returned response to Hurl. the returned response to Hurl.
[`-v/--verbose` option]: /docs/manual-page.md#verbose [`-v/--verbose` option]: /docs/manual.md#verbose
[`--very-verbose`]: /docs/manual-page.md#very-verbose [`--very-verbose`]: /docs/manual.md#very-verbose
[`--verbose`]: /docs/manual-page.md#verbose [`--verbose`]: /docs/manual.md#verbose
[`--interactive` option]: /docs/manual-page.md#interactive [`--interactive` option]: /docs/manual.md#interactive
[`-i/--include` option]: /docs/manual-page.md#include [`-i/--include` option]: /docs/manual.md#include
[`--to-entry` option]: /docs/manual-page.md#to-entry [`--to-entry` option]: /docs/manual.md#to-entry
[mitmproxy]: https://mitmproxy.org [mitmproxy]: https://mitmproxy.org
[`-x/--proxy` option]: /docs/manual-page.md#proxy [`-x/--proxy` option]: /docs/manual.md#proxy

View File

@ -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 [response description]: /docs/response.md
[`500 Internal Server Error`]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500 [`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 [`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 [curl]: https://curl.se

View File

@ -969,10 +969,10 @@ Please follow the [contrib on Windows section].
[`Authorization` header]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Authorization [`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 [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 [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 [curl]: https://curl.se
[entry]: https://hurl.dev/docs/entry.html [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 [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.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 [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