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

Update and improve help info logs #10081

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

Conversation

vegegoku
Copy link
Member

@vegegoku vegegoku commented Jan 9, 2025

Update, migrate, improve log help links

Fix #10042
See also gwtproject/gwt-site#386

@vegegoku vegegoku force-pushed the helpinfo-update-test branch from 0d70267 to c6beedc Compare January 9, 2025 15:08
@niloc132 niloc132 added this to the 2.13 milestone Jan 11, 2025
GWTProblem.recordError(node, cud, error, new InstalledHelpInfo(
"jsoRestrictions.html"));
GWTProblem.recordError(node, cud, error, new GwtprojectOrgHelpInfo(
"/doc/latest/DevGuideCodingBasicsJSNI.html"));
Copy link
Member

Choose a reason for hiding this comment

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

why not link to the jsoRestrictions.html file that was moved?

* Any violations found are attached as errors on the
* CompilationUnitDeclaration.
*
* @see <a
* href="http://code.google.com/p/google-web-toolkit/wiki/OverlayTypes">Overlay
* types design doc</a>
* @see jsoRestrictions.html
* @see <a href="https://www.gwtproject.org/doc/latest/DevGuideCodingBasicsJSNI.html">jsoRestrictions.html</a>
Copy link
Member

Choose a reason for hiding this comment

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

Could point to the same file after moving it.


public GwtprojectOrgHelpInfo(String relativeUrl) {
try {
url = new URL("https://gwtproject.org" + relativeUrl);
Copy link
Member

Choose a reason for hiding this comment

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

All constructor calls seem to start with /doc/latest/gwt-dev-help/, can we include that in the path here?

If we ever want an absolute link to somewhere else, we could have a factory method for "help(pagename)" vs "article(path)"?

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

Successfully merging this pull request may close these issues.

Update, migrate, improve log help links
2 participants