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

Fix some links in documentation #2666

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

hugovdm
Copy link
Contributor

@hugovdm hugovdm commented Oct 10, 2023

WIP: maybe this should become part of ICU-22438 ?

  • Skip over the manual redirects that are icu4[cj]/readme.html.
  • Update links: site.icu-project.org/processes/contribute is no more.
  • Update link paths: some relative links in moved docs were pointing at userguide/icu4c/icu4c
  • Add .html suffixes, letting unicode-org.github.io sidebar correctly show which page is being viewed. However it would also break Markdown navigation. Which use case are we optimising for? GitHub Pages, or Markdown source?

I wasn't very thorough with my searches, this was based on broken links

rgrep processes/contribute .
rgrep 'icu4[cj]/readme.html' .
egrep -r '/packaging)|/build)' .

I've not fixed all the /icudata.md links yet for example. Should perhaps add all of those to this PR?

Checklist
  • Required: Issue filed: https://unicode-org.atlassian.net/browse/ICU-_____
  • Required: The PR title must be prefixed with a JIRA Issue number.
  • Required: The PR description must include the link to the Jira Issue, for example by completing the URL in the first checklist item
  • Required: Each commit message must be prefixed with a JIRA Issue number.
  • Issue accepted (done by Technical Committee after discussion)
  • Tests included, if applicable
  • API docs and/or User Guide docs changed or added, if applicable

- Skip over the manual redirects that are icu4[cj]/readme.html.

- Update links: site.icu-project.org/processes/contribute is no more.

- Update link paths: some relative links in moved docs were pointing at
  userguide/icu4c/icu4c

- Add .html suffixes, letting unicode-org.github.io sidebar correctly show which
  page is being viewed. However it would also break Markdown navigation. Which
  use case are we optimising for? GitHub Pages, or Markdown source?

I wasn't very thorough with my searches, this was based on broken links

rgrep processes/contribute .
rgrep 'icu4[cj]/readme.html' .
egrep -r '/packaging)|/build)' .

I've not fixed all the /icudata.md links yet for example. Should perhaps add all
of those to this PR?
@@ -530,6 +529,10 @@ Jira.
2. Use the drop-down to change the fix version to the next ICU version
3. Click "Save" next to the filter title

## Update this document
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Intended as a "WIP / DO NOT SUBMIT"

@@ -69,8 +69,8 @@ MSVC compiler. See the [Building ICU4C](./icu4c/build) page.

#### Can you help me build ICU4C for ...

We can try ... make sure you read the [Building ICU4C](./icu4c/build) section and also the [ICU
Data](../icudata.md) section. You might also [searching the icu-support
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Several more references to icudata.md - I propose I try to update all of them in this PR

@echeran
Copy link
Contributor

echeran commented Mar 12, 2024

FYI: You no longer need to ensure the .html suffix to get the left hand navigation bar to highlight the page correctly on page load, thanks to just-the-docs/just-the-docs#1371.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants