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.

Sign up for GitHub

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

Jump to bottom

migrate gtk3 porting docs from wiki #150

Merged
merged 11 commits into from
Apr 26, 2018
Merged

migrate gtk3 porting docs from wiki #150

merged 11 commits into from
Apr 26, 2018

Conversation

rdrsadhu
Copy link
Contributor

@rdrsadhu rdrsadhu commented Apr 7, 2018

Fix #149

The conversion was performed using pandoc and may not be perfect.
Feel free to make any improvements.

@rdrsadhu rdrsadhu mentioned this pull request Apr 7, 2018
Closed
@rhl-bthr
Copy link

rhl-bthr commented Apr 7, 2018

Review done by pushing commits to your branch.

  • Using GTK+ 3 everywhere instead of Gtk+3 or gtk+3 or Gtk +3
  • Removed GetBooks port example since all the required information was incorporated into main porting guide already.
  • Removed TamTam port example since it didn't contain much useful information

rhl-bthr
rhl-bthr requested changes Apr 7, 2018
View reviewed changes
src/gtk3-porting-guide.md Outdated
avoid some stressful manually conversions that a “simple script” can
do using *sed* :)
4. Follow the [Code
Guidelines](Development_Team/Code_guidelines "wikilink") during all
Copy link

Choose a reason for hiding this comment

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

Please fix the Link

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done.

src/gtk3-porting-guide.md Outdated
### Use the same keyboard and mouse

If you have an XO, I'm sure you want to take a look at
[this](User:Humitos/x2x "wikilink")...
Copy link

Choose a reason for hiding this comment

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

Please fix the link

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done.

src/gtk3-porting-guide.md Outdated
`sugar-launch org.laptop.sugar.GetBooksActivity`

See also [Development
Team/Debugging](Development_Team/Debugging "wikilink").
Copy link

Choose a reason for hiding this comment

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

Please fix the link

Copy link
Contributor Author

Choose a reason for hiding this comment

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

couldn't find the correct link.
removed the line instead.

rhl-bthr
rhl-bthr reviewed Apr 7, 2018
View reviewed changes
src/gtk3-porting-examples/InfoSlicer.md Outdated
============

First of all, I had to remove the *hippo* related things and the
[sugar-port](Development_Team/sugar-port "wikilink")
Copy link

Choose a reason for hiding this comment

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

Please remove this link, since the page is now deprecated

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done.

rhl-bthr
rhl-bthr requested changes Apr 7, 2018
View reviewed changes
Copy link

@rhl-bthr rhl-bthr left a comment •
edited
Loading

Choose a reason for hiding this comment

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

My suggestion would be that after migrating the page, go through all the links present on the page to check if they are broken or need to be updated

@rdrsadhu
Copy link
Contributor Author

rdrsadhu commented Apr 7, 2018

Updated. PTAL

@ghost
Copy link

ghost commented Apr 7, 2018 via email

@rhl-bthr
Copy link

rhl-bthr commented Apr 7, 2018

I have made some more improvements.
@ritjoe, @rdrsadhu, Kindly review

@ghost
Copy link

ghost commented Apr 7, 2018 via email

Pro-Panda added 2 commits April 7, 2018 23:00
Update documentation
06c8709 
* Fix broken links
* Improve content readability
* Add and improve content
Add porting to how-can-i-help
3c57f21
@rdrsadhu
Copy link
Contributor Author

rdrsadhu commented Apr 8, 2018

LGTM

Pro-Panda and others added 3 commits April 8, 2018 10:17
Minor readability improvements
caa2c3b
@quozl
Major readability improvements
3cc0858 
- define terms and context in an introduction,

- change section structure for coherence,

- fix several links,

- add links to some other resources on porting.
@quozl
Remove subpage porting examples
93c1b18 
- they were mostly incoherent notes by individual developers,

- if anything valuable is needed, it should be in the main page.
@quozl
Copy link
Contributor

quozl commented Apr 9, 2018

See 3cc0858 and 93c1b18. Do any of the removed subpage porting examples contain anything useful for adding to the main page? I didn't notice any.

@rhl-bthr
Copy link

rhl-bthr commented Apr 9, 2018

Reviewed.
I agree. None of the examples have any content that can be added to the main page.

@vipulgupta2048
Copy link

vipulgupta2048 commented Apr 9, 2018 •
edited
Loading

I was just going through the conversation, reading commits and the documentation to see what it was about. Found a spelling mistake, it's very small, almost nonexistent. Good enough to fix, since the PR is open 🙈

Line 107 in src/desktop-activity.md. The spelling of described is wrong.

Will continue proof-reading and check links of other documents. Will edit this comment if I find anything else.

@vipulgupta2048
Copy link

Documentation of the new activity made by the user would be a crucial part of the future if people want to improve or solve issues/bugs related to it. I saw no mention of it, at the Ready to Release section.

I suggest we can add 1-2 points or a separate section regarding how to go about documenting their own sugar-activity when it ready and where to add it (like Help-activity). By providing a clear format they could follow, some tips and examples of the same. This would help in making the process more clear for the developer(s) leading to a more consistent documentation of activities. Suggestions appreciated on the same.

@quozl
Copy link
Contributor

quozl commented Apr 9, 2018

Thanks, line 107 spelling fixed in c18e1a0, but the "Ready to release" sections and the documenting of an activity are not in the scope of the Port to GTK+ 3 Guide, so that's off-topic, let's please keep that discussion inside #96 (comment) instead so we can focus on the Port to GTK+ 3 Guide. Be attentive to the changes in the pull request rather than the rest of the repository.

@vipulgupta2048
Copy link

That is off-topic to the context of the PR as I recognize now. I apologize. I should be more considerate in writing comments and reviewing of PR's. Thanks, @quozl for mentioning it.

@quozl quozl merged commit 51a5d25 into sugarlabs:master Apr 26, 2018
@rdrsadhu rdrsadhu deleted the migrate-porting-guide branch April 26, 2018 04:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@rhl-bthr rhl-bthr rhl-bthr approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@rdrsadhu @rhl-bthr @quozl @vipulgupta2048