Documentation contribution

42 views
Skip to first unread message

Jey L.

unread,
Aug 7, 2018, 6:41:14 AM8/7/18
to Praxis LIVE software discussion group
Hi!

I recently contacted Neil about helping on documentation topic. First I proposed to translate the manual (French being my native language). I'm sure that, even if English is the international language for tech topics, some people could enter the users community via their native language. But as documentation translation needs some small changes in the website, it could be interesting to know if this is going to manage more than 2 languages. Do you think that some of you from the community would like to add other languages to the docs?
After that step, I also proposed that we could help bringing tutorials... (format/hosting to be defined...)

Just some ideas...

Best,

J.

Neil C Smith

unread,
Aug 30, 2018, 9:16:21 AM8/30/18
to Praxis LIVE software discussion group
Hi,

On Tue, 7 Aug 2018 at 11:41, Jey L. <fuj...@gmail.com> wrote:
> I recently contacted Neil about helping on documentation topic. First I proposed to translate the manual (French being my native language). I'm sure that, even if English is the international language for tech topics, some people could enter the users community via their native language. But as documentation translation needs some small changes in the website, it could be interesting to know if this is going to manage more than 2 languages. Do you think that some of you from the community would like to add other languages to the docs?
> After that step, I also proposed that we could help bringing tutorials... (format/hosting to be defined...)

Sorry to see there didn't seem to be a response to you on here. Would
hate to see your enthusiasm for this go! I'm wondering about sharing
this info via the PraxisLIVE Twitter and Facebook accounts - what do
you think?

What changes are you envisaging from the website for this? This might
be relevant, but sure we can work around this somehow -
https://github.com/mkdocs/mkdocs/issues/617

Also wonder if there's a possibility to link up with something like
http://en.flossmanuals.net/ ?

Best wishes,

Neil


--
Neil C Smith
Artist & Technologist
www.neilcsmith.net

PraxisLIVE - hybrid visual live programming
for creatives, for programmers, for students, for tinkerers
www.praxislive.org

Jey L.

unread,
Sep 2, 2018, 2:16:54 PM9/2/18
to Praxis LIVE software discussion group

Hi Neil,

 

You mean, sharing the info of requesting translators for the docs on twitter and co.? This may reach more people, why not ;) 

 

In any case, as I understood on gihub , mkdocs is not going to support multi-language anytime soon. But maybe a simple workaround could be to just create a similar sub-site (copy instance ?) with the targeted language, for instance : docs.en.praxislive.org and docs.fr.praxilive.org , each of them being targets of main doc page links. I know this is not the state-of-the-art solution, just a proposal. Then the question is more about, how to get notified about the English (master) docs changes in order to know what to update in another language. Then I would say: git?


Regarding flossmanuals, for sure they manage internationalization, but I would say my feeling is it would be less integrated in your website, and… you just re-wrote the docs website, no? 

 

All the best,


J.

Neil C Smith

unread,
Sep 7, 2018, 11:55:21 AM9/7/18
to Praxis LIVE software discussion group
Hi,

On Sun, 2 Sep 2018 at 19:16, Jey L. <fuj...@gmail.com> wrote:
> You mean, sharing the info of requesting translators for the docs on twitter and co.? This may reach more people, why not ;)

Done, on both Twitter and Facebook. Sorry took a few days - I was
away at the Live Code Festival in Sheffield.

> In any case, as I understood on gihub , mkdocs is not going to support multi-language anytime soon. But maybe a simple workaround could be to just create a similar sub-site (copy instance ?) with the targeted language, for instance : docs.en.praxislive.org and docs.fr.praxilive.org , each of them being targets of main doc page links. I know this is not the state-of-the-art solution, just a proposal. Then the question is more about, how to get notified about the English (master) docs changes in order to know what to update in another language. Then I would say: git?

I'd rather keep the English docs where they are if we can, but other
than that it sounds good. Then need to track commits on the main
GitHub docs repo. Or we look at one repo with another subfolder for
the translation - might cause issues with the config file - I'll
check.

> Regarding flossmanuals, for sure they manage internationalization, but I would say my feeling is it would be less integrated in your website, and… you just re-wrote the docs website, no?

I didn't rewrite much, mainly rehosted from Read the Docs to Netlify
on the praxislive.org domain. It's always been mkdocs. And what I
like about that is there's only a single config file, so everything
else is markdown - works on GitHub itself, and we could potentially
add another config file for a different build system to make an
offline / PDF version.

sylvaink...@gmail.com

unread,
Mar 5, 2019, 10:03:41 AM3/5/19
to PraxisLIVE software discussion group
Hi guys,

I'm a french musician, teacher (electroacoustic music) and editor (off.mann.tf) and I started to use Praxis Live with my students to introduce them to live electronic. So, congratulations Neil for this program ! I come from Max / PD, and Praxis Live is more friendly user and offer code edition rather than only object approach.

I'm contributor and french translator for the open-source project MuseScore, and I would be glad to help you and Jey L. for a french translation of the documentation.

Keep me in touch please !

Best,
Sylvain

Neil C Smith

unread,
Mar 5, 2019, 1:45:39 PM3/5/19
to Praxis LIVE software discussion group
Hi Sylvain,

On Tue, 5 Mar 2019 at 15:03, <sylvaink...@gmail.com> wrote:
> I'm a french musician, teacher (electroacoustic music) and editor (off.mann.tf) and I started to use Praxis Live with my students to introduce them to live electronic. So, congratulations Neil for this program ! I come from Max / PD, and Praxis Live is more friendly user and offer code edition rather than only object approach.

Thank you! That's great to know, and I would love to hear more of
what you're doing with the students, what they're making, how it's
working (or not) for you. It would be a great case study for the
project, if you'd be interested in writing something up or just
sharing how you're working with it?

> I'm contributor and french translator for the open-source project MuseScore, and I would be glad to help you and Jey L. for a french translation of the documentation.

That would be fantastic! There is Jey, and also Bruce (who may not be
on this list), and possibly Max(?), who've mentioned interest in a
translation effort. Let me know what I can do / need to do to help
get this moving.

incidentally, I was talking with someone involved with MuseScore
briefly on the Eurostar back to London from FOSDEM. Didn't get his
name though. Must take a look at MuseScore sometime, particularly if
I can find a way of rescuing my old Sibelius 6 files (by which I mean
the original Sibelius 6 that ran on Acorns over 20 years ago!)

Bruce Lane

unread,
Mar 5, 2019, 1:51:15 PM3/5/19
to praxi...@googlegroups.com
Bonjour Sylvain,
Je suis français aussi

--
You received this message because you are subscribed to the Google Groups "PraxisLIVE software discussion group" group.
To unsubscribe from this group and stop receiving emails from it, send an email to praxis-live...@googlegroups.com.
To post to this group, send an email to praxi...@googlegroups.com.
Visit this group at https://groups.google.com/group/praxis-live.
For more options, visit https://groups.google.com/d/optout.

sylvaink...@gmail.com

unread,
Mar 7, 2019, 12:43:37 PM3/7/19
to PraxisLIVE software discussion group


Le mardi 5 mars 2019 19:45:39 UTC+1, Neil C Smith a écrit :
Hi Sylvain,

On Tue, 5 Mar 2019 at 15:03, <sylvaink...@gmail.com> wrote:
> I'm a french musician, teacher (electroacoustic music) and editor (off.mann.tf) and I started to use Praxis Live with my students to introduce them to live electronic. So, congratulations Neil for this program ! I come from Max / PD, and Praxis Live is more friendly user and offer code edition rather than only object approach.

Thank you!  That's great to know, and I would love to hear more of
what you're doing with the students, what they're making, how it's
working (or not) for you.  It would be a great case study for the
project, if you'd be interested in writing something up or just
sharing how you're working with it?

Of course, for my students, it's a very basic and easy approach. On March 25, we will organisze an event in France with piano and live coding using praxis live in a music school. I will keep you in touch.
 

> I'm contributor and french translator for the open-source project MuseScore, and I would be glad to help you and Jey L. for a french translation of the documentation.

That would be fantastic!  There is Jey, and also Bruce (who may not be
on this list), and possibly Max(?), who've mentioned interest in a
translation effort.  Let me know what I can do / need to do to help
get this moving.

I don't know where you are from your thinking for the translation, but maybe an easy way to start woulf be the translation of the documentation. Github could be a good approach (one fork per language ?) ?



incidentally, I was talking with someone involved with MuseScore
briefly on the Eurostar back to London from FOSDEM.  Didn't get his
name though.  Must take a look at MuseScore sometime, particularly if
I can find a way of rescuing my old Sibelius 6 files (by which I mean
the original Sibelius 6 that ran on Acorns over 20 years ago!)
 
:-D - Unfortunately, I couldn't come to fosdem, but there was a good musescore team indeed :)
I test some ways to link musescore and praxis live with osc. Work in progress...

sylvaink...@gmail.com

unread,
Mar 7, 2019, 12:46:44 PM3/7/19
to PraxisLIVE software discussion group
Hello Bruce!

Looking forward to chat with you, here maybe in english otherwise I'm on Telegram (@skunt) or Twitter or ...

/* Au plaisir d'échanger avec toi, ici peut-être en anglais sinon je suis sur Telegram (@skunt) ou Twitter ou...  */

Sylvain
Reply all
Reply to author
Forward
0 new messages