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 helplink.json for Contextual-Help #63

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update helplink.json for Contextual-Help #63

wants to merge 1 commit into from

Conversation

rdrsadhu
Copy link
Contributor

as far as I know, the helplink.json file is used to map an activity bundle_id to a .html file; such that
the same .html file is rendered when asked for contextual help (by alt+shift+h) from within a particular activity (having corresponding bundle_id)

But for

  1. AEIOU:
    activity.info says bundle_id = org.sugarlabs.AEIOU.NI
    help doesn't work. But works with bundle_id = org.sugarlabs.AEIOU

  2. Letter Match:
    activity.info says bundle_id = org.sugarlabs.LetterMatch.NI
    help doesn't work. But works with bundle_id = org.sugarlabs.LetterMatch

also, the activity_version is not consistent ( activity-github-repo vs https://activities.sugarlabs.org/en-US/sugar/)

@quozl
Copy link
Collaborator

quozl commented May 23, 2018

Rather than hide the problem by forging bundle_id, could you please find out why this problem is happening? I've just spent five minutes looking through the sugar and sugar-toolkit-gtk3 repositories for the processing of bundle_id and did not find why it does what you say.

@quozl
Copy link
Collaborator

quozl commented Jul 14, 2018

Any update? We really ought to find out why this happens rather than plaster over it.

@rdrsadhu
Copy link
Contributor Author

I was planning to dive into this, once migration of all working activities is complete.
2 more weeks 🙊

@quozl
Copy link
Collaborator

quozl commented Jul 14, 2018

Sure.

@rdrsadhu
Copy link
Contributor Author

as far as I know, the helplink.json file is used to map an activity bundle_id to a .html file

I've just spent five minutes looking through the sugar and sugar-toolkit-gtk3 repositories for the processing of bundle_id and did not find why it does what you say.

In the file https://github.com/sugarlabs/sugar/blob/ffe4d50782cbf848e63ef5383d69bf4da25f952d/src/jarabe/view/viewhelp.py

get_help_url_and_title(activity) (at line 73) implements the above. where;

line 98: gets the bundle_id of activity which calls for help, and
line 117: checks for its presence in the helplink.json file; which if True, returns the the corresponding .html file to be rendered.

Correct me if I'm wrong or missing something.

@quozl
Copy link
Collaborator

quozl commented Jul 22, 2018

You're right so far. So the cause must be in the toolkit, not the shell. You might add debugging prints to this code in viewhelp.py to dump the variables link_id and links.

@rdrsadhu
Copy link
Contributor Author

I suspect this a simple(rather odd) issue which occurs just because; we have 2 different copies of the activity bundle_id

check these 2 commits: sugarlabs/AEIOU@b051e76#diff-65fbf29894b41250d50ea32939f0a6d9 , sugarlabs/lettermatch@fb6921a#diff-65fbf29894b41250d50ea32939f0a6d9

The above changes are yet to be reflected in activities.sugarlabs.org, which brings in the discrepancy

Also, the issues aren't even reproducible when we install AEIOU and Letter Match from their GitHub repositories.

@quozl
Copy link
Collaborator

quozl commented Jul 23, 2018

Interesting, thanks. So Sugar and the Toolkit are working correctly, you were using older bundles from activities.sugarlabs.org to test the contextual help feature, but you used GitHub source rather than the released bundle to update the helplink.json file in e3b14cc.

It would be solved by releases of AEIOU and LetterMatch, but you aren't willing to do that? Again, brings up an issue that we have had for many weeks; plenty of minor fixes, but very few releases, almost as if someone forgot to say in task descriptions that releases were important. 😁

@walterbender, why do those two commits above change the bundle id?

@rdrsadhu
Copy link
Contributor Author

It would be solved by releases of AEIOU and LetterMatch, but you aren't willing to do that?

Is there a checklist to follow for new releases of Activities?

@quozl
Copy link
Collaborator

quozl commented Jul 23, 2018

Sure. Our Contributing - Modifying Activities and the subsections within it.

@quozl
Copy link
Collaborator

quozl commented Aug 2, 2018

@walterbender, why do those two commits above change the bundle id? perhaps wasn't meant for pushing?

@quozl
Copy link
Collaborator

quozl commented Jan 9, 2020

I hit this again and fixed it for release to ASLO for AEIOU. sugarlabs/AEIOU@c8be707

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.

2 participants