new Contribute and Develop pages ready
Hi Everyone, These pages have basically the same content as before, but just rearranged, so that the page structure mirrors the sub-menu structure (or vice versa). Of course, since I started them on staging, AND started before we discussed always using the django plugin for making links, I'll have to fix all the links once I transfer the content (from staging to live). (partly off topic, but using the link plugins will put a kink in the process of using the staging site to make drafts of pages, like I have, for the several pages I've worked on)
Anyway, if you'd like to review that I got everything right, and didn't forget anything.....
Here is new Contribute: http://staging.inkscape.org/en/brynns-contribute/?edit_off, and
Here is new Develop: http://staging.inkscape.org/en/brynnsdev/?edit_off.
Here's my plan: -- transfer the content, from staging to live pages -- fix all the links -- publish -- move Bug Management sub-menu item to the bottom
If we ever get guides for writing documentation and/or extensions, those would go below Bug Mgmt, at least for the time being. I do realize that larger changes may be on the way, if Matthew's structure is adopted. But at least for now, this will be a little improvement. (Also partly off topic -- if Matthew's structure is adopted, which removes 1 whole main menu item and sub-menu, maybe the Gallery could go into the main menu? Maybe it's just me, but I think the Gallery needs top billing :-) ) Ok then. Please let me know if any changes are needed to these pages, and when I can go ahead with the transfer.
All best, brynn
-----BEGIN PGP SIGNED MESSAGE----- Hash: SHA256
Hi Brynn,
Here is new Contribute:
http://staging.inkscape.org/en/brynns-contribute/?edit_off, and
- - I compared it to the current contribute page on live - and I must admit, that I like the one on live more, because it more directly talks to the user and sounds more inclusive... But I guess it would be good to move the long texts about development into the development section - they are nice, and it's good that you kept them ;)
The plugin links in Contribute on live are already ready, you won't have to change much, only selectively copy some text over / remove some text. I thought that page had already been finished... as you had already added the new links to the extensions texts in the wiki and such on Jan. 12th...
- - "Review and Verify Existing Bug Reports" (and the link in the text) should link to 'Bug Management' in the Dev section, not to 'Report Bugs'.
- - The 'Translations' section title should link to the translations page.
Here is new Develop: http://staging.inkscape.org/en/brynnsdev/?edit_off.
- - The first sentence 'Working on Inkscape's code base requires knowlege of C++ and Gtk development.' could maybe better be placed inside the next sentence ('If you're a coder/programmer and have some knowlege of C++ and / or Gtk development...") - this sounds less technical and friendlier for a first sentence ;)
- - Would it make sense to order the sections on that page by difficulty? - - from easy to hard: Documentation (would also fit well into 'Contribute', I think, as no coding or knowledge of internal program structure is needed) -> Bug Management -> Extensions -> Core ; Packaging is somehow 'extra'.
- - It's nice that you enlarged the font size and added indentation for better readability, but currently this will make things look inconsistent on live - we'll better do that in the site's css generally for all pages, than have some pages with larger and some with smaller font and some with and some without indentation.
Here's my plan: -- transfer the content, from staging to live pages
- - You won't need to copy the pages over as you usually do, copy-pasting the html source. Better copy the sentences you want to add over from the 'real' page, and then remove what you want to be removed, to keep the plugin links that are already there and to keep the current styling.
-- fix all the links
- - not all, fortunately ;)
-- publish -- move Bug Management sub-menu item to the bottom
- - Sounds good ;)
Regards, Maren
The plug-in links in Contribute on live are already ready,
Ok, yes, good idea. For Contribute, I can just make the few changes using the editor, and not transfer the whole content.
- "Review and Verify Existing Bug Reports" (and the link in the text)
should link to 'Bug Management' in the Dev section, not to 'Report Bugs'.
Hhmmm..... This content came originally from the old faq. But I see what you mean. I'll change it.
- The 'Translations' section title should link to the translations page.
Yes, I changed that, because there are 2 links in the Translations section -- 1 for translating the website, and 1 for translating the program. What about arranging it like the Bugs section just above -- with 2 bullets? Then each bullet title/heading could be a link?
- The first sentence 'Working on Inkscape's code base requires
knowledge of C++ and Gtk development.' could maybe better be placed inside the next sentence ('If you're a coder/programmer and have some knowledge of C++ and / or Gtk development...") - this sounds less technical and friendlier for a first sentence ;)
Yes, that sounds much better. I'll change.
- Would it make sense to order the sections on that page by difficulty?
- from easy to hard:
It's currently arranged from easy to hard. But I thought it made more sense to arrange it from most important to less important (or greatest need, to lesser need -- since the page is more or less about asking for help). That's basically how I arranged Contribute page. Although it's quite possible that I don't have a clear understanding.
Documentation (would also fit well into 'Contribute', I think, as no coding or knowledge of internal program structure is needed)
I gave that a good deal of thought, and almost sent a message about it. I think it depends on what kind of documentation, as to how much knowledge of coding/programming is needed to write it. For example, I could write a tutorial about basic or even intermediate tools/features. But if called on to write a section of the manual about a new tool, for example, or a wiki article, I would not be able to do that. I would need to understand more how the tool or program actually works. This is another case where such a fine line divides contributing and developing. But until there actually is a guide, for people like me, mostly only developers know how to write official documentation anyway.
Yes, I'll put the formatting back to left justified. Although I think that makes it so much harder to read, and probably deters a lot of people from reading any of it (the all left justified text). I really would like to see, or at least discuss doing this in the near future, if possible.
Thanks for looking it over, Maren :-)
All best, brynn
-------------------------------------------------- From: "Maren Hachmann" <maren@...68...> Sent: Sunday, January 25, 2015 6:36 AM To: "Brynn" <brynn@...78...>; inkscape-docs@lists.sourceforge.net Subject: Re: new Contribute and Develop pages ready
-----BEGIN PGP SIGNED MESSAGE----- Hash: SHA256
Hi Brynn,
Here is new Contribute:
http://staging.inkscape.org/en/brynns-contribute/?edit_off, and
- I compared it to the current contribute page on live - and I must
admit, that I like the one on live more, because it more directly talks to the user and sounds more inclusive... But I guess it would be good to move the long texts about development into the development section - they are nice, and it's good that you kept them ;)
The plugin links in Contribute on live are already ready, you won't have to change much, only selectively copy some text over / remove some text. I thought that page had already been finished... as you had already added the new links to the extensions texts in the wiki and such on Jan. 12th...
- "Review and Verify Existing Bug Reports" (and the link in the text)
should link to 'Bug Management' in the Dev section, not to 'Report Bugs'.
- The 'Translations' section title should link to the translations page.
Here is new Develop: http://staging.inkscape.org/en/brynnsdev/?edit_off.
- The first sentence 'Working on Inkscape's code base requires
knowlege of C++ and Gtk development.' could maybe better be placed inside the next sentence ('If you're a coder/programmer and have some knowlege of C++ and / or Gtk development...") - this sounds less technical and friendlier for a first sentence ;)
- Would it make sense to order the sections on that page by difficulty?
- from easy to hard:
Documentation (would also fit well into 'Contribute', I think, as no coding or knowledge of internal program structure is needed) -> Bug Management -> Extensions -> Core ; Packaging is somehow 'extra'.
- It's nice that you enlarged the font size and added indentation for
better readability, but currently this will make things look inconsistent on live - we'll better do that in the site's css generally for all pages, than have some pages with larger and some with smaller font and some with and some without indentation.
Here's my plan: -- transfer the content, from staging to live pages
- You won't need to copy the pages over as you usually do,
copy-pasting the html source. Better copy the sentences you want to add over from the 'real' page, and then remove what you want to be removed, to keep the plugin links that are already there and to keep the current styling.
-- fix all the links
- not all, fortunately ;)
-- publish -- move Bug Management sub-menu item to the bottom
- Sounds good ;)
Regards, Maren
-----BEGIN PGP SIGNATURE----- Version: GnuPG v1
iF0EAREIAAYFAlTE8U4ACgkQKoYx0uUjpE3YXwD+LmxbUTjT6ClMM5xUweaStgzO 0qXKL092STGcxEA/2KMA9227tG8/RXEcGrVAPDClqZ6hv8wpKhkSyHWzhmhsskY= =0XNh -----END PGP SIGNATURE-----
Hi Brynn,
- The 'Translations' section title should link to the
translations page.
Yes, I changed that, because there are 2 links in the Translations section -- 1 for translating the website, and 1 for translating the program. What about arranging it like the Bugs section just above -- with 2 bullets? Then each bullet title/heading could be a link?
- You could do that, I think. But it probably won't hurt to link to the Translations page itself, not just to subsections.
- Would it make sense to order the sections on that page by
difficulty? - - from easy to hard:
It's currently arranged from easy to hard. But I thought it made more sense to arrange it from most important to less important (or greatest need, to lesser need -- since the page is more or less about asking for help). That's basically how I arranged Contribute page. Although it's quite possible that I don't have a clear understanding.
- I have gotten the impression (and please, anyone here correct me) that there are many code contributors, but that there is a gap in the marketing / documentation staff...
But until there actually is a guide, for people like me, mostly only developers know how to write official documentation anyway.
- That's probably true. Or at least people who can translate developer-talk into normal-people-talk... Would you know right away what 'polar coordinates' are, and how use that feature?... 'Arrange along Arc' *could* have been a better label for that cool new feature...
Yes, I'll put the formatting back to left justified. Although I think that makes it so much harder to read, and probably deters a lot of people from reading any of it (the all left justified text). I really would like to see, or at least discuss doing this in the near future, if possible.
- I think there's a good chance for that with Hinerangi and Mathew on the team ;)
Thanks for looking it over, Maren :-)
- No problem, thanks for actually *doing* this ;)
Regards, Maren
participants (2)
-
Brynn -
Maren Hachmann