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

manual: HTML updates in lib/db and db manual pages and README files #4751

Merged
merged 4 commits into from
Nov 25, 2024

Conversation

neteler
Copy link
Member

@neteler neteler commented Nov 24, 2024

This PR provides minor HTML fixes to lib/db/ and db/ manual related files:

  • convert several README to README.md
  • update selected broken URLs
  • minor HTML fixes
  • partially sync grass-mysql.html and grass-mesql.html incl. section order

Extra:

  • avoid <br> tags within <em> .. </em> as this will not be properly converted to Markdown

This PR provides minor HTML fixes to `lib/db/` and `db/` manual related files:

- convert several `README` to `README.md`
- update selected broken URLs
- partially sync `grass-mysql.html` and `grass-mesql.html` incl. section order
@neteler neteler added manual Documentation related issues HTML Related code is in HTML docs markdown labels Nov 24, 2024
@neteler neteler added this to the 8.5.0 milestone Nov 24, 2024
@neteler neteler self-assigned this Nov 24, 2024
@neteler neteler added the backport to 8.4 PR needs to be backported to release branch 8.4 label Nov 24, 2024
@github-actions github-actions bot added C Related code is in C database Related to database management libraries module labels Nov 24, 2024
@echoix
Copy link
Member

echoix commented Nov 24, 2024

Did you use prettier (like in superlinter) to find problematic/unparsable html?

@neteler
Copy link
Member Author

neteler commented Nov 24, 2024

Did you use prettier (like in superlinter) to find problematic/unparsable html?

For markdown, I used:

npx prettier --print-width 80 -w ': npx prettier --print-width 80 -w README.md

on the various README.md files but not on HTML.

@echoix
Copy link
Member

echoix commented Nov 24, 2024

In the grass-addons, I used prettier and fixed the html parsing errors a while ago, but did not apply the formatting fixes, as it was way too disruptive. But many places the hrefs without quotes were flagged, or tags not in order.

@neteler
Copy link
Member Author

neteler commented Nov 24, 2024

I tried with npx prettier on the four HTML files and the result is pretty ugly (broken </pre> tags and more). So I did not submit these changes.

echoix
echoix previously approved these changes Nov 24, 2024
@echoix
Copy link
Member

echoix commented Nov 25, 2024

I tried with npx prettier on the four HTML files and the result is pretty ugly (broken </pre> tags and more). So I did not submit these changes.

I made a quick run to see if there were some parsing errors that might be problematic when converting. Take a look at the 5 files that have red lines in https://github.com/echoix/grass/actions/runs/12001379426/job/33451802353?pr=303#step:4:8310

One is an decimal character entity missing its semicolon;
one is a link that the closing tag doesn't have the slash so the closing </em> is unexpected;
One is a figure not having a closing italic tag, so the closing div is unexpected;
The two others it's hard to understand with the lines shown, the context isn't big enough.

@neteler
Copy link
Member Author

neteler commented Nov 25, 2024

One is an decimal character entity missing its semicolon; one is a link that the closing tag doesn't have the slash so the closing \</em\> is unexpected; One is a figure not having a closing italic tag, so the closing div is unexpected;

This test looks good and useful to me: so it is informative yet it does not modify the entire HTML code.

The identified HTML errors might be fixed along with the submission of a new superlinter HTML linting PR (in case you plan that).

The two others it's hard to understand with the lines shown, the context isn't big enough.

Concerning one of the linting errors:
t.rast.extract.html: here the < in the example code section will need to be converted to &lt; as it seems to confuse superlinter as is.

@neteler
Copy link
Member Author

neteler commented Nov 25, 2024

(other HTML errors addressed in #4757)

@github-actions github-actions bot added the raster Related to raster data processing label Nov 25, 2024
@echoix
Copy link
Member

echoix commented Nov 25, 2024

One is an decimal character entity missing its semicolon; one is a link that the closing tag doesn't have the slash so the closing \</em\> is unexpected; One is a figure not having a closing italic tag, so the closing div is unexpected;

This test looks good and useful to me: so it is informative yet it does not modify the entire HTML code.

Problem is: they do. That's what all the warnings (in gray) are. I didn't find a way to get what I wanted for grass-addons, so I ended up disabling.

The identified HTML errors might be fixed along with the submission of a new superlinter HTML linting PR (in case you plan that).

Not for now. I'm hoping they get replaced by MD.

The two others it's hard to understand with the lines shown, the context isn't big enough.

Concerning one of the linting errors:

t.rast.extract.html: here the < in the example code section will need to be converted to &lt; as it seems to confuse superlinter as is.

:)

@neteler neteler merged commit 370a492 into OSGeo:main Nov 25, 2024
26 of 27 checks passed
@neteler neteler deleted the manual_SQL_updates branch November 25, 2024 20:49
neteler added a commit that referenced this pull request Nov 25, 2024
…4751)

This PR provides minor HTML fixes to `lib/db/` and `db/` manual related files:

- convert several `README` to `README.md`
- update selected broken URLs
- partially sync `grass-mysql.html` and `grass-mesql.html` incl. section order
- fix typo: statemets -> statements

Extra:
- avoid <br> tags within <em> as not converted properly to Markdown
@neteler neteler removed the backport to 8.4 PR needs to be backported to release branch 8.4 label Nov 25, 2024
@neteler neteler modified the milestones: 8.5.0, 8.4.1 Nov 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C Related code is in C database Related to database management docs HTML Related code is in HTML libraries manual Documentation related issues markdown module raster Related to raster data processing
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants