Ticket #2007 (closed bug: fixed)

Opened 3 years ago

Last modified 3 years ago

documentation now links offsite

Reported by: coke Owned by: jkeenan
Priority: normal Milestone:
Component: docs Version: 3.0.0
Severity: medium Keywords:
Cc: Language:
Patch status: applied Platform:

Description

Recent commits update L<> references in docs/glossary.pod to point to github.com for files that we host in our own documentation.

Instead of pointing offsite, they should work with "make html" so that when the docs get pushed to docs.parrot.org (or are run locally), they don't send folks off site to the latest revision as opposed to the one that corresponds with the given release/build.

Attachments

github_references_possibly_needing_editing.txt Download (4.4 KB) - added by jkeenan 3 years ago.
ack github *; then began to whittle down the list; list needs to be edited further to identify links needing changing per this ticket
github_references_needing_editing.txt Download (1.9 KB) - added by jkeenan 3 years ago.
Trimmed-down list of 'docs' files mentioning github, with annotation as to what was done or not done

Change History

Changed 3 years ago by jkeenan

ack github *; then began to whittle down the list; list needs to be edited further to identify links needing changing per this ticket

  Changed 3 years ago by jkeenan

  • component changed from none to docs

  Changed 3 years ago by jkeenan

  • status changed from new to assigned
  • owner set to jkeenan

Begun work on this ticket in the tt2007/html_links branch.

Changed 3 years ago by jkeenan

Trimmed-down list of 'docs' files mentioning github, with annotation as to what was done or not done

follow-up: ↓ 4   Changed 3 years ago by jkeenan

  • patch set to new

In a second attachment, I present a trimmed-down list of files possibly needing correction. But, when all was said and done, the only file with links needing correction was docs/glossary.pod as cited by coke.

Please review the tt2007/html_links branch. I generated the HTML on  own web site, albeit without any CSS.

I will merge this into master by Tuesday #parrotsketch unless there is objection.

Thank you very much.

kid51

in reply to: ↑ 3   Changed 3 years ago by jkeenan

  • status changed from assigned to closed
  • resolution set to fixed
  • patch changed from new to applied

I will merge this into master by Tuesday #parrotsketch unless there is objection.

Merged in commit bb0b13f8cab1cedf1ba05039bb502b38f1245683. Closing ticket.

Note: See TracTickets for help on using tickets.