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 validation errors and warnings #2766

Merged
merged 2 commits into from
Aug 8, 2024
Merged

fix validation errors and warnings #2766

merged 2 commits into from
Aug 8, 2024

Conversation

mkuznyetsov
Copy link
Contributor

What does this pull request change?

Address errors that happen during the build and validate stage:

asciidoctor: ERROR: next@docs::pdf$administration-guide.adoc: line 5995: discret sections do not support nested sections

For some reason, antora build incorrectly replaces [discrete] tag with [discret#administration-guide:creating-a-telemetry-plugin:::_creating_a_server_that_receives_eventse]. breaking apart the tag at the last character. For now, we could remove the heading, while the cause of this issue is still being determined

WARN (asciidoctor): callout list item index: expected 3, got 1
    file: /__w/che-docs/che-docs/modules/administration-guide/pages/configuring-network-policies.adoc:103
    source: /__w/che-docs/che-docs (branch: main <worktree>)

most of these warnings could be fixed by moving around admonition / delimiter blocks, removing + linebreaks

asciidoctor: WARNING: next@docs::pdf$administration-guide.adoc: line 2484: id assigned to block already in use: installing-che-locally

it appears that there are simply two same ids, that was fixed by changing one of them to match the title

What issues does this pull request fix or reference?

eclipse-che/che#23020

Specify the version of the product this pull request applies to

Pull Request checklist

The author and the reviewers validate the content of this pull request with the following checklist, in addition to the automated tests.

  • Any procedure:
    • Successfully tested.
  • Any page or link rename:
    • The page contains a redirection for the previous URL.
    • Propagate the URL change in:
  • Builds on Eclipse Che hosted by Red Hat.
  • the Validate language on files added or modified step reports no vale warnings.

Signed-off-by: Mykhailo Kuznietsov <mkuznets@redhat.com>
@mkuznyetsov mkuznyetsov requested review from deerskindoll and a team as code owners July 31, 2024 07:22
@mkuznyetsov mkuznyetsov requested a review from svor July 31, 2024 07:22
Copy link

github-actions bot commented Jul 31, 2024

Click here to review and test in web IDE: Contribute

Copy link

github-actions bot commented Jul 31, 2024

🎊 Navigate the preview: https://66b4ce52fb30ed009b68de11--eclipse-che-docs-pr.netlify.app 🎊

Copy link
Contributor

@deerskindoll deerskindoll left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

Copy link
Contributor

@deerskindoll deerskindoll left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@mkuznyetsov
Copy link
Contributor Author

another fixup commit pushed to fix the remaining warning

[12:03:16.088] WARN (asciidoctor): no callout found for <1>
    file: /projects/modules/end-user-guide/pages/starting-a-workspace-from-a-raw-devfile-url.adoc:49
    source: /projects (branch: che-23020 <worktree>)

@mkuznyetsov mkuznyetsov merged commit 9576dee into main Aug 8, 2024
10 checks passed
@mkuznyetsov mkuznyetsov deleted the che-23020 branch August 8, 2024 13:56
mkuznyetsov added a commit that referenced this pull request Aug 13, 2024
* fix validation errors and warnings

Signed-off-by: Mykhailo Kuznietsov <mkuznets@redhat.com>

* fixup! fix validation errors and warnings

---------

Signed-off-by: Mykhailo Kuznietsov <mkuznets@redhat.com>
mkuznyetsov added a commit that referenced this pull request Aug 13, 2024
* fix validation errors and warnings
---------

Signed-off-by: Mykhailo Kuznietsov <mkuznets@redhat.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

3 participants