Re: [Mixxx-devel] Mixxx User Manual updates

[Sean M. Pappalardo - D.J. Pegasus]

Oh, I remember why it's a separate repo: size. We didn't want to require
someone who only wanted to work on the manual to have to get the entire
Mixxx repo. However, there is sparse checkout which addresses this use case:
https://stackoverflow.com/questions/600079/how-do-i-clone-a-subdirectory-only-of-a-git-repository/13738951#13738951

Sincerely,
Sean M. Pappalardo
"D.J. Pegasus"
Mixxx Developer - Controller Specialist



smime.p7s
Description: S/MIME Cryptographic Signature
--
Check out the vibrant tech community on one of the world's most
engaging tech sites, Slashdot.org! http://sdm.link/slashdot___
Get Mixxx, the #1 Free MP3 DJ Mixing software Today
http://mixxx.org


Mixxx-devel mailing list
Mixxx-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/mixxx-devel

Re: [Mixxx-devel] Mixxx User Manual updates

[Sean M. Pappalardo - D.J. Pegasus]

Hello.

Sorry for the very delayed response. I agree with everything you said.
See below.

On 06/24/2017 03:21 AM, Sébastien Blaisot wrote:
> Having the manual in a separate github project doesn't help to sync code
> merge and manual update.
> 
> Other projects manage this by asking contributors in PR to update manual
> before accepting merge.
> No manual update, no code merge. (at least for each code change that
> change the interface or behaviour)
> 
> is it possible to move the manual inside the same github project ?

Yes, it is. I figure making it a subdirectory of the root would make the
most sense. (The only thing I wonder is if doing so will complicate
distro packaging, where they may think that Sphinx and Graphviz are
required to build Mixxx itself.)

So let's review and merge the four pending PRs against the manual repo,
then we can add it to the main one and delete the separate one.
https://github.com/mixxxdj/manual/pulls

Sincerely,
Sean M. Pappalardo
"D.J. Pegasus"
Mixxx Developer - Controller Specialist



smime.p7s
Description: S/MIME Cryptographic Signature
--
Check out the vibrant tech community on one of the world's most
engaging tech sites, Slashdot.org! http://sdm.link/slashdot___
Get Mixxx, the #1 Free MP3 DJ Mixing software Today
http://mixxx.org


Mixxx-devel mailing list
Mixxx-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/mixxx-devel

Re: [Mixxx-devel] Mixxx User Manual updates

[Be]

I agree that keeping the manual in the code repository would make it 
easier to maintain.


On 06/24/2017 05:21 AM, Sébastien Blaisot wrote:


Hi Everyone,

Having the manual in a separate github project doesn't help to sync code 
merge and manual update.


Other projects manage this by asking contributors in PR to update manual 
before accepting merge.
No manual update, no code merge. (at least for each code change that 
change the interface or behaviour)


is it possible to move the manual inside the same github project ?

sb


Le 23/06/2017 à 19:28, Sean M. Pappalardo - D.J. Pegasus a écrit :

Hello everyone.

With all of the recent development going on, especially the GSoC
projects, I want to remind everyone that it is extremely important that
the user manual is also updated whenever new features are merged to
master so we can release quickly. (Otherwise waiting on user manual
updates will block the process.) And documenting how the feature works
is of course much easier when you've just recently worked on it.

The manual is also stored in GitHub here: 
https://github.com/mixxxdj/manual

It uses reStructuredText and you can clone it just like any code base or
edit it right on GitHub. See the ReadMe at the link for details.
We are able to generate Web pages (http://mixxx.org/manual/latest/) and
PDFs (https://mixxx.org/manual/latest/Mixxx-Manual.pdf) from the same
reST source.

Thanks everyone for helping with this as the project leads continue to
fix the release process.

Sincerely,
Sean M. Pappalardo
"D.J. Pegasus"
Mixxx Developer - Controller Specialist



-- 


Check out the vibrant tech community on one of the world's most
engaging tech sites, Slashdot.org! http://sdm.link/slashdot
___
Get Mixxx, the #1 Free MP3 DJ Mixing software Today
http://mixxx.org


Mixxx-devel mailing list
Mixxx-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/mixxx-devel


--
Check out the vibrant tech community on one of the world's most
engaging tech sites, Slashdot.org! http://sdm.link/slashdot
___
Get Mixxx, the #1 Free MP3 DJ Mixing software Today
http://mixxx.org


Mixxx-devel mailing list
Mixxx-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/mixxx-devel

Re: [Mixxx-devel] Mixxx User Manual updates

[S.Brandt]

Hi, started working on 2.1 manual updates if time allowed, just submitted a PR 
so that there is no duplicate work done.
https://github.com/mixxxdj/manual/pull/59 
--
Check out the vibrant tech community on one of the world's most
engaging tech sites, Slashdot.org! http://sdm.link/slashdot___
Get Mixxx, the #1 Free MP3 DJ Mixing software Today
http://mixxx.org


Mixxx-devel mailing list
Mixxx-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/mixxx-devel

Re: [Mixxx-devel] Mixxx User Manual updates

[Sébastien Blaisot]

Hi Everyone,

Having the manual in a separate github project doesn't help to sync code 
merge and manual update.


Other projects manage this by asking contributors in PR to update manual 
before accepting merge.
No manual update, no code merge. (at least for each code change that 
change the interface or behaviour)


is it possible to move the manual inside the same github project ?

sb


Le 23/06/2017 à 19:28, Sean M. Pappalardo - D.J. Pegasus a écrit :

Hello everyone.

With all of the recent development going on, especially the GSoC
projects, I want to remind everyone that it is extremely important that
the user manual is also updated whenever new features are merged to
master so we can release quickly. (Otherwise waiting on user manual
updates will block the process.) And documenting how the feature works
is of course much easier when you've just recently worked on it.

The manual is also stored in GitHub here: https://github.com/mixxxdj/manual
It uses reStructuredText and you can clone it just like any code base or
edit it right on GitHub. See the ReadMe at the link for details.
We are able to generate Web pages (http://mixxx.org/manual/latest/) and
PDFs (https://mixxx.org/manual/latest/Mixxx-Manual.pdf) from the same
reST source.

Thanks everyone for helping with this as the project leads continue to
fix the release process.

Sincerely,
Sean M. Pappalardo
"D.J. Pegasus"
Mixxx Developer - Controller Specialist



--
Check out the vibrant tech community on one of the world's most
engaging tech sites, Slashdot.org! http://sdm.link/slashdot
___
Get Mixxx, the #1 Free MP3 DJ Mixing software Today
http://mixxx.org


Mixxx-devel mailing list
Mixxx-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/mixxx-devel

Re: [Mixxx-devel] Mixxx User Manual updates

[Be]

Thanks for the reminder. The manual does need a lot of work. There were 
features added in 2.0 that still are not documented, such as split cue 
mode and how to use this with just a laptop's onboard sound card and 
headphones. We need more examples and diagrams for the Hardware Setup 
chapter. We need examples of hardware setups for broadcasting. A lot of 
confused users come to the forum asking about broadcasting setups with 
hardware that doesn't work well for this purpose like USB microphones. I 
would like to work on this after merging the mic I/O revamp branch ( 
https://github.com/mixxxdj/mixxx/pull/1279 ) because that has many 
implications for that chapter of the manual.


We could also use documentation on how to set up Mixxx's inputs and 
outputs with other software like Skype and Second Life. I think this 
gets complicated and ugly with different combinations of software, 
hardware, and the sound APIs they support, especially on Windows. If 
someone could do some research and experimenting with different setups 
and document the results that would be great. This would be most 
appropriate to add to the Hardware Setup chapter, but then we should 
rename it to "Sound Input & Output Setup" or something similar.


All of the screenshots in the manual and the Mixxx UI chapter need to be 
updated for the new skins.


On 06/23/2017 12:28 PM, Sean M. Pappalardo - D.J. Pegasus wrote:

Hello everyone.

With all of the recent development going on, especially the GSoC
projects, I want to remind everyone that it is extremely important that
the user manual is also updated whenever new features are merged to
master so we can release quickly. (Otherwise waiting on user manual
updates will block the process.) And documenting how the feature works
is of course much easier when you've just recently worked on it.

The manual is also stored in GitHub here: https://github.com/mixxxdj/manual
It uses reStructuredText and you can clone it just like any code base or
edit it right on GitHub. See the ReadMe at the link for details.
We are able to generate Web pages (http://mixxx.org/manual/latest/) and
PDFs (https://mixxx.org/manual/latest/Mixxx-Manual.pdf) from the same
reST source.

Thanks everyone for helping with this as the project leads continue to
fix the release process.

Sincerely,
Sean M. Pappalardo
"D.J. Pegasus"
Mixxx Developer - Controller Specialist



--
Check out the vibrant tech community on one of the world's most
engaging tech sites, Slashdot.org! http://sdm.link/slashdot



___
Get Mixxx, the #1 Free MP3 DJ Mixing software Today
http://mixxx.org


Mixxx-devel mailing list
Mixxx-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/mixxx-devel



--
Check out the vibrant tech community on one of the world's most
engaging tech sites, Slashdot.org! http://sdm.link/slashdot
___
Get Mixxx, the #1 Free MP3 DJ Mixing software Today
http://mixxx.org


Mixxx-devel mailing list
Mixxx-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/mixxx-devel