mirror
/
hurl
mirror of https://github.com/Orange-OpenSource/hurl
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
hurl/docs
History
hurl-bot f76e2476e5
Update hurl version to 7.0.0-SNAPSHOT 		2025-04-24 13:47:43 +00:00
..
assets Update poster for Hurl demo. 2024-08-09 13:11:18 +02:00
manual Update hurl version to 7.0.0-SNAPSHOT 2025-04-24 13:47:43 +00:00
spec Add date comparison predicate and update grammar 2025-04-09 09:38:06 +00:00
standalone Update docs for 6.1.0 2025-03-12 09:39:08 +01:00
tutorial Update doc for 6.1.0 2025-03-07 17:59:46 +01:00
README.md Update Archlinux installation. 2024-04-30 13:26:50 +02:00
asserting-response.md Small doc typos. 2025-03-26 09:31:12 +01:00
capturing-response.md Update docs for 6.1.0 2025-03-12 09:39:08 +01:00
entry.md Update doc for 6.1.0 2025-03-07 17:59:46 +01:00
filters.md Update docs for base64 filters 2025-04-02 10:59:44 +00:00
frequently-asked-questions.md Use PUT instead of POST as --data implies making a POST request. 2024-12-15 19:55:32 +00:00
grammar.md Add date comparison predicate and update grammar 2025-04-09 09:38:06 +00:00
home.md Update docs for 6.1.0 2025-03-12 09:39:08 +01:00
hurl-file.md Update doc for 4.2.0 2024-01-10 17:13:46 +01:00
index.md Rename manual-page.md to manual.md 2022-09-02 15:39:24 +02:00
installation.md Fix ip sample and cargo install documentation. 2025-03-25 05:06:32 +00:00
license.md Add licence.md in docs. 2022-06-05 17:33:06 +02:00
manual.md Update doc for 6.1.0 2025-03-07 17:59:46 +01:00
request.md Update doc for 6.1.0 2025-03-07 17:59:46 +01:00
response.md Update docs. 2024-08-20 17:30:49 +02:00
running-tests.md Update docs. 2024-08-22 13:03:44 +02:00
samples.md Fix ip sample and cargo install documentation. 2025-03-25 05:06:32 +00:00
templates.md Update doc for 6.1.0 2025-03-07 17:59:46 +01: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
$ cd ..
$ 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