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

documentation html syntax issues #3000

Open
sandrobonazzola opened this issue Jun 24, 2022 · 2 comments
Open

documentation html syntax issues #3000

sandrobonazzola opened this issue Jun 24, 2022 · 2 comments

Comments

@sandrobonazzola
Copy link
Member

Description of the problem

checking HTML syntax on the website, shows:

"/documentation/assembly-Setting_up_a_gpu_on_a_vm/assembly_nvidia_gpu_passthrough.html":308.24-308.148: error: Bad value "{URL_virt_product_docs}{URL_format}virtual_machine_management_guide/index#Adding_Host_Devices_to_a_Virtual_Machine" for attribute "href" on element "a": Illegal character in path segment: "{" is not allowed.
"/documentation/assembly-Setting_up_a_gpu_on_a_vm/assembly_nvidia_gpu_passthrough.html":464.71-464.199: error: Bad value "{URL_virt_product_docs}{URL_format}virtual_machine_management_guide/index#Removing_Host_Devices_from_a_Virtual_Machine" for attribute "href" on element "a": Illegal character in path segment: "{" is not allowed.
"/documentation/administration_guide/index.html":9572.1-9572.30: error: Element "h7" not allowed as child of element "div" in this context. (Suppressing further errors from this subtree.)
"/documentation/administration_guide/index.html":10869.1-10869.47: error: Element "h7" not allowed as child of element "div" in this context. (Suppressing further errors from this subtree.)
"/documentation/administration_guide/index.html":10963.1-10963.41: error: Element "h7" not allowed as child of element "div" in this context. (Suppressing further errors from this subtree.)
"/documentation/administration_guide/index.html":11086.1-11086.39: error: Element "h7" not allowed as child of element "div" in this context. (Suppressing further errors from this subtree.)
"/documentation/doc-REST_API_Guide/index.html":79113.25-79113.150: error: Bad value "{URL_virt_product_docs}{URL_format}virtual_machine_management_guide/index#Installing_Guest_Agents_and_Drivers_Linux" for attribute "href" on element "a": Illegal character in path segment: "{" is not allowed.
"/documentation/doc-REST_API_Guide/index.html":83971.25-83971.150: error: Bad value "{URL_virt_product_docs}{URL_format}virtual_machine_management_guide/index#Installing_Guest_Agents_and_Drivers_Linux" for attribute "href" on element "a": Illegal character in path segment: "{" is not allowed.
"/documentation/doc-REST_API_Guide/model.html":75855.25-75855.150: error: Bad value "{URL_virt_product_docs}{URL_format}virtual_machine_management_guide/index#Installing_Guest_Agents_and_Drivers_Linux" for attribute "href" on element "a": Illegal character in path segment: "{" is not allowed.
"/documentation/doc-REST_API_Guide/model.html":80713.25-80713.150: error: Bad value "{URL_virt_product_docs}{URL_format}virtual_machine_management_guide/index#Installing_Guest_Agents_and_Drivers_Linux" for attribute "href" on element "a": Illegal character in path segment: "{" is not allowed.

Type of problem?

Documentation issue

Help needed from @apinnick

@apinnick apinnick self-assigned this Jun 26, 2022
@apinnick
Copy link
Contributor

@sandrobonazzola
I am not sure why the attributes are not rendering for some docs but rendering for others. Can you point me to the log?

@sandrobonazzola
Copy link
Member Author

$ podman run -v $(pwd):/srv/site:Z -p 4000:4000 -p 35729:35729 -ti ovirt-site build
+ export DEBUG=true
+ DEBUG=true
+ bundle config --local path vendor/bundle
+ bundle install --quiet
Running `bundle install --quiet` with bundler 2.1.4
+ exec bundle exec jekyll build
Configuration file: /srv/site/_config.yml
            Source: source
       Destination: /srv/site/_site
 Incremental build: disabled. Enable with --incremental
      Generating... 
asciidoctor: ERROR: model.adoc: line 3123: invalid part, must have at least one section (e.g., chapter, appendix, etc.)
asciidoctor: WARNING: common/upgrade/proc-Replacing_SHA-1_Certificates_with_SHA-256_Certificates.adoc: line 72: no callout found for <1>
asciidoctor: WARNING: common/upgrade/proc-Replacing_SHA-1_Certificates_with_SHA-256_Certificates.adoc: line 179: no callout found for <1>
asciidoctor: WARNING: common/upgrade/proc-Replacing_SHA-1_Certificates_with_SHA-256_Certificates.adoc: line 72: no callout found for <1>
asciidoctor: WARNING: common/upgrade/proc-Replacing_SHA-1_Certificates_with_SHA-256_Certificates.adoc: line 179: no callout found for <1>
asciidoctor: WARNING: common/upgrade/proc-Replacing_SHA-1_Certificates_with_SHA-256_Certificates.adoc: line 72: no callout found for <1>
asciidoctor: WARNING: common/upgrade/proc-Replacing_SHA-1_Certificates_with_SHA-256_Certificates.adoc: line 179: no callout found for <1>
asciidoctor: ERROR: model.adoc: line 85: level 0 sections can only be used when doctype is book
asciidoctor: ERROR: model.adoc: line 469: level 0 sections can only be used when doctype is book
asciidoctor: ERROR: model.adoc: line 1188: level 0 sections can only be used when doctype is book
asciidoctor: ERROR: model.adoc: line 2225: level 0 sections can only be used when doctype is book
asciidoctor: ERROR: model.adoc: line 3123: level 0 sections can only be used when doctype is book
asciidoctor: ERROR: model.adoc: line 34254: level 0 sections can only be used when doctype is book
asciidoctor: ERROR: model.adoc: line 56401: level 0 sections can only be used when doctype is book
asciidoctor: ERROR: model.adoc: line 56549: level 0 sections can only be used when doctype is book
                    done in 110.868 seconds.

$ python -m venv venv

$ source venv/bin/activate

$ pip install html5validator

$ html5validator --root _site/ | sed "s:${PWD}/::"
"file:_site/documentation/administration_guide/index.html":9558.1-9558.30: error: Element "h7" not allowed as child of element "div" in this context. (Suppressing further errors from this subtree.)
"file:_site/documentation/administration_guide/index.html":10855.1-10855.47: error: Element "h7" not allowed as child of element "div" in this context. (Suppressing further errors from this subtree.)
"file:_site/documentation/administration_guide/index.html":10952.1-10952.41: error: Element "h7" not allowed as child of element "div" in this context. (Suppressing further errors from this subtree.)
"file:_site/documentation/administration_guide/index.html":11075.1-11075.39: error: Element "h7" not allowed as child of element "div" in this context. (Suppressing further errors from this subtree.)
"file:_site/documentation/doc-REST_API_Guide/index.html":81797.25-81797.150: error: Bad value "{URL_virt_product_docs}{URL_format}virtual_machine_management_guide/index#Installing_Guest_Agents_and_Drivers_Linux" for attribute "href" on element "a": Illegal character in path segment: "{" is not allowed.
"file:_site/documentation/doc-REST_API_Guide/index.html":86828.25-86828.150: error: Bad value "{URL_virt_product_docs}{URL_format}virtual_machine_management_guide/index#Installing_Guest_Agents_and_Drivers_Linux" for attribute "href" on element "a": Illegal character in path segment: "{" is not allowed.
"file:_site/documentation/doc-REST_API_Guide/model.html":76983.25-76983.150: error: Bad value "{URL_virt_product_docs}{URL_format}virtual_machine_management_guide/index#Installing_Guest_Agents_and_Drivers_Linux" for attribute "href" on element "a": Illegal character in path segment: "{" is not allowed.
"file:_site/documentation/doc-REST_API_Guide/model.html":82014.25-82014.150: error: Bad value "{URL_virt_product_docs}{URL_format}virtual_machine_management_guide/index#Installing_Guest_Agents_and_Drivers_Linux" for attribute "href" on element "a": Illegal character in path segment: "{" is not allowed.

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

No branches or pull requests

2 participants