QA » openQA Project » openQA Tests

I'm up for mentoring somebody with this task :), there's already things that allow to publish a webpage from pod to html or other formats :), problem is writing the documentation for lib utils I guess, but that can be a second step.

This ticket is about creating html from the json data my crawler generates from the lib/utils files, in general I would assume that documenting each function with pod would be easier, but until this is done we need to rely on what we have

We discussed this as well yesterday in the retrospective. The topic was on the retrospective document for very long so I decided (and asked QSF-u during sprint planning 2019-01-16) to move the notes here:

• Update documentation
  • openQA, lib/utils functions
  • We could start forcing that all newly introduced methods
  • We need some automated check
  • riafarov will create tickets for related activities

@riafarov have you created tickets already and/or can you link them accordingly?

@okurz: it's a bit naive to assume that I will find comments in the tickets I'm not even watching. I honestly do not remember if I got any tickets created. And I'm not even sure that we need any except this one.

hm, don't know. Maybe I mentioned the ticket to you in IRC as we discussed the topic in the retrospective? But I agree that we do not need more tickets. This one suffices.

Haven't we agreed on using POD together with @szarate ?

Yes, we did agree to do POD. Anybody wants to work together on this by the end of next week? :)

I would like to help you

As discussed with szarate:

• Mirror generation mechanism from openqa repo
• use Github Pages on os-autoinst-distri-opensuse

Mechanism for openqa:
https://github.com/os-autoinst/openQA/blob/master/script/generate-documentation

We should use pod2html

Set up own testing environment, except authentication everything works fine so far
Not sure how to work around the authentication problem

As discussed with szarate we need to use gh-branches for github pages, as pushing to the master is blocked for os-autoinst-distri-opensuse

The generation of the documentation now works: https://travis-ci.org/DrMullings/os-autoinst-distri-opensuse

`before_deploy:

• script/generateUtilsDoc.sh deploy: provider: pages skip_cleanup: true github_token: $GITHUB_TOKEN local-dir: $TRAVIS_BUILD_DIR/docs/ on: branch: master target_branch: gh-pages`

When script/generateDocUtils.sh calls pod2html, this should be fairly simple to extend
Now we need to format the HTML more beautiful and also create a good index.html.
Additionally we need to take care of the configuration of the original os-autoinst-distri-opensuse repo

Created:
https://github.com/os-autoinst/os-autoinst-distri-opensuse/pull/7300

Now waiting for both PRs to be merged, then this can be closed

Removing
condition: [ "$(git -C $TRAVIS_BUILD_DIR diff 'lib/utils.pm')" ]
For testing reasons

The docs can be found here:
https://os-autoinst.github.io/os-autoinst-distri-opensuse/utils