search

sugarlabs / sugar

Sugar GTK shell
GNU General Public License v3.0
252 stars 240 forks source link

Update debian.md #913

Closed JuiP closed 4 years ago

JuiP commented 4 years ago

TODO

Please verify @quozl

quozl commented 4 years ago

Happy to help.

Method;

For example;

https://packages.debian.org/sucrose https://packages.debian.org/sid/sucrose https://packages.debian.org/source/sid/sugar https://salsa.debian.org/pkg-sugar-team/sugar

https://packages.debian.org/python3-sugar3 https://packages.debian.org/sid/python3-sugar3 https://packages.debian.org/source/sid/sugar-toolkit-gtk3 https://salsa.debian.org/pkg-sugar-team/sugar-toolkit-gtk3

There is probably some command line magic tool to achieve something similar without all the clicks. For example "apt source python3-sugar3" downloads the source and warns that you could have used git, giving the git repository to use.

Best people to engage with on that would be the Debian developer community, not Sugar Labs.

JuiP commented 4 years ago

Thanks for asking.

Also how about adding sugars docs for

I'm not sure if you mean sugar-docs or sugar:docs/. The former is a resource for maintainers of Sugar and activities, Music Blocks, and Sugarizer. Think of it as Sugar Labs documentation, slowly being moved from wiki.sugarlabs.org. The latter is specific to Sugar; installing, using, developing.

  • documentation for adding new translations and refreshing the pot files

In general, we have a checklist for maintainers that mentions this. wiki.sugarlabs.org also has something about it.

For Sugar, you can read the commit messages for po/sugar.pot, for example;

May be a similar one for Sugar Toolkit for GTK 3.

We may lack documentation for uploading the refreshed POT files to translate.sugarlabs.org; I've not seen an uploaded POT file for some years. We may have lost a volunteer, and so reverse engineering the process may be required.

  • Documentation on Port to Collabwrapper - important for activity that uses ExportedGObject.

Should be already in, or added to CollabWrapper, as it isn't part of Sugar or the Toolkit.

  • Port from GObject to GLib

I don't think so. It is documented in our projects list, and the need to document will go away as soon as the project is completed.

chimosky commented 4 years ago

Also how about adding sugars docs for

* documentation for adding new translations and refreshing the pot files

* Documentation on Port to Collabwrapper - important for activity that uses ExportedGObject.

* Port from GObject to GLib

@chimosky @quozl ?

Documentation for translations can be found at the Translation Team page on the wiki.

Not all activities use CollabWrapper and there's Documentation for using it but you'll have to read the source code and test activity to find out, you can write up something if you have the time. Also you can take a look at https://github.com/sugarlabs/collabwrapper/issues/10, I haven't been able to get around to looking at the issue but I plan to.

I don't think a documentation for porting from GObject to GLib is necessary, the projects page explains what needs to be done.

quozl commented 4 years ago

@JuiP, so sorry, I got distracted and edited your comment with my answer instead of making a new comment.

Saumya-Mishra9129 commented 4 years ago

@JuiP

JuiP commented 4 years ago

Sorry for the late reply and a long comment.

I'm not sure if you mean sugar-docs or sugar:docs/.

I meant the documentation for maintainers.

We may lack documentation for uploading the refreshed POT files to translate.sugarlabs.org; I've not seen an uploaded POT file for some years. We may have lost a volunteer, and so reverse engineering the process may be required.

By documentation for adding new translations, I meant refreshing the pot file. I didnot seem to find the documentation initially when I began. @quozl I have even asked about the way in which translations could be added on sugar-devel mailing list as it was confusing initially.

Documentation on Port to Collabwrapper - important for activity that uses ExportedGObject. is already given in http://people.sugarlabs.org/sam/docs-collab-wrapper-try2/sugar3.presence.wrapper.html. So there is no need for extra documentation according to me. Thanks

Thanks @Saumya-Mishra9129 . A part of the documentation from sugar3.presence.wrapper has been added to collabwrapper as docstrings.

Should be already in, or added to CollabWrapper, as it isn't part of Sugar or the Toolkit.

Will look up sugarlabs/collabwrapper#10 as suggested by @chimosky

I don't think a documentation for porting from GObject to GLib is necessary, the projects page explains what needs to be done.

I agree, how about adding a link to the projects page in contributing.md?

JuiP commented 4 years ago

I seemed to have digressed from the aim of this PR. Thanks @quozl I have updated the links related to Sugar Packaging on Debian in the commit 17175e2. Each link now redirects to a valid webpage. Kindly review and merge.

There is probably some command line magic tool to achieve something similar without all the clicks. For example "apt source python3-sugar3" downloads the source and warns that you could have used git, giving the git repository to use.

Should I mention anything related to apt source python3-sugar3 in this doc or leave it to the contributors to figure out?

quozl commented 4 years ago

@JuiP,

I agree, how about adding a link to the projects page in contributing.md?

Sure, if you like. git grep shows we have one in sugar-docs:src/how-can-i-help.md, which is a rephrasing and abbreviation of src/contributing.md.

Should I mention anything related to apt source python3-sugar3 in this doc or leave it to the contributors to figure out?

I don't mind, but I don't see much need. For things we do not maintain, our role is primarily to point to documentation. Same reason we don't explain how to use Python or JavaScript features. We do not maintain apt or Debian, so adding documentation for it is (a) redundant, and (b) increases our future maintenance needs. sugar:docs/debian.md in this repository is mostly for users of Debian to install Sugar, or users of Sugar to choose Debian.

In the context of the GSoC project idea Debian advocacy for Sugar, most of the work requires skills and techniques that are part of the Debian Project, not part of Sugar. A focus on documenting the Debian Project at Sugar Labs is misdirected; if some Debian Project documentation needs improving, then it should be improved over there, not duplicated here.

JuiP commented 4 years ago

I don't mind, but I don't see much need. In the context of the GSoC project idea Debian advocacy for Sugar, most of the work requires skills and techniques that are part of the Debian Project, not part of Sugar. A focus on documenting the Debian Project at Sugar Labs is misdirected; if some Debian Project documentation needs improving, then it should be improved over there, not duplicated here.

Thanks for the clarification!

Sure, if you like. git grep shows we have one in sugar-docs:src/how-can-i-help.md, which is a rephrasing and abbreviation of src/contributing.md.

Will do that then! :)