-
Notifications
You must be signed in to change notification settings - Fork 42
docs: generate a website with the specs #261
Conversation
💔 Tests FailedExpand to view the summary
Build stats
Test stats 🧪
Test errorsExpand to view the tests failures
Steps errorsExpand to view the steps failures
Log outputExpand to view the last 100 lines of log output
|
The errors are not related, as the agent structure has changed: see elastic/beats#20986 |
* docs: generate a website with the specs * docs: update docs * fix: close jenkinsfile blocks properly * chore: move stage to run it before the E2E tests * fix: remove interactive command line * fix: typo in URL * chore: use a flatten structure for archived files Co-authored-by: Victor Martinez <[email protected]> * chore: login to Docker to pull docs image * fix: use proper user in container * fix: proper location for post block Co-authored-by: Victor Martinez <[email protected]>
* docs: generate a website with the specs * docs: update docs * fix: close jenkinsfile blocks properly * chore: move stage to run it before the E2E tests * fix: remove interactive command line * fix: typo in URL * chore: use a flatten structure for archived files Co-authored-by: Victor Martinez <[email protected]> * chore: login to Docker to pull docs image * fix: use proper user in container * fix: proper location for post block Co-authored-by: Victor Martinez <[email protected]> Co-authored-by: Victor Martinez <[email protected]>
excellent indeed! |
What does this PR do?
This PR generates a website with the HTML representation of the gherkin feature files, so that it's easier to consume them.
The generation is done using picklesdoc (http://docs.picklesdoc.com), a Windows application that parses Gherkin files and generates an HTML output. We have wrapped the Windows binary into a Docker image (using mono), and pushing this image to our registry:
Because this image uses a Windows binary, we wrapped the execution into a Make target, which massages the output to remove bad slashes in the generated paths (i.e. the root index.html file).
Why is it important?
We want to provide an easy way to consume the specification, shareable and understandable by anybody in the team, and HTML is easy to read.
Checklist
make notice
in the proper directory)Author's Checklist
How to test this PR locally
$ cd e2e $ make build-docs
A website will be generate under the
docs
directoryRelated issues
Screenshots
Sample website:
Logs
Follow-ups
The templates are embedded into the binary, need to research about customising the HTML templates.
We also need to put the Dockerfile for the picklesdoc image in a repo.