Orange-OpenSource/hurl
1
1
Fork 0
mirror of https://github.com/Orange-OpenSource/hurl.git synced 2024-09-11 05:35:53 +03:00
Code Issues Packages Projects Releases Wiki Activity
d986521885
hurl/docs
History
jcamiel d986521885
Fix minor typo on docs.
2022-08-28 23:26:11 +02:00
..
assets/img Import of the canonical docs (raw Markdown, without ant Jekyll specificities.) 2022-06-01 10:34:33 +02:00
man Minor docs change. 2022-08-17 19:13:50 +02:00
spec Add max-redirs entry option. 2022-08-16 12:09:33 +02:00
tutorial Update tutorial's snippets. 2022-08-23 18:36:47 +02:00
asserting-response.md Add doc on Xml namespaces. 2022-08-19 18:02:15 +02:00
capturing-response.md Remove duplicate line in snippet. 2022-06-06 22:29:40 +02:00
entry.md Update shell Hurl snippets with colored output. 2022-08-17 18:30:59 +02:00
frequently-asked-questions.md Update shell Hurl snippets with colored output. 2022-08-17 18:30:59 +02:00
grammar.md Delete legacy grammar. 2022-06-20 19:16:57 +02:00
home.md Update READMEs 2022-06-13 09:04:29 +02:00
hurl-file.md Fix typo: somment --> comment 2022-06-23 20:24:27 +02:00
index.md Import of the canonical docs (raw Markdown, without ant Jekyll specificities.) 2022-06-01 10:34:33 +02:00
installation.md Fix minor typo on docs. 2022-08-28 23:26:11 +02:00
license.md Add licence.md in docs. 2022-06-05 17:33:06 +02:00
man-page.md Minor docs change. 2022-08-17 19:13:50 +02:00
README.md Update man and document documentation generation. 2022-08-16 14:27:20 +02:00
request.md Update snippet with compressed option. 2022-08-18 20:36:52 +02:00
response.md Import of the canonical docs (raw Markdown, without ant Jekyll specificities.) 2022-06-01 10:34:33 +02:00
running-tests.md Update tutorial's snippets. 2022-08-23 18:36:47 +02:00
samples.md Fix minor typo on docs. 2022-08-28 23:26:11 +02:00
templates.md Import of the canonical docs (raw Markdown, without ant Jekyll specificities.) 2022-06-01 10:34:33 +02: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 make modifications to https://hurl.dev, you can make a PR in this repo.

Man Page

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

docs/man/hurl.md => docs/man/hurl.1
docs/man/hurl.md => docs/man-page.md

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

READMEs

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

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

Scripts

  1. generate man pages
  2. generate <hurl.dev> man page
  3. generate GitHub README
  4. generate crates.io README
$ python3 bin/release/gen_manpage.py docs/man/hurl.md > docs/man/hurl.1
$ python3 bin/release/gen_manpage.py docs/man/hurlfmt.md > docs/man/hurlfmt.1
$ python3 bin/docs/build_man_md.py docs/man/hurl.md > docs/man-page.md
$ python3 bin/docs/build_readme.py github > README.md
$ python3 bin/docs/build_readme.py crates > packages/hurl/README.md