-
-
Notifications
You must be signed in to change notification settings - Fork 316
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
docs: various updates and text fixes in HTML for MD conversion #4837
docs: various updates and text fixes in HTML for MD conversion #4837
Conversation
This PR contains various updates and textual fixes (incl. adding missing intro sentences) in preparation of the planned markdown conversion (see also OSGeo#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
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: The same output after I worked on: The cache file, two versions in case it is useful (list of links): A dump of links, created with ./lychee . --suggest --require-https --archive wayback --include-fragments --dump --output lychee_dump.txt --mode plain 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 |
Right: |
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
Seems we are ready to go? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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
…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 <27212526+echoix@users.noreply.github.com>
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:
Last changed: $Date$
entries from CVS/SVN days-<dl><dt>...
to<ul><li>...
for improved MD conversion<tt>...</tt>
with<code>...</code>
For an easier review, the changes have been submitted in separate commits:
Extra changes:
<tt>...</tt>
with<code>...</code>
in 14841b2.
with·
f8ea200utils/g.html2man/htmltags.txt
: dropped outdated file (see insteadutils/g.html2man/ggroff.py
) in 92597b2