Orange-OpenSource/hurl
1
1
Fork 0
mirror of https://github.com/Orange-OpenSource/hurl.git synced 2024-12-25 20:12:14 +03:00
Code Issues Packages Projects Releases Wiki Activity
9f81b10d38
hurl/docs
History
Tim Eggert 34137c0e0d
feat: introduce curl --path-as-is option
2023-06-22 10:02:06 +02:00
..
assets Add timings explanation in request doc. 2023-06-21 16:50:27 +02:00
manual Upgrade Hurl version to 4.0.0 due to runner::run API change. 2023-06-01 17:26:15 +02:00
spec Add missing section 2023-06-19 12:20:52 +02:00
tutorial Add timings explanation in request doc. 2023-06-21 16:50:27 +02:00
asserting-response.md Fix Hurl snippet. 2023-06-05 16:09:44 +00:00
capturing-response.md Update docs with certificate. 2023-05-03 11:56:20 +02:00
entry.md Update docs for Hurl 2.0.0. 2023-01-25 11:26:30 +01:00
filters.md Update doc on toDate. 2023-06-01 17:16:08 +02:00
frequently-asked-questions.md Update hurlfmt FAQ. 2023-06-01 17:16:08 +02:00
grammar.md Update docs. 2023-04-17 18:05:07 +02:00
home.md Fix doc typos. 2023-06-01 17:15:15 +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 Update version to 3.0.1 2023-06-01 15:59:52 +02:00
license.md Add licence.md in docs. 2022-06-05 17:33:06 +02:00
manual.md feat: introduce curl --path-as-is option 2023-06-22 10:02:06 +02:00
README.md Rename manual-page.md to manual.md 2022-09-02 15:39:24 +02:00
request.md feat: introduce curl --path-as-is option 2023-06-22 10:02:06 +02:00
response.md Add timings explanation in request doc. 2023-06-21 16:50:27 +02:00
running-tests.md Add timings explanation in request doc. 2023-06-21 16:50:27 +02:00
samples.md Fix doc typos. 2023-06-01 17:15:15 +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