"Getting Started with Development" instructions
Hi everyone,
I am about to update the "getting started" instructions for new developers: https://inkscape.org/develop/getting-started/
If you have any further suggestions, feel free to answer. I'd like to consolidate all changes into one big edit because every change needs to be translated.
Here's my list of changes:
- git SSH -> change to HTTPS (as discussed a few months ago)
- "Install build dependencies": replace old "apt-get" instructions with the new script from inkscape-ci-docker. Download and run the script to install all requirements: wget -v https://gitlab.com/inkscape/inkscape-ci-docker/raw/master/install_dependenci... -O install_dependencies.sh bash install_dependencies.sh --recommended
- "/usr in the example" -> "in the example, it is installed in inst/ inside the source folder"
- "Versions <= 0.92" -> remove from tutorial, move to Wiki remove mentioning of autotools, as CMake is now the default
- do not mark optional arguments with "[ ]" so that copy-paste into the shell works. Also, omitting some of these arguments (e.g. ccache) will horribly slow down compilation, so they aren't truly optional. Instead, just add a note that these arguments may be omitted.
- after changes are published: remove redundant info from the Wiki page https://wiki.inkscape.org/wiki/index.php?title=CompilingUbuntu
Have a nice weekend,
Max
Hi Max,
thank you.
1.) We have to decide what to do about the macOS related stuff. The most up-to-date instructions, based on how our CI pipeline works, are in packaging/macOS/README.md. Although I’m working really hard on making this more attractive (e.g. we have disk images containing the complete toolset including all dependencies), people are more used to MacPorts and the likes. For instance, speleo3 is using MacPorts as well. Luckily it’s not a problem how people are getting themselves set up to develop and it does not hurt to offer multiple choices. We could link to my instructions and speleo3 would need to update the MacPorts ones.
2.) The last item on your list is one of the most important ones to me: we need to remove all redundancies (for all the platforms) and create a single point of truth. We often have the same kind of information scattered around in multiple places, in varying degrees of quality and age. If we really need something in multiple places, we should keep it in one and link to it from all the other ones. And that should no only include the wiki but extend to the website and wherever else information has been dumped before (no offense). If this sounds too much / out of scope for what you’ve had planned for yourself to do, we should put it on a todo list. (Also I’m not suggesting that you rewrite everything yourself, but you’ll likely come across all the possible and impossible places where something needs to be moved to the new consolidated instructions page.)
All the best, René
I'm keeping https://wiki.inkscape.org/wiki/index.php/CompilingMacOsX up-to-date with the MacPorts instructions. I'm up for simplifying the page to a bare minimum, but I wouldn't remove it (some redundancy with instructions for other environments will be unavoidable).
Thomas
On Sat, Dec 28, 2019 at 2:41 AM René de Hesselle dehesselle@icloud.com wrote:
Hi Max,
thank you.
1.) We have to decide what to do about the macOS related stuff. The most up-to-date instructions, based on how our CI pipeline works, are in packaging/macOS/README.md. Although I’m working really hard on making this more attractive (e.g. we have disk images containing the complete toolset including all dependencies), people are more used to MacPorts and the likes. For instance, speleo3 is using MacPorts as well. Luckily it’s not a problem how people are getting themselves set up to develop and it does not hurt to offer multiple choices. We could link to my instructions and speleo3 would need to update the MacPorts ones.
2.) The last item on your list is one of the most important ones to me: we need to remove all redundancies (for all the platforms) and create a single point of truth. We often have the same kind of information scattered around in multiple places, in varying degrees of quality and age. If we really need something in multiple places, we should keep it in one and link to it from all the other ones. And that should no only include the wiki but extend to the website and wherever else information has been dumped before (no offense). If this sounds too much / out of scope for what you’ve had planned for yourself to do, we should put it on a todo list. (Also I’m not suggesting that you rewrite everything yourself, but you’ll likely come across all the possible and impossible places where something needs to be moved to the new consolidated instructions page.)
All the best, René
Inkscape Devel mailing list -- inkscape-devel@lists.inkscape.org To unsubscribe send an email to inkscape-devel-leave@lists.inkscape.org
I have now published my changes on https://inkscape.org/develop/getting-started/.
I'm not super happy about the current state: The website lists detailed Linux instructions, but for Windows/Mac there are just links to the Wiki. In my opinion, moving everything away from the website into the Wiki or into README files in the source tree would be more consistent. However, consensus at the Saarbrücken Hackfest was to keep the website as detailed as it is.
1.) We have to decide what to do about the macOS related stuff.
The MacOS section links to the Wiki (as before). Feel free to update the wiki page.
Max
I Maximilian, how are you doing?
Please don't let your frustration block you from moving forward. This new pair of eyes from new developers, especially for Windows and Mac is very valuable to us all. Especially in what concerns improving our documentation/website new devevlopers onboarding page and experience.
Please, if possible, take notes as to what would the desired changes be and please, kindly ask them in the Devel chat room ( https://chat.inkscape.org/channel/team_devel) or maybe even in the Team Website chat room (https://chat.inkscape.org/channel/team_website) if there is a way to update the instructions on the Inkscape website.
Linux tends to be favoured in our website only to the fact that it is the OS of choice of your core developers. No further distinction of OS is done based in any other factor. It is just matter of what is mainly used by them. That's all.
Your contributions would be much appreciated!
Thanks, Victor
On Sun, Feb 16, 2020 at 12:15 PM Maximilian Gaukler < development@maxgaukler.de> wrote:
I have now published my changes on https://inkscape.org/develop/getting-started/.
I'm not super happy about the current state: The website lists detailed Linux instructions, but for Windows/Mac there are just links to the Wiki. In my opinion, moving everything away from the website into the Wiki or into README files in the source tree would be more consistent. However, consensus at the Saarbrücken Hackfest was to keep the website as detailed as it is.
1.) We have to decide what to do about the macOS related stuff.
The MacOS section links to the Wiki (as before). Feel free to update the wiki page.
Max _______________________________________________ Inkscape Devel mailing list -- inkscape-devel@lists.inkscape.org To unsubscribe send an email to inkscape-devel-leave@lists.inkscape.org
Hi Max,
Content wise, we have always preferred to have the website focus on user content and the wiki focus on developer content. The linux instructions are an anomaly because linux users can technically compile Inkscape and that's not considered odd.
But moving it all to the wiki would be fine with me.
Best Regards, Martin Owens
On Sun, 2020-02-16 at 21:15 +0100, Maximilian Gaukler wrote:
I'm not super happy about the current state: The website lists detailed Linux instructions, but for Windows/Mac there are just links to the Wiki. In my opinion, moving everything away from the website into the Wiki or into README files in the source tree would be more consistent. However, consensus at the Saarbrücken Hackfest was to keep the website as detailed as it is.
participants (5)
-
Martin Owens -
Maximilian Gaukler -
René de Hesselle -
Thomas Holder -
Victor Westmann