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

CI: Add HTML validation to super-linter workflow #303

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

echoix
Copy link
Owner

@echoix echoix commented Nov 25, 2024

No description provided.

@neteler
Copy link

neteler commented Nov 25, 2024

Would you mind to rebase this to see if the superlinter is happy now?

@echoix
Copy link
Owner Author

echoix commented Nov 25, 2024

@neteler Done

@echoix
Copy link
Owner Author

echoix commented Nov 25, 2024

@neteler theres still some. The one where you changed > to an entity has the backslash highlighted.

There's two unexpected closing div. Sometimes it's that a bit above a closing tag is interweaved instead of nested.

@neteler
Copy link

neteler commented Nov 26, 2024

I am preparing a big PR with tons of HTML fixes. Coming soon.

neteler added a commit to neteler/grass that referenced this pull request Nov 26, 2024
In order to obtain a good result when converting the HTML manual pages files to markdown, ideally clean HTML code is used.

This PR fixes numerous broken HTML tags identified during a test run of [adding HTML validation with super-linter](echoix#303).

For reference, see logs showing the errors at
https://github.com/echoix/grass/actions/runs/12001379426/job/33451802353?pr=303#step:4:8310

Fixes:
- incomplete tag pairs
- tabs replaced with white space
neteler added a commit to OSGeo/grass that referenced this pull request Nov 27, 2024
In order to obtain a good result when converting the HTML manual pages files to markdown, ideally clean HTML code is used.

This PR fixes numerous broken HTML tags identified during a test run of [adding HTML validation with super-linter](echoix#303).

For reference, see logs showing the errors at
https://github.com/echoix/grass/actions/runs/12001379426/job/33451802353?pr=303#step:4:8310

Fixes:
- incomplete tag pairs
- tabs replaced with white space
- fix missing .html extension in URLs
@neteler
Copy link

neteler commented Nov 27, 2024

I am preparing a big PR with tons of HTML fixes. Coming soon.

Merged in main, so this PR might be updated to see (ideally) improvements.

@echoix
Copy link
Owner Author

echoix commented Nov 27, 2024

I am preparing a big PR with tons of HTML fixes. Coming soon.

Merged in main, so this PR might be updated to see (ideally) improvements.

In progress

@echoix
Copy link
Owner Author

echoix commented Nov 27, 2024

 /github/workspace/display/d.font/d.font.html : dd or dt tag is unpaired

 /github/workspace/display/d.rhumbline/d.rhumbline.html : alt on img missing


 /github/workspace/display/d.text/d.text.html : dd or dt unpaired

 /github/workspace/display/d.title/d.title.html : dd unpaired + dt

 /github/workspace/general/g.filename/g.filename.html : dd

 /github/workspace/general/g.findfile/g.findfile.html : mixed spaces and tabs



 /github/workspace/general/g.parser/g.parser.html : special characters to escape

 /github/workspace/general/g.proj/g.proj.html: escape special characters


 /github/workspace/general/g.region/g.region.html : multiple issues, dd/dt



 /github/workspace/gui/wxpython/gmodeler/g.gui.gmodeler.html : multiple issues, ul / li unpaired



 /github/workspace/gui/wxpython/rlisetup/g.gui.rlisetup.html : quoting of attributes

 /github/workspace/imagery/i.atcorr/i.atcorr.html : list unpaired

 /github/workspace/imagery/i.cluster/i.cluster.html Attribute quoting

 /github/workspace/imagery/i.evapo.pm/i.evapo.pm.html Escape ampersand 


 /github/workspace/imagery/i.ortho.photo/i.ortho.photo/i.ortho.photo.html : list unpaired (maybe because of p)


 /github/workspace/imagery/i.ortho.photo/i.ortho.transform/i.ortho.transform.html : unpaired because of arrow maybe?

ok, i skipped a lot and it’s starting to be big.

@neteler
Copy link

neteler commented Nov 28, 2024

I will improve further selected HTML bugs but

  • the </p> I will ignore as not really relevant for the markdown conversion.
  • I am less sure about <dd> and <dt> issues, for now too much manual editing for me.

@neteler
Copy link

neteler commented Nov 28, 2024

BTW: I wonder if the super-linter might better look at the final manual pages (i.e., the files generated during the compilation)?

neteler added a commit to neteler/grass that referenced this pull request Nov 28, 2024
In order to obtain a good result when converting the HTML manual pages files to markdown, ideally clean HTML code is used (continuation of OSGeo#4765).

This PR fixes numerous broken HTML tags identified during a test run of [adding HTML validation with super-linter](echoix#303).

For reference, see logs showing the errors at
https://github.com/echoix/grass/actions/runs/12067630007/job/33651008404?pr=303

Fixes include:
- complete selected ncomplete tag pairs (esp. `<li>`)
- tabs replaced with white space
- `<`, `>`, `&` replaced with their HTML representations
@echoix
Copy link
Owner Author

echoix commented Nov 28, 2024

BTW: I wonder if the super-linter might better look at the final manual pages (i.e., the files generated during the compilation)?

Super-linter probably not, as it works better with committed files. Maybe running the tools directly once compiled/generated? But it might only be useful to run linters on generated files when developing, not ongoing use.

Unless there's a point/argument I don't consider.

@neteler
Copy link

neteler commented Nov 28, 2024

Next brushup (hope the last): OSGeo#4781

echoix added a commit to OSGeo/grass that referenced this pull request Nov 28, 2024
* manual: fix more broken HTML tags

In order to obtain a good result when converting the HTML manual pages files to markdown, ideally clean HTML code is used (continuation of #4765).

This PR fixes numerous broken HTML tags identified during a test run of [adding HTML validation with super-linter](echoix#303).

For reference, see logs showing the errors at
https://github.com/echoix/grass/actions/runs/12067630007/job/33651008404?pr=303

Fixes include:
- complete selected ncomplete tag pairs (esp. `<li>`)
- tabs replaced with white space
- `<`, `>`, `&` replaced with their HTML representations

* Apply suggestions from code review

---------

Co-authored-by: Edouard Choinière <27212526+echoix@users.noreply.github.com>
neteler added a commit to OSGeo/grass that referenced this pull request Nov 30, 2024
Backport of #4765

In order to obtain a good result when converting the HTML manual pages files to markdown, ideally clean HTML code is used.

This PR fixes numerous broken HTML tags identified during a test run of [adding HTML validation with super-linter](echoix#303).

For reference, see logs showing the errors at
https://github.com/echoix/grass/actions/runs/12001379426/job/33451802353?pr=303#step:4:8310

Fixes:
- incomplete tag pairs
- tabs replaced with white space
- fix missing .html extension in URLs
neteler added a commit to OSGeo/grass that referenced this pull request Nov 30, 2024
* manual: fix more broken HTML tags

In order to obtain a good result when converting the HTML manual pages files to markdown, ideally clean HTML code is used (continuation of #4765).

This PR fixes numerous broken HTML tags identified during a test run of [adding HTML validation with super-linter](echoix#303).

For reference, see logs showing the errors at
https://github.com/echoix/grass/actions/runs/12067630007/job/33651008404?pr=303

Fixes include:
- complete selected ncomplete tag pairs (esp. `<li>`)
- tabs replaced with white space
- `<`, `>`, `&` replaced with their HTML representations

* Apply suggestions from code review

---------

Co-authored-by: Edouard Choinière <27212526+echoix@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants