orange-opensource / hurl-dev Goto Github PK

View Code? Open in Web Editor NEW

5.0 12.0 11.0 55.79 MB

Hurl specifications and documentation

Home Page: https://hurl.dev

License: Apache License 2.0

Python 32.79% HTML 9.52% Shell 0.96% Ruby 0.10% JavaScript 7.03% SCSS 19.69% CSS 29.91%

hurl-dev's Introduction

Hurl Official Documentation Site

The official documentation site for Hurl.

This repo contains only the documentation and tutorials for Hurl. If you're looking for Hurl source code, please check out https://github.com/Orange-OpenSource/hurl. Please note that the canonical sources for the documentation are on the Hurl repository. This repo uses this doc to build a Jekyll powered documentation site, so it can be seen as a read-only view on the canonical docs.

Contributing

Edits on documentation are done via pull request in the Hurl repository. All docs files are under docs/ repository, in Markdown. Once a pull request is accepted, modifications are automatically published to https://hurl.dev via the publish GitHub action.

Local build

Prerequites

Jekyll
Python 3, with Beautiful Soup 4 package (bs4)

Build

$ cd sites
$ ./build.sh

Run local static site

$ cd sites
$ python3 -m http.server --dir hurl.dev/_site 4000

Run and watch local site

$ cd sites
$ jekyll serve --source hurl.dev --destination hurl.dev/_site

When running with Jekyll, the local built is rerun automatically for each modification. In this mode, Hurl code snippets haven't any syntax coloring.

Scripts

build.sh: uber-script to build <hurl.dev> from scratch
build_anchors.py: add anchors to every HTML tag. Exemple: <h2 id="some-stuff">Some Title</h2> becomes <h2 id="some-stuff"><a href="#some-stuff">Some Title</a></h2>
build_index.py: construct search index (search is entirely done viz Javascript in the browser, without any server apis.)
build_sitemap.py: generate https://hurl.dev/sitemap.txt
deploy.sh: deploy a local build to https://hurl.dev
highlight.py: generate syntax coloring for Hurl snippets
others: utilities

hurl-dev's People

Contributors

Stargazers

Watchers

Forkers

diegosouza isabella232 markus1189 tbolon pixelistik humphd davidbgk cc-cpo susan51531 jcamiel pcdevsecops

hurl-dev's Issues

Header overlaps linked content

This may not be your bug, but it affects your docs.

If I deep link into a section of the docs, for example https://hurl.dev/docs/man-page.html#test, the header at the top sits on top of the --test content, making it impossible to share the link:

Screen.Recording.2022-03-22.at.12.48.22.PM.mov

I think the .doc class needs a larger margin-top in order to compensate.

improve regex documentation

hurl version: 1.2.0

A regex section on the documentation should describe which regex engine is used by hurl (pcre ? perlre ? etc ...) giving some links to official documentation. May be on this empty https://hurl.dev/docs/asserting-response.html#regex-assert section ?

Add check on GitHub README.md

The README on https://github.com/Orange-OpenSource/hurl is generated through hurl.dev documentation. We should add a check before deploying hurl.dev to see if the Hurl GitHub README is up-to-date.

Use hurlfmt for syntax coloring

[doc] document that hurl is available in nix/nixos

Hi,

In the installation section of the website (https://hurl.dev/docs/installation.html), you could say that hurl is avaible in NixOS / Nix:

https://search.nixos.org/packages?channel=21.11&from=0&size=50&sort=relevance&type=packages&query=hurl

A New UI for the Home page of the website

Problem to solve

The current home page of the website seems not up to the mark and usually looks more like a docs page.

Proposal

I propose to build a new UI for the home page. It would contain all the information present in the current homepage , but visually appealing to the users

P.S - I would like to work on it

use operators (==,...)
remove deprecated features (countEquals, ...)
update predicates (https://hurl.dev/docs/asserting-response.html#predicates)
update subquery (https://hurl.dev/docs/capturing-response.html#subquery)

new features:

Add microdata on hurl.dev

See https://httpie.io:

    <meta itemProp="name" content="HTTPie – API testing client that flows with you"/>
    <meta name="description" content="Making APIs simple and intuitive for those building the tools of our time."/>
    <meta property="og:title" content="HTTPie – API testing client that flows with you"/>
    <meta property="og:site_name" content="HTTPie – API testing client that flows with you"/>
    <meta property="og:description" content="Making APIs simple and intuitive for those building the tools of our time."/>
    <meta property="og:type" content="website"/>
    <meta property="og:image" content="https://httpie.io/Images/Share/default.png"/>
    <meta name="twitter:card" content="summary_large_image"/>
    <meta name="twitter:site" content="@httpie"/>
    <meta name="twitter:title" content="HTTPie – API testing client that flows with you"/>
    <meta name="twitter:image" content="https://httpie.io/Images/Share/default.png"/>
    <meta name="twitter:description" content="Making APIs simple and intuitive for those building the tools of our time."/>

Priorize search

Search results have to be sorted by titled pages first, then titled sections and finally words.