Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix documentation #4616

Merged
merged 2 commits into from
Apr 21, 2022
Merged

Fix documentation #4616

merged 2 commits into from
Apr 21, 2022

Conversation

perlpunk
Copy link
Contributor

@perlpunk perlpunk commented Apr 21, 2022

  • Use regular asciidoctor-pdf release
  • Fix doc headings and numbers

Issue: https://progress.opensuse.org/issues/110181

@github-actions
Copy link

github-actions bot commented Apr 21, 2022

Great PR! Please pay attention to the following items before merging:

Files matching docs/*.asciidoc:

  • Consider generating documentation locally to verify it is rendered correctly using tools/generate-documentation

This is an automatically generated QA checklist based on modified files

@baierjan
Copy link
Member

I will leave here the important part from the release notes:

On the compliance front, Asciidoctor PDF 2 will require Ruby 2.7 and JRuby 9.2 at a minimum

docs/Installing.asciidoc Outdated Show resolved Hide resolved
The --pre pulled in version 2.0.0.alpha.1 which has an
incompatibility with Ruby psych

    # /usr/lib64/ruby/gems/2.5.0/gems/asciidoctor-pdf-2.0.0.alpha.1/lib/asciidoctor/pdf/theme_loader.rb line 101
    yaml_data = ::YAML.safe_load data, aliases: true, filename: filename

    # /usr/lib64/ruby/2.5.0/psych.rb line 313
    def self.safe_load yaml, whitelist_classes = [], whitelist_symbols = [], aliases = false, filename = nil, symbolize_names: false

Stacktrace:
    1: from /usr/lib64/ruby/gems/2.5.0/gems/asciidoctor-pdf-2.0.0.alpha.1/lib/asciidoctor/pdf/theme_loader.rb:101:in `load_file'
    /usr/lib64/ruby/2.5.0/psych.rb:313:in `safe_load': unknown keywords: aliases, filename (ArgumentError)

Currently not sure what's wrong with the call.
@mergify mergify bot merged commit c7f8e53 into os-autoinst:master Apr 21, 2022
openqabot pushed a commit to openqabot/openQA that referenced this pull request Apr 22, 2022
commit c7f8e53
Merge: 8cabdc5 ca139e4
Author:     mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
AuthorDate: Thu Apr 21 16:08:17 2022 +0000
Commit:     GitHub <noreply@github.com>
CommitDate: Thu Apr 21 16:08:17 2022 +0000

    Merge pull request os-autoinst#4616 from perlpunk/fix-doc

    Fix documentation
@perlpunk perlpunk deleted the fix-doc branch April 22, 2022 09:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants