docs: various updates and text fixes in HTML for MD conversion by neteler · Pull Request #4837 · OSGeo/grass

neteler · 2024-12-14T13:28:03Z

This PR contains various HTML updates and textual fixes in preparation for the planned markdown conversion (see also #4748).

For this PR, I have (briefly) reviewed all ~600 GRASS GIS manual pages by converting them to MD for a quality check, and then updated the original HTML files accordingly. Thus it is also a backport candidate for G84.

Changes in detail:

adding missing intro sentences
added module name in the first sentence where missing
http -> https
selected URL updates for broken URLs
selected additions in "SEE ALSO" sections
fix suboptimal HTML formatting (flags, special names, ...)
add missing keywords on metapages
remove leftover Last changed: $Date$ entries from CVS/SVN days
simplify selected -<dl><dt>... to <ul><li>... for improved MD conversion
replaced <tt>...</tt> with <code>...</code>

For an easier review, the changes have been submitted in separate commits:

Extra changes:

replaced <tt>...</tt> with <code>...</code> in 14841b2
dot product: replaced . with · f8ea200
review by @echoix: 1645685 and 6fd0a66
utils/g.html2man/htmltags.txt: dropped outdated file (see instead utils/g.html2man/ggroff.py) in 92597b2

This PR contains various updates and textual fixes (incl. adding missing intro sentences) in preparation of the planned markdown conversion (see also #4748). For an easier review, the changes have been submitted in separate commits: - [ ] **db**: - [ ] **display**: - [ ] **doc**: - [ ] **general**: - [ ] **gui**: - [ ] **imagery**: - [ ] **lib**: - [ ] **misc**: - [ ] **raster**: - [ ] **raster3d**: - [ ] **scripts**: - [ ] **temporal**: - [ ] **vector**: - [ ] **visualization**:

…ith a link to the paper

echoix · 2024-12-15T20:23:31Z

Ok, I'm getting bored, but didn't finish going through all lychee detections/false positives

I ran:

./lychee . --suggest --require-https --archive wayback --base file:///home/vscode/grass/dist.x86_64-pc-linux-gnu/docs/html/ --output lychee_output.md --cache --i
nclude-fragments --include-verbatim --format markdown --cache-exclude-status '429, 500..502'

The output of what I was working on:
lychee_output3.md

The same output after I worked on:
lychee_output4.md

The cache file, two versions in case it is useful (list of links):
lycheecache.zip

A dump of links, created with

./lychee . --suggest --require-https --archive wayback  --include-fragments  --dump --output lychee_dump.txt  --mode plain

lychee_dump.txt

In case someone would want to reproduce the same commands with cache, I added (temporarily) these lines in the .gitignore so the cache/result files wouldn't have their links extracted too:

.lycheecache
lychee
lychee-x86_64-unknown-linux-musl.tar.gz
lychee_output.md
lychee_output

neteler · 2024-12-16T12:17:53Z

g.setproj doesn't seem to be built/available online in 8.4 and 8.5, and also 7.8, 7.0. It exists for 6.4 and 6.5 https://grass.osgeo.org/grass64/manuals/g.setproj.html

Google search for "grass g.setproj" links to 6.5

Right: g.setproj is essentially unneeded code as g.proj has taken over (many years ago it was discussed in the grass-dev list to keep it for easier lookup of code-chunks but I'd suggest to rather remove it in a separate PR). I see a few mentions in messages like d.*, g.region and wxGUI wizard, though (to be updated as well then).

neteler · 2024-12-16T12:19:31Z

What is the correct URL for "Internet: http://grass.osgeo.org/home/contact-us/" in https://github.com/neteler/grass/blob/0be2b97149407d76add9346d207ff52eb205a530/doc/development/rfc/legal_aspects_of_code_contributions.md#L69? It is dead, http, and I don't seem to find the equivalent. (It is not a html file, but it appeared in the search for http only links).

The closest page seems to be https://grass.osgeo.org/about/team/ - what do you think, @veroandreo ?

veroandreo · 2024-12-16T12:23:52Z

What is the correct URL for "Internet: http://grass.osgeo.org/home/contact-us/" in https://github.com/neteler/grass/blob/0be2b97149407d76add9346d207ff52eb205a530/doc/development/rfc/legal_aspects_of_code_contributions.md#L69? It is dead, http, and I don't seem to find the equivalent. (It is not a html file, but it appeared in the search for http only links).

The closest page seems to be https://grass.osgeo.org/about/team/ - what do you think, @veroandreo ?

There is no contact info on the team page. Why not either https://grass.osgeo.org/support/community/ or Discourse directly?

…ontact-us/ -> https://grass.osgeo.org/support/community/

neteler · 2024-12-17T14:28:40Z

The closest page seems to be https://grass.osgeo.org/about/team/ - what do you think, @veroandreo ?

There is no contact info on the team page. Why not either https://grass.osgeo.org/support/community/ or Discourse directly?

Okay, updated in a9938d7

…ing dot being unrelated to the dot-product

neteler · 2024-12-17T16:29:45Z

Seems we are ready to go?

echoix

Since what could be remaining is fine tuning dead links with archives, and that would be a never ending endeavour, I think that what needed to be fixed in here is fixed, and it improves on the previous state.

So yes, I think this should go as is

@echoix

…ort of #4837) This PR contains various HTML updates and textual fixes in preparation for the planned markdown conversion (see also #4748). For this PR, I have (briefly) reviewed all ~600 GRASS GIS manual pages by converting them to MD for a quality check, and then updated the original HTML files accordingly. Thus it is also a backport candidate for G84. Changes in detail: - adding missing intro sentences - added module name in the first sentence where missing - http -> https - selected URL updates for broken URLs - selected additions in "SEE ALSO" sections - fix suboptimal HTML formatting (flags, special names, ...) - add missing keywords on metapages - remove leftover `Last changed: $Date$` entries from CVS/SVN days - simplify selected `-<dl><dt>...` to `<ul><li>...` for improved MD conversion - replaced `<tt>...</tt>` with `<code>...</code>` For an easier review, the changes have been submitted in separate commits: - [x] **db**: 473b95b - [x] **display**: fca42da - [x] **doc**: e473bc8 - [x] **general**: 00930f5 - [x] **gui**: e9259cf - [x] **imagery**: e700a7c, c888dba - [x] **lib**: 6da27ca - [x] **misc**: bfa7c0d - [x] **raster**: 0c5ca83 - [x] **raster3d**: 0c44c95 - [x] **scripts**: e5bd683, 7b70b03 - [x] **temporal**: a173a8f - [x] **vector**: b5167fa - [x] **visualization**: 81e9756 Extra changes: - [x] replaced `<tt>...</tt>` with `<code>...</code>` in 14841b2 - [x] dot product: replaced `.` with `·` f8ea200 - [x] review by @echoix: 1645685 and 6fd0a66 - [x] `utils/g.html2man/htmltags.txt`: dropped outdated file (see instead `utils/g.html2man/ggroff.py`) in 92597b2 Co-authored-by: Edouard Choinière <[email protected]>

neteler added manual Documentation related issues HTML Related code is in HTML docs backport to 8.4 PR needs to be backported to release branch 8.4 labels Dec 14, 2024

neteler added this to the 8.5.0 milestone Dec 14, 2024

neteler requested a review from wenzeslaus December 14, 2024 13:28

neteler self-assigned this Dec 14, 2024

github-actions bot added vector Related to vector data processing libraries labels Dec 14, 2024

neteler added 15 commits December 14, 2024 14:28

db: URL fixes

473b95b

display: various updates

fca42da

doc: URL fix

e473bc8

general: various updates

00930f5

gui: various updates

e9259cf

imagery: various updates

e700a7c

imagery: various updates

c888dba

misc: improve HTML formatting

bfa7c0d

raster: various updates

0c5ca83

raster3d: various updates

0c44c95

scripts: various updates

e5bd683

temporal: various updates

a173a8f

vector: various updates

b5167fa

visualization: update HTML formatting

81e9756

scripts: URL updates in Python scripts

7b70b03

github-actions bot added GUI wxGUI related raster Related to raster data processing temporal Related to temporal data processing Python Related code is in Python database Related to database management labels Dec 14, 2024

echoix added 11 commits December 15, 2024 15:53

Replace unavailable urls with archived copy or newer url

b94be41

Update vtk, paraview and mayavi URLs

3bf7ba6

Update kyngchaos urls to https

0158513

Update gdal urls

76f3f9a

http to https fixes

cbc7d46

Replace dead links with archived version

dc1b317

Replace URLs with current live version

02aafb6

Replace Ehlschlaeger, C. (1989) unavailable and unarchived web page w…

ca8f007

…ith a link to the paper

Remove reference to unavailable forum

2c40377

Replace URLs with current live version

de3f994

Replace unavailable urls with archived version

bcd7beb

github-actions bot added macOS macOS specific C Related code is in C labels Dec 15, 2024

neteler and others added 2 commits December 17, 2024 10:38

Merge branch 'main' into manual_prepare_for_MD_conversion

253626d

github-actions bot added the RFC Request For Comment (RFC) document label Dec 17, 2024

misc/m.transform/m.transform.html: removed (potentially) sentence-end…

ea808b8

…ing dot being unrelated to the dot-product

echoix approved these changes Dec 17, 2024

View reviewed changes

neteler merged commit ab90c5e into OSGeo:main Dec 17, 2024

neteler deleted the manual_prepare_for_MD_conversion branch December 17, 2024 19:17

neteler modified the milestones: 8.5.0, 8.4.1 Dec 17, 2024

neteler removed the backport to 8.4 PR needs to be backported to release branch 8.4 label Dec 17, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Comments

docs: various updates and text fixes in HTML for MD conversion#4837

docs: various updates and text fixes in HTML for MD conversion#4837
neteler merged 47 commits intoOSGeo:mainfrom
neteler:manual_prepare_for_MD_conversion

neteler commented Dec 14, 2024 •

edited

Loading

Uh oh!

echoix commented Dec 15, 2024

Uh oh!

neteler commented Dec 16, 2024

Uh oh!

neteler commented Dec 16, 2024

Uh oh!

veroandreo commented Dec 16, 2024

Uh oh!

neteler commented Dec 17, 2024

Uh oh!

neteler commented Dec 17, 2024

Uh oh!

echoix left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

Comments

Conversation

neteler commented Dec 14, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

echoix commented Dec 15, 2024

Uh oh!

neteler commented Dec 16, 2024

Uh oh!

neteler commented Dec 16, 2024

Uh oh!

veroandreo commented Dec 16, 2024

Uh oh!

neteler commented Dec 17, 2024

Uh oh!

neteler commented Dec 17, 2024

Uh oh!

echoix left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

neteler commented Dec 14, 2024 •

edited

Loading