Re: [Hydrogen-devel] Help wanted: Documentation / Further documentation plans

2017-05-10 Thread mauser 
Hi!

as announced before, the hydrogen documentation lives now inside its own 
git repository.

You can find the manual and tutorial here: 
https://github.com/hydrogen-music/documentation

The old data/doc folder is now a git submodule. If you want to work on 
the documentation or create an installer (debian package, nsis, 
whatever..) you can initialize the submodule with "git submodule init; 
git submodule update".

Have a look at https://git-scm.com/book/en/v2/Git-Tools-Submodules for 
more information about git submodules.

The new documentation repository works also in a "freestanding" manner, 
so you can clone just the documentation repository if you want to work 
on the documentation.

Best regards,
Sebastian

Am 11.03.2017 11:35, schrieb mau...@smoors.de:
> Hi everyone!
> 
> As you most of you already know, the hydrogen manual and tutorial are
> getting more and more deprecated since those documents were not updated
> for some time.. Is there anyone on this list who has an interested in
> writing and who would be interested in helping with updating the 
> manual?
> 
> Apart from that, i'm currently thinking about putting the documentation
> (manual and tutorial) in a separate git repository. This helps to keep
> the source code repository small (i suppose that over time, more and
> more larger images will be added to the manual) and allows for a better
> permission-management for our repositories.
> 
> Best regards,
> Sebastian
> 
> 
> --
> Announcing the Oxford Dictionaries API! The API offers world-renowned
> dictionary content that is easy and intuitive to access. Sign up for an
> account today to start using our lexical data to power your apps and
> projects. Get started today and enter our developer competition.
> http://sdm.link/oxford
> ___
> Hydrogen-devel mailing list
> Hydrogen-devel@lists.sourceforge.net
> https://lists.sourceforge.net/lists/listinfo/hydrogen-devel

--
Check out the vibrant tech community on one of the world's most
engaging tech sites, Slashdot.org! http://sdm.link/slashdot
___
Hydrogen-devel mailing list
Hydrogen-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/hydrogen-devel

Re: [Hydrogen-devel] Help wanted: Documentation / Further documentation plans

2017-04-04 Thread mauser 
Hi Olivier!

Thanks for volunteering for the manual :)

As Thijs already mentioned, the organisation of the manual in the github 
repository does not affect the process of generating the manual. If you 
have any questions about updating the manual, just let us know.. There 
are quite a lot of packages which are needed for the generation of the 
manual, but once everything is setup, the editing is quite simple.

Best regards,
Sebastian

Am 23.03.2017 14:03, schrieb treb...@tuxfamily.org:
> Le 2017-03-11 11:35, mau...@smoors.de a écrit :
>> 
>> As you most of you already know, the hydrogen manual and tutorial are
>> getting more and more deprecated since those documents were not 
>> updated
>> for some time.. Is there anyone on this list who has an interested in
>> writing and who would be interested in helping with updating the 
>> manual?
> 
> I am.
> 
>> Apart from that, i'm currently thinking about putting the 
>> documentation
>> (manual and tutorial) in a separate git repository. This helps to keep
>> the source code repository small (i suppose that over time, more and
>> more larger images will be added to the manual) and allows for a 
>> better
>> permission-management for our repositories.
> 
> It would be awesome!
> For my personal case, I tried 2 or 3 times to dive in how the manual is 
> managed
> into hydrogen, and I failed to understand that, even when reading the
> related docs.
> the way I see how I could work with it should be as follow :
> - editing the files through the github interface within a fork
> - saving them trough the github interface
> - building Hydrogen from my fork
> - checking that what I did is right and well done
> - submitting a patch against the Hydrogen repo
> - done
> 
> If something like that could be achieved, it would allow me to spend 
> more time
> in helping with the manual, keeping it up to date, adding the new
> functionnality,
> adding stuff asked and answered in the forum but not in the manual yet, 
> ...
> 
> BTW : lately some developers have been starting to put some
> information with there
> pull request (see https://github.com/hydrogen-music/hydrogen/pull/359 
> or
> https://github.com/hydrogen-music/hydrogen/pull/356 for examples) and
> I think that
> it is really really great. Thanks people ! I'd be glad to be useful in
> integrating
> those info into the manual.
> 
> Cheers,
> Olivier

--
Check out the vibrant tech community on one of the world's most
engaging tech sites, Slashdot.org! http://sdm.link/slashdot
___
Hydrogen-devel mailing list
Hydrogen-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/hydrogen-devel

Re: [Hydrogen-devel] Help wanted: Documentation / Further documentation plans

2017-03-24 Thread Thijs van severen 
IIRC the manual is in doc book format to make it translateable
This document is then converted to 1 html document per language


Op 23 mrt. 2017 14:04 schreef :

> Le 2017-03-11 11:35, mau...@smoors.de a écrit :
> >
> > As you most of you already know, the hydrogen manual and tutorial are
> > getting more and more deprecated since those documents were not updated
> > for some time.. Is there anyone on this list who has an interested in
> > writing and who would be interested in helping with updating the
> > manual?
>
> I am.
>
> > Apart from that, i'm currently thinking about putting the documentation
> > (manual and tutorial) in a separate git repository. This helps to keep
> > the source code repository small (i suppose that over time, more and
> > more larger images will be added to the manual) and allows for a better
> > permission-management for our repositories.
>
> It would be awesome!
> For my personal case, I tried 2 or 3 times to dive in how the manual is
> managed
> into hydrogen, and I failed to understand that, even when reading the
> related docs.
> the way I see how I could work with it should be as follow :
> - editing the files through the github interface within a fork
> - saving them trough the github interface
> - building Hydrogen from my fork
> - checking that what I did is right and well done
> - submitting a patch against the Hydrogen repo
> - done
>
> If something like that could be achieved, it would allow me to spend
> more time
> in helping with the manual, keeping it up to date, adding the new
> functionnality,
> adding stuff asked and answered in the forum but not in the manual yet,
> ...
>
> BTW : lately some developers have been starting to put some information
> with there
> pull request (see https://github.com/hydrogen-music/hydrogen/pull/359 or
> https://github.com/hydrogen-music/hydrogen/pull/356 for examples) and I
> think that
> it is really really great. Thanks people ! I'd be glad to be useful in
> integrating
> those info into the manual.
>
> Cheers,
> Olivier
>
> 
> --
> Check out the vibrant tech community on one of the world's most
> engaging tech sites, Slashdot.org! http://sdm.link/slashdot
> ___
> Hydrogen-devel mailing list
> Hydrogen-devel@lists.sourceforge.net
> https://lists.sourceforge.net/lists/listinfo/hydrogen-devel
>
--
Check out the vibrant tech community on one of the world's most
engaging tech sites, Slashdot.org! http://sdm.link/slashdot___
Hydrogen-devel mailing list
Hydrogen-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/hydrogen-devel

Re: [Hydrogen-devel] Help wanted: Documentation / Further documentation plans

2017-03-23 Thread trebmuh 
Le 2017-03-11 11:35, mau...@smoors.de a écrit :
> 
> As you most of you already know, the hydrogen manual and tutorial are
> getting more and more deprecated since those documents were not updated
> for some time.. Is there anyone on this list who has an interested in
> writing and who would be interested in helping with updating the 
> manual?

I am.

> Apart from that, i'm currently thinking about putting the documentation
> (manual and tutorial) in a separate git repository. This helps to keep
> the source code repository small (i suppose that over time, more and
> more larger images will be added to the manual) and allows for a better
> permission-management for our repositories.

It would be awesome!
For my personal case, I tried 2 or 3 times to dive in how the manual is 
managed
into hydrogen, and I failed to understand that, even when reading the 
related docs.
the way I see how I could work with it should be as follow :
- editing the files through the github interface within a fork
- saving them trough the github interface
- building Hydrogen from my fork
- checking that what I did is right and well done
- submitting a patch against the Hydrogen repo
- done

If something like that could be achieved, it would allow me to spend 
more time
in helping with the manual, keeping it up to date, adding the new 
functionnality,
adding stuff asked and answered in the forum but not in the manual yet, 
...

BTW : lately some developers have been starting to put some information 
with there
pull request (see https://github.com/hydrogen-music/hydrogen/pull/359 or
https://github.com/hydrogen-music/hydrogen/pull/356 for examples) and I 
think that
it is really really great. Thanks people ! I'd be glad to be useful in 
integrating
those info into the manual.

Cheers,
Olivier

--
Check out the vibrant tech community on one of the world's most
engaging tech sites, Slashdot.org! http://sdm.link/slashdot
___
Hydrogen-devel mailing list
Hydrogen-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/hydrogen-devel

Re: [Hydrogen-devel] Help wanted: Documentation / Further documentation plans

2017-03-13 Thread Thijs van severen 
so to do this H2 does not rely on local git functionality, and it is 100%
cross-platform, right ?
sounds good to me  :-)


2017-03-13 9:31 GMT+01:00 Jérémy Zurcher :

> Hi,
>
> have a separate repo for the manual  use github API !!
>
> available API :
> $ curl https://api.github.com/repos/hydrogen-music/hydrogen
>
> latest commit metadata:
> $ curl https://api.github.com/repos/hydrogen-music/hydrogen/
> commits/HEAD
>
> download HEAD:
> $ curl -L https://api.github.com/repos/hydrogen-music/hydrogen/zipball
> > h2.zip
>
> H2 could then ask for HEAD metadata, and update it's local manual from
> github when needed.
>
>
> On Monday 13 March 2017  08:20, Thijs van severen wrote :
> > Hi
> >
> > I did a big portion of the last update and -if time permits- want to help
> > with this again, but first i need to get some new features in H2 that I
> > really really need for playing live and am currently trying to implement.
> >
> > I remember talking about an 'update able manual'.  In other words a
> > document that is not part of the binary, but that is provided with the
> > installer and can be (auto) updated whenever a new version is available.
> > Typically the manual lags behind the code development and thus is 'never'
> > up to date.  Decoupling code and manual also makes sure that the release
> is
> > not delayed by an incomplete manual.
> >
> > Thinking about the suggestion you made about git: that makes a lot of
> sense
> > if we should switch to the 'update able manual'.  Imagine a new feature
> > that needs to be added to the manual. This would only be added to the
> > manual branch for the latest code.  But if you fix an error in a part of
> > the manual that is common to all H2 version, git can easily handle this
> and
> > push the fix to all manual branches.
> >
> > Would it be possible to let H2 get the manual directly from git ? I guess
> > this requires git functionality on the user side that is not always
> > available. Maybe an export to pdf would be preferable.
> >
> > Ideas?
> >
> > Grtz
> > Thijs
> >
> > Op 11 mrt. 2017 11:35 a.m. schreef :
> >
> > > Hi everyone!
> > >
> > > As you most of you already know, the hydrogen manual and tutorial are
> > > getting more and more deprecated since those documents were not updated
> > > for some time.. Is there anyone on this list who has an interested in
> > > writing and who would be interested in helping with updating the
> manual?
> > >
> > > Apart from that, i'm currently thinking about putting the documentation
> > > (manual and tutorial) in a separate git repository. This helps to keep
> > > the source code repository small (i suppose that over time, more and
> > > more larger images will be added to the manual) and allows for a better
> > > permission-management for our repositories.
> > >
> > > Best regards,
> > > Sebastian
> > >
> > >
> > > 
> > > --
> > > Announcing the Oxford Dictionaries API! The API offers world-renowned
> > > dictionary content that is easy and intuitive to access. Sign up for an
> > > account today to start using our lexical data to power your apps and
> > > projects. Get started today and enter our developer competition.
> > > http://sdm.link/oxford
> > > ___
> > > Hydrogen-devel mailing list
> > > Hydrogen-devel@lists.sourceforge.net
> > > https://lists.sourceforge.net/lists/listinfo/hydrogen-devel
> > >
>
> > 
> --
> > Announcing the Oxford Dictionaries API! The API offers world-renowned
> > dictionary content that is easy and intuitive to access. Sign up for an
> > account today to start using our lexical data to power your apps and
> > projects. Get started today and enter our developer competition.
> > http://sdm.link/oxford
>
> > ___
> > Hydrogen-devel mailing list
> > Hydrogen-devel@lists.sourceforge.net
> > https://lists.sourceforge.net/lists/listinfo/hydrogen-devel
>
> ---
> Jérémy Zurcher
> rue des Charmilles 7
> 1400 Yverdon-les-bains
> +41 (0) 79 599 84 27
>
> 
> --
> Announcing the Oxford Dictionaries API! The API offers world-renowned
> dictionary content that is easy and intuitive to access. Sign up for an
> account today to start using our lexical data to power your apps and
> projects. Get started today and enter our developer competition.
> http://sdm.link/oxford
> ___
> Hydrogen-devel mailing list
> Hydrogen-devel@lists.sourceforge.net
> https://lists.sourceforge.net/lists/listinfo/hydrogen-devel
>



-- 
follow me on my Audio & Linux blog  !
--
Announcing the Oxford

Re: [Hydrogen-devel] Help wanted: Documentation / Further documentation plans

2017-03-13 Thread Jérémy Zurcher 
Hi,

have a separate repo for the manual  use github API !!

available API :
$ curl https://api.github.com/repos/hydrogen-music/hydrogen

latest commit metadata:
$ curl https://api.github.com/repos/hydrogen-music/hydrogen/commits/HEAD

download HEAD:
$ curl -L https://api.github.com/repos/hydrogen-music/hydrogen/zipball > 
h2.zip 

H2 could then ask for HEAD metadata, and update it's local manual from
github when needed.


On Monday 13 March 2017  08:20, Thijs van severen wrote :
> Hi
> 
> I did a big portion of the last update and -if time permits- want to help
> with this again, but first i need to get some new features in H2 that I
> really really need for playing live and am currently trying to implement.
> 
> I remember talking about an 'update able manual'.  In other words a
> document that is not part of the binary, but that is provided with the
> installer and can be (auto) updated whenever a new version is available.
> Typically the manual lags behind the code development and thus is 'never'
> up to date.  Decoupling code and manual also makes sure that the release is
> not delayed by an incomplete manual.
> 
> Thinking about the suggestion you made about git: that makes a lot of sense
> if we should switch to the 'update able manual'.  Imagine a new feature
> that needs to be added to the manual. This would only be added to the
> manual branch for the latest code.  But if you fix an error in a part of
> the manual that is common to all H2 version, git can easily handle this and
> push the fix to all manual branches.
> 
> Would it be possible to let H2 get the manual directly from git ? I guess
> this requires git functionality on the user side that is not always
> available. Maybe an export to pdf would be preferable.
> 
> Ideas?
> 
> Grtz
> Thijs
> 
> Op 11 mrt. 2017 11:35 a.m. schreef :
> 
> > Hi everyone!
> >
> > As you most of you already know, the hydrogen manual and tutorial are
> > getting more and more deprecated since those documents were not updated
> > for some time.. Is there anyone on this list who has an interested in
> > writing and who would be interested in helping with updating the manual?
> >
> > Apart from that, i'm currently thinking about putting the documentation
> > (manual and tutorial) in a separate git repository. This helps to keep
> > the source code repository small (i suppose that over time, more and
> > more larger images will be added to the manual) and allows for a better
> > permission-management for our repositories.
> >
> > Best regards,
> > Sebastian
> >
> >
> > 
> > --
> > Announcing the Oxford Dictionaries API! The API offers world-renowned
> > dictionary content that is easy and intuitive to access. Sign up for an
> > account today to start using our lexical data to power your apps and
> > projects. Get started today and enter our developer competition.
> > http://sdm.link/oxford
> > ___
> > Hydrogen-devel mailing list
> > Hydrogen-devel@lists.sourceforge.net
> > https://lists.sourceforge.net/lists/listinfo/hydrogen-devel
> >

> --
> Announcing the Oxford Dictionaries API! The API offers world-renowned
> dictionary content that is easy and intuitive to access. Sign up for an
> account today to start using our lexical data to power your apps and
> projects. Get started today and enter our developer competition.
> http://sdm.link/oxford

> ___
> Hydrogen-devel mailing list
> Hydrogen-devel@lists.sourceforge.net
> https://lists.sourceforge.net/lists/listinfo/hydrogen-devel

---
Jérémy Zurcher
rue des Charmilles 7
1400 Yverdon-les-bains
+41 (0) 79 599 84 27

--
Announcing the Oxford Dictionaries API! The API offers world-renowned
dictionary content that is easy and intuitive to access. Sign up for an
account today to start using our lexical data to power your apps and
projects. Get started today and enter our developer competition.
http://sdm.link/oxford
___
Hydrogen-devel mailing list
Hydrogen-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/hydrogen-devel

Re: [Hydrogen-devel] Help wanted: Documentation / Further documentation plans

2017-03-13 Thread Thijs van severen 
Hi

I did a big portion of the last update and -if time permits- want to help
with this again, but first i need to get some new features in H2 that I
really really need for playing live and am currently trying to implement.

I remember talking about an 'update able manual'.  In other words a
document that is not part of the binary, but that is provided with the
installer and can be (auto) updated whenever a new version is available.
Typically the manual lags behind the code development and thus is 'never'
up to date.  Decoupling code and manual also makes sure that the release is
not delayed by an incomplete manual.

Thinking about the suggestion you made about git: that makes a lot of sense
if we should switch to the 'update able manual'.  Imagine a new feature
that needs to be added to the manual. This would only be added to the
manual branch for the latest code.  But if you fix an error in a part of
the manual that is common to all H2 version, git can easily handle this and
push the fix to all manual branches.

Would it be possible to let H2 get the manual directly from git ? I guess
this requires git functionality on the user side that is not always
available. Maybe an export to pdf would be preferable.

Ideas?

Grtz
Thijs

Op 11 mrt. 2017 11:35 a.m. schreef :

> Hi everyone!
>
> As you most of you already know, the hydrogen manual and tutorial are
> getting more and more deprecated since those documents were not updated
> for some time.. Is there anyone on this list who has an interested in
> writing and who would be interested in helping with updating the manual?
>
> Apart from that, i'm currently thinking about putting the documentation
> (manual and tutorial) in a separate git repository. This helps to keep
> the source code repository small (i suppose that over time, more and
> more larger images will be added to the manual) and allows for a better
> permission-management for our repositories.
>
> Best regards,
> Sebastian
>
>
> 
> --
> Announcing the Oxford Dictionaries API! The API offers world-renowned
> dictionary content that is easy and intuitive to access. Sign up for an
> account today to start using our lexical data to power your apps and
> projects. Get started today and enter our developer competition.
> http://sdm.link/oxford
> ___
> Hydrogen-devel mailing list
> Hydrogen-devel@lists.sourceforge.net
> https://lists.sourceforge.net/lists/listinfo/hydrogen-devel
>
--
Announcing the Oxford Dictionaries API! The API offers world-renowned
dictionary content that is easy and intuitive to access. Sign up for an
account today to start using our lexical data to power your apps and
projects. Get started today and enter our developer competition.
http://sdm.link/oxford___
Hydrogen-devel mailing list
Hydrogen-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/hydrogen-devel

[Hydrogen-devel] Help wanted: Documentation / Further documentation plans

2017-03-11 Thread mauser 
Hi everyone!

As you most of you already know, the hydrogen manual and tutorial are 
getting more and more deprecated since those documents were not updated 
for some time.. Is there anyone on this list who has an interested in 
writing and who would be interested in helping with updating the manual?

Apart from that, i'm currently thinking about putting the documentation 
(manual and tutorial) in a separate git repository. This helps to keep 
the source code repository small (i suppose that over time, more and 
more larger images will be added to the manual) and allows for a better 
permission-management for our repositories.

Best regards,
Sebastian


--
Announcing the Oxford Dictionaries API! The API offers world-renowned
dictionary content that is easy and intuitive to access. Sign up for an
account today to start using our lexical data to power your apps and
projects. Get started today and enter our developer competition.
http://sdm.link/oxford
___
Hydrogen-devel mailing list
Hydrogen-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/hydrogen-devel