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

ICU-22722 Revised ICU4J API doc process to modern tools #2969

Merged
merged 1 commit into from
Apr 17, 2024

Conversation

sven-oly
Copy link
Contributor

@sven-oly sven-oly commented Apr 16, 2024

Add how to use release_tools/github_release.sh.

Also detailed how to update the files in icu-docs/apidoc

Checklist
  • Required: Issue filed: https://unicode-org.atlassian.net/browse/ICU-22722
  • 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

@markusicu
Copy link
Member

This goes into "main" which is now for 76, so you can't use the 75 BRS ticket.

Please use
ICU 76 ticket: docs minor fixes: typos/etc./version updates / User Guide & API docs: ICU-22722

@sven-oly sven-oly changed the title ICU-22535 Revised ICU4J API doc process to modern tools ICU-22722 Revised ICU4J API doc process to modern tools Apr 16, 2024
sven-oly added a commit that referenced this pull request Apr 17, 2024
@jira-pull-request-webhook
Copy link

Hooray! The files in the branch are the same across the force-push. 😃

~ Your Friendly Jira-GitHub PR Checker Bot

mihnita
mihnita previously approved these changes Apr 17, 2024
docs/processes/release/tasks/docs.md Outdated Show resolved Hide resolved

#### Alternative method:
Next, update the documents for this version:
* Copy the fulljavadoc.jar to the to icu-docs/apidoc directory, either dev (for release candidates) or released (for public distribution).
Copy link
Contributor

Choose a reason for hiding this comment

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

Typo?

Suggested change
* Copy the fulljavadoc.jar to the to icu-docs/apidoc directory, either dev (for release candidates) or released (for public distribution).
* Copy the full javadoc.jar to the to icu-docs/apidoc directory, either dev (for release candidates) or released (for public distribution).

Copy link
Contributor Author

Choose a reason for hiding this comment

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

No, the file is actually called "icu4j-75_1-fulljavadoc.jar". There's another file "icu4j-75_1-javadoc.jar" which is not the one to use.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

No, there are 2 javadoc files, icu4j-75_1-javadoc.jar and icu4j-75_1-fulljavadoc.jar. The "full" one is what should be used.

Copy link
Contributor

Choose a reason for hiding this comment

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

Might be best to document it as icu4j-<version>-fulljavadoc.jar then.
I think it would avoid confusion.


In the longer run I think that creating jar + unzipped folder should be done by the script.
No reason to do it by hand.

docs/processes/release/tasks/docs.md Outdated Show resolved Hide resolved
docs/processes/release/tasks/docs.md Outdated Show resolved Hide resolved
@jira-pull-request-webhook
Copy link

Hooray! The files in the branch are the same across the force-push. 😃

~ Your Friendly Jira-GitHub PR Checker Bot

@sven-oly sven-oly merged commit 3f96004 into main Apr 17, 2024
10 checks passed
@sven-oly sven-oly deleted the sven-oly-patch-1 branch April 17, 2024 20:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
4 participants