Orange-OpenSource/hurl
1
1
Fork 0
mirror of https://github.com/Orange-OpenSource/hurl.git synced 2024-11-23 09:44:22 +03:00
Code Issues Packages Projects Releases Wiki Activity
e060cf7db5
hurl/docs
History
jcamiel e060cf7db5
Update parallel design doc.
2024-01-23 15:43:12 +00:00
..
assets Add GitLab CI/CD tutorial. 2023-08-08 15:12:32 +00:00
manual Generate hurlfmt options source/doc from spec 2024-01-22 11:29:37 +00:00
spec Update parallel design doc. 2024-01-23 15:43:12 +00:00
tutorial Fix CSS class for light/dark themes. 2024-01-10 17:11:49 +01:00
asserting-response.md Update doc for 4.2.0 2024-01-10 17:13:46 +01:00
capturing-response.md Update doc for 4.2.0 2024-01-10 17:13:46 +01:00
entry.md Update doc for 4.2.0 2024-01-10 17:13:46 +01:00
filters.md Update doc for 4.2.0 2024-01-10 17:13:46 +01:00
frequently-asked-questions.md spelling: javascript 2023-09-29 09:08:13 +02:00
grammar.md Add --netrc, --netrc-file and --netrc-optional options 2024-01-23 12:32:14 +00:00
home.md Update doc for 4.2.0 2024-01-10 17:13:46 +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 Create 4.2.0 release 2024-01-11 15:57:38 +01:00
license.md Add licence.md in docs. 2022-06-05 17:33:06 +02:00
manual.md Update doc for 4.2.0 2024-01-10 17:13:46 +01:00
README.md Rename manual-page.md to manual.md 2022-09-02 15:39:24 +02:00
request.md Add delay and skip option in samples. 2024-01-15 16:55:23 +01:00
response.md Update doc for 4.2.0 2024-01-10 17:13:46 +01:00
running-tests.md Fix link. 2023-09-20 13:14:25 +00:00
samples.md Add delay and skip option in samples. 2024-01-15 16:55:23 +01:00
templates.md Update doc for 4.2.0 2024-01-10 17:13: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
$ 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