Orange-OpenSource/hurl
1
1
Fork 0
mirror of https://github.com/Orange-OpenSource/hurl.git synced 2024-11-23 20:12:09 +03:00
Code Issues Packages Projects Releases Wiki Activity
d9afd0e859
hurl/docs
History
Radek Benkel d9afd0e859
Add Alpine required packages info to build from sources
2023-11-04 00:04:29 +01:00
..
assets Add GitLab CI/CD tutorial. 2023-08-08 15:12:32 +00:00
manual Synchronise manual with http1.0, http1.1, http2, http3, ipv4 and ipv6 options. 2023-10-19 13:39:18 +00:00
spec Add spec for runner 2023-10-19 14:50:40 +02:00
tutorial spelling: javascript 2023-09-29 09:08:13 +02:00
asserting-response.md Update docs with HTTP/3 2023-10-21 19:34:42 +02:00
capturing-response.md spelling: javascript 2023-09-29 09:08:13 +02:00
entry.md Update docs for 4.0.0 2023-06-28 15:19:55 +00:00
filters.md Update docs with xpath filter. 2023-06-30 14:19:16 +02:00
frequently-asked-questions.md spelling: javascript 2023-09-29 09:08:13 +02:00
grammar.md Update generated HTML grammar 2023-10-14 21:29:55 +00:00
home.md Work on img docs. 2023-10-21 18:27:53 +02:00
hurl-file.md Update docs for Hurl 2.0.0. 2023-01-25 11:26:30 +01:00
index.md Rename manual-page.md to manual.md 2022-09-02 15:39:24 +02:00
installation.md Add Alpine required packages info to build from sources 2023-11-04 00:04:29 +01:00
license.md Add licence.md in docs. 2022-06-05 17:33:06 +02:00
manual.md Synchronise manual with http1.0, http1.1, http2, http3, ipv4 and ipv6 options. 2023-10-19 13:39:18 +00:00
README.md Rename manual-page.md to manual.md 2022-09-02 15:39:24 +02:00
request.md spelling: neither 2023-09-29 09:08:13 +02:00
response.md Update tutorial with Movies Box. 2023-08-04 16:59:14 +02:00
running-tests.md Fix link. 2023-09-20 13:14:25 +00:00
samples.md Update docs with HTTP/3 2023-10-21 19:34:42 +02:00
templates.md Fix variables-file example 2023-02-04 20:37:14 +09:00

README.md

Hurl Documentation

This directory is the canonical source for Hurl documentation. The site https://hurl.dev, powered by Jekyll, is generated from it. If you want to modify https://hurl.dev, you can make a PR in this repo.

Manual Page

The canonical source for the Hurl manual pages is at https://github.com/Orange-OpenSource/hurl/tree/master/docs/manual. The markdown files hurl.md and hurlfmt.md are used :

Dependencies:

docs/manual/hurl.md => docs/manual/hurl.1
docs/manual/hurl.md => docs/manual.md

docs/manual/hurlfmt.md => docs/manual/hurlfmt.1

READMEs

GitHub README and crates.io README are generated from the canonical docs.

Dependencies:

docs/*.md => README.md
docs/*.md => packages/hurl/README.md

Scripts

  1. generate manual
  2. generate <hurl.dev> manual
  3. generate GitHub README
  4. generate crates.io README
$ 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.md
$ python3 bin/docs/build_readme.py github > README.md
$ python3 bin/docs/build_readme.py crates > packages/hurl/README.md