Quantcast

Documentation tasks!

classic Classic list List threaded Threaded
9 messages Options
Reply | Threaded
Open this post in threaded view
|  
Report Content as Inappropriate
star

Documentation tasks!

weierophinney
Administrator
Hey, all!

RC1 is out.

There's a lot of docs that need to be updated or written, though!


Enrico has compiled a list of tasks:

    https://gist.github.com/3183360

Anything not marked "(ok)" needs some attention.

Documentation is now in the zf2-documentation repository:

    https://github.com/zendframework/zf2-documentation

Additionally, documentation is now done using reStructured Text (reST or
rst). One benefit this has is that you can edit the docs online, in the
github interface, if you want!

So, what are you waiting for? Help out the project, yourself, and those
trying to learn, and start writing and updating docs!

--
Matthew Weier O'Phinney
Project Lead            | [hidden email]
Zend Framework          | http://framework.zend.com/
PGP key: http://framework.zend.com/zf-matthew-pgp-key.asc
Reply | Threaded
Open this post in threaded view
|  
Report Content as Inappropriate
star

Re: Documentation tasks!

Jonathan Maron
Hello Matthew

As the maintainer of the Service component LiveDocx, I have a question
concerning the documentation for all Service components, which
recently got moved from the main zf2 repository to their own
repositories.

I see that the documentation for LiveDocx is in the main repository:

https://github.com/zendframework/zf2-documentation/blob/master/docs/languages/en/modules/zend.service.live-docx.rst

Yet the actual components and tests are at:

https://github.com/zendframework/ZendServiceLiveDocx

Is this intentional? i.e. will the documentation for the Service
components be part of the main zf2 documentation, or will the
documentation be moved to the new Service repositories in due course?

If it remains in the main zf2 documentation, I need to update the
documentation of the LiveDocx component, explaining how to install the
component.

Thank you in advance

Jonathan Maron



On Thu, Jul 26, 2012 at 9:03 PM, Matthew Weier O'Phinney
<[hidden email]> wrote:

> Hey, all!
>
> RC1 is out.
>
> There's a lot of docs that need to be updated or written, though!
>
>
> Enrico has compiled a list of tasks:
>
>     https://gist.github.com/3183360
>
> Anything not marked "(ok)" needs some attention.
>
> Documentation is now in the zf2-documentation repository:
>
>     https://github.com/zendframework/zf2-documentation
>
> Additionally, documentation is now done using reStructured Text (reST or
> rst). One benefit this has is that you can edit the docs online, in the
> github interface, if you want!
>
> So, what are you waiting for? Help out the project, yourself, and those
> trying to learn, and start writing and updating docs!
>
> --
> Matthew Weier O'Phinney
> Project Lead            | [hidden email]
> Zend Framework          | http://framework.zend.com/
> PGP key: http://framework.zend.com/zf-matthew-pgp-key.asc
Reply | Threaded
Open this post in threaded view
|  
Report Content as Inappropriate
star

Re: Documentation tasks!

weierophinney
Administrator
-- Jonathan Maron <[hidden email]> wrote
(on Friday, 27 July 2012, 07:22 AM +0200):

> As the maintainer of the Service component LiveDocx, I have a question
> concerning the documentation for all Service components, which
> recently got moved from the main zf2 repository to their own
> repositories.
>
> I see that the documentation for LiveDocx is in the main repository:
>
> https://github.com/zendframework/zf2-documentation/blob/master/docs/languages/en/modules/zend.service.live-docx.rst
>
> Yet the actual components and tests are at:
>
> https://github.com/zendframework/ZendServiceLiveDocx
>
> Is this intentional? i.e. will the documentation for the Service
> components be part of the main zf2 documentation, or will the
> documentation be moved to the new Service repositories in due course?
>
> If it remains in the main zf2 documentation, I need to update the
> documentation of the LiveDocx component, explaining how to install the
> component.

For now, we plan to keep the docs in the main zf2-documentation repo. We
may move them to the individual service repos at a later date, but we're
still trying to figure out (a) if that makes sense, and (b), if it does,
how we'd go about building, packaging, and deploying docs for each of
them.

So, for the meantime, just work with the zf2-documentation repository.


> On Thu, Jul 26, 2012 at 9:03 PM, Matthew Weier O'Phinney
> <[hidden email]> wrote:
> > Hey, all!
> >
> > RC1 is out.
> >
> > There's a lot of docs that need to be updated or written, though!
> >
> >
> > Enrico has compiled a list of tasks:
> >
> >     https://gist.github.com/3183360
> >
> > Anything not marked "(ok)" needs some attention.
> >
> > Documentation is now in the zf2-documentation repository:
> >
> >     https://github.com/zendframework/zf2-documentation
> >
> > Additionally, documentation is now done using reStructured Text (reST or
> > rst). One benefit this has is that you can edit the docs online, in the
> > github interface, if you want!
> >
> > So, what are you waiting for? Help out the project, yourself, and those
> > trying to learn, and start writing and updating docs!
> >
> > --
> > Matthew Weier O'Phinney
> > Project Lead            | [hidden email]
> > Zend Framework          | http://framework.zend.com/
> > PGP key: http://framework.zend.com/zf-matthew-pgp-key.asc
>

--
Matthew Weier O'Phinney
Project Lead            | [hidden email]
Zend Framework          | http://framework.zend.com/
PGP key: http://framework.zend.com/zf-matthew-pgp-key.asc
Reply | Threaded
Open this post in threaded view
|  
Report Content as Inappropriate
star

Re: Documentation tasks!

Jonathan Maron
Hello Matthew

Thank you for clarification.

I have started work on porting the documentation to ZF2:

https://github.com/jonathanmaron/zf2-documentation/blob/livedocx-2.1/docs/languages/en/modules/zend.service.live-docx.rst

This is still a work in progress. I will send you a PR, when I am done.

I have also worked a lot on the actual LiveDocx components in the new
Services repository:

https://github.com/jonathanmaron/ZendServiceLiveDocx

Again, this is still a work in progress, but I expect to be through
within a week or so.

I have updated the ZF2 code to use the latest LiveDocx 2.1 service
(even faster and more reliable) and re-added all the demo applications
(these are highly valued by LiveDocx users).

Again, I will send you a PR, when I am done.

Thank you for your continuing assistance.

;-)

With best regards

Jonathan Maron




On Fri, Jul 27, 2012 at 4:16 PM, Matthew Weier O'Phinney
<[hidden email]> wrote:

> -- Jonathan Maron <[hidden email]> wrote
> (on Friday, 27 July 2012, 07:22 AM +0200):
>> As the maintainer of the Service component LiveDocx, I have a question
>> concerning the documentation for all Service components, which
>> recently got moved from the main zf2 repository to their own
>> repositories.
>>
>> I see that the documentation for LiveDocx is in the main repository:
>>
>> https://github.com/zendframework/zf2-documentation/blob/master/docs/languages/en/modules/zend.service.live-docx.rst
>>
>> Yet the actual components and tests are at:
>>
>> https://github.com/zendframework/ZendServiceLiveDocx
>>
>> Is this intentional? i.e. will the documentation for the Service
>> components be part of the main zf2 documentation, or will the
>> documentation be moved to the new Service repositories in due course?
>>
>> If it remains in the main zf2 documentation, I need to update the
>> documentation of the LiveDocx component, explaining how to install the
>> component.
>
> For now, we plan to keep the docs in the main zf2-documentation repo. We
> may move them to the individual service repos at a later date, but we're
> still trying to figure out (a) if that makes sense, and (b), if it does,
> how we'd go about building, packaging, and deploying docs for each of
> them.
>
> So, for the meantime, just work with the zf2-documentation repository.
>
>
>> On Thu, Jul 26, 2012 at 9:03 PM, Matthew Weier O'Phinney
>> <[hidden email]> wrote:
>> > Hey, all!
>> >
>> > RC1 is out.
>> >
>> > There's a lot of docs that need to be updated or written, though!
>> >
>> >
>> > Enrico has compiled a list of tasks:
>> >
>> >     https://gist.github.com/3183360
>> >
>> > Anything not marked "(ok)" needs some attention.
>> >
>> > Documentation is now in the zf2-documentation repository:
>> >
>> >     https://github.com/zendframework/zf2-documentation
>> >
>> > Additionally, documentation is now done using reStructured Text (reST or
>> > rst). One benefit this has is that you can edit the docs online, in the
>> > github interface, if you want!
>> >
>> > So, what are you waiting for? Help out the project, yourself, and those
>> > trying to learn, and start writing and updating docs!
>> >
>> > --
>> > Matthew Weier O'Phinney
>> > Project Lead            | [hidden email]
>> > Zend Framework          | http://framework.zend.com/
>> > PGP key: http://framework.zend.com/zf-matthew-pgp-key.asc
>>
>
> --
> Matthew Weier O'Phinney
> Project Lead            | [hidden email]
> Zend Framework          | http://framework.zend.com/
> PGP key: http://framework.zend.com/zf-matthew-pgp-key.asc
Reply | Threaded
Open this post in threaded view
|  
Report Content as Inappropriate
star

Re: Documentation tasks!

Jonathan Maron
Hello

I have just been reviewing the documentation for ZendService\LiveDocx
that was merged into the main repository yesterday:

http://zf2.readthedocs.org/en/latest/modules/zend.service.live-docx.html

I was only able to find the page about ZendService\LiveDocx after
searching the manual.

In the table of contents, I do not see any link to the above page:

http://zf2.readthedocs.org/en/latest/

What do I have to do to add a section for ZendService and ultimately
for ZendService\LiveDocx in the table of contents and index?

TIA

Jonathan Maron



On Wed, Aug 1, 2012 at 5:17 PM, Jonathan Maron
<[hidden email]> wrote:

> Hello Matthew
>
> Thank you for clarification.
>
> I have started work on porting the documentation to ZF2:
>
> https://github.com/jonathanmaron/zf2-documentation/blob/livedocx-2.1/docs/languages/en/modules/zend.service.live-docx.rst
>
> This is still a work in progress. I will send you a PR, when I am done.
>
> I have also worked a lot on the actual LiveDocx components in the new
> Services repository:
>
> https://github.com/jonathanmaron/ZendServiceLiveDocx
>
> Again, this is still a work in progress, but I expect to be through
> within a week or so.
>
> I have updated the ZF2 code to use the latest LiveDocx 2.1 service
> (even faster and more reliable) and re-added all the demo applications
> (these are highly valued by LiveDocx users).
>
> Again, I will send you a PR, when I am done.
>
> Thank you for your continuing assistance.
>
> ;-)
>
> With best regards
>
> Jonathan Maron
>
>
>
>
> On Fri, Jul 27, 2012 at 4:16 PM, Matthew Weier O'Phinney
> <[hidden email]> wrote:
>> -- Jonathan Maron <[hidden email]> wrote
>> (on Friday, 27 July 2012, 07:22 AM +0200):
>>> As the maintainer of the Service component LiveDocx, I have a question
>>> concerning the documentation for all Service components, which
>>> recently got moved from the main zf2 repository to their own
>>> repositories.
>>>
>>> I see that the documentation for LiveDocx is in the main repository:
>>>
>>> https://github.com/zendframework/zf2-documentation/blob/master/docs/languages/en/modules/zend.service.live-docx.rst
>>>
>>> Yet the actual components and tests are at:
>>>
>>> https://github.com/zendframework/ZendServiceLiveDocx
>>>
>>> Is this intentional? i.e. will the documentation for the Service
>>> components be part of the main zf2 documentation, or will the
>>> documentation be moved to the new Service repositories in due course?
>>>
>>> If it remains in the main zf2 documentation, I need to update the
>>> documentation of the LiveDocx component, explaining how to install the
>>> component.
>>
>> For now, we plan to keep the docs in the main zf2-documentation repo. We
>> may move them to the individual service repos at a later date, but we're
>> still trying to figure out (a) if that makes sense, and (b), if it does,
>> how we'd go about building, packaging, and deploying docs for each of
>> them.
>>
>> So, for the meantime, just work with the zf2-documentation repository.
>>
>>
>>> On Thu, Jul 26, 2012 at 9:03 PM, Matthew Weier O'Phinney
>>> <[hidden email]> wrote:
>>> > Hey, all!
>>> >
>>> > RC1 is out.
>>> >
>>> > There's a lot of docs that need to be updated or written, though!
>>> >
>>> >
>>> > Enrico has compiled a list of tasks:
>>> >
>>> >     https://gist.github.com/3183360
>>> >
>>> > Anything not marked "(ok)" needs some attention.
>>> >
>>> > Documentation is now in the zf2-documentation repository:
>>> >
>>> >     https://github.com/zendframework/zf2-documentation
>>> >
>>> > Additionally, documentation is now done using reStructured Text (reST or
>>> > rst). One benefit this has is that you can edit the docs online, in the
>>> > github interface, if you want!
>>> >
>>> > So, what are you waiting for? Help out the project, yourself, and those
>>> > trying to learn, and start writing and updating docs!
>>> >
>>> > --
>>> > Matthew Weier O'Phinney
>>> > Project Lead            | [hidden email]
>>> > Zend Framework          | http://framework.zend.com/
>>> > PGP key: http://framework.zend.com/zf-matthew-pgp-key.asc
>>>
>>
>> --
>> Matthew Weier O'Phinney
>> Project Lead            | [hidden email]
>> Zend Framework          | http://framework.zend.com/
>> PGP key: http://framework.zend.com/zf-matthew-pgp-key.asc
Reply | Threaded
Open this post in threaded view
|  
Report Content as Inappropriate
star

Re: Documentation tasks!

Mickael Perraud
Hi Jonathan,

You need to complete the doctree (top of the file) and the main page (before the line '.. _zend.ldap:') in https://github.com/zendframework/zf2-documentation/blob/master/docs/languages/en/index.rst

--
Mickaël Perraud

Website | http://mikaelkael.fr
Twitter | http://twitter.com/mikaelkael
PGP key | http://mikaelkael.fr/mikaelkael.asc



2012/8/9 Jonathan Maron <[hidden email]>
Hello

I have just been reviewing the documentation for ZendService\LiveDocx
that was merged into the main repository yesterday:

http://zf2.readthedocs.org/en/latest/modules/zend.service.live-docx.html

I was only able to find the page about ZendService\LiveDocx after
searching the manual.

In the table of contents, I do not see any link to the above page:

http://zf2.readthedocs.org/en/latest/

What do I have to do to add a section for ZendService and ultimately
for ZendService\LiveDocx in the table of contents and index?

TIA

Jonathan Maron



On Wed, Aug 1, 2012 at 5:17 PM, Jonathan Maron
<[hidden email]> wrote:
> Hello Matthew
>
> Thank you for clarification.
>
> I have started work on porting the documentation to ZF2:
>
> https://github.com/jonathanmaron/zf2-documentation/blob/livedocx-2.1/docs/languages/en/modules/zend.service.live-docx.rst
>
> This is still a work in progress. I will send you a PR, when I am done.
>
> I have also worked a lot on the actual LiveDocx components in the new
> Services repository:
>
> https://github.com/jonathanmaron/ZendServiceLiveDocx
>
> Again, this is still a work in progress, but I expect to be through
> within a week or so.
>
> I have updated the ZF2 code to use the latest LiveDocx 2.1 service
> (even faster and more reliable) and re-added all the demo applications
> (these are highly valued by LiveDocx users).
>
> Again, I will send you a PR, when I am done.
>
> Thank you for your continuing assistance.
>
> ;-)
>
> With best regards
>
> Jonathan Maron
>
>
>
>
> On Fri, Jul 27, 2012 at 4:16 PM, Matthew Weier O'Phinney
> <[hidden email]> wrote:
>> -- Jonathan Maron <[hidden email]> wrote
>> (on Friday, 27 July 2012, 07:22 AM +0200):
>>> As the maintainer of the Service component LiveDocx, I have a question
>>> concerning the documentation for all Service components, which
>>> recently got moved from the main zf2 repository to their own
>>> repositories.
>>>
>>> I see that the documentation for LiveDocx is in the main repository:
>>>
>>> https://github.com/zendframework/zf2-documentation/blob/master/docs/languages/en/modules/zend.service.live-docx.rst
>>>
>>> Yet the actual components and tests are at:
>>>
>>> https://github.com/zendframework/ZendServiceLiveDocx
>>>
>>> Is this intentional? i.e. will the documentation for the Service
>>> components be part of the main zf2 documentation, or will the
>>> documentation be moved to the new Service repositories in due course?
>>>
>>> If it remains in the main zf2 documentation, I need to update the
>>> documentation of the LiveDocx component, explaining how to install the
>>> component.
>>
>> For now, we plan to keep the docs in the main zf2-documentation repo. We
>> may move them to the individual service repos at a later date, but we're
>> still trying to figure out (a) if that makes sense, and (b), if it does,
>> how we'd go about building, packaging, and deploying docs for each of
>> them.
>>
>> So, for the meantime, just work with the zf2-documentation repository.
>>
>>
>>> On Thu, Jul 26, 2012 at 9:03 PM, Matthew Weier O'Phinney
>>> <[hidden email]> wrote:
>>> > Hey, all!
>>> >
>>> > RC1 is out.
>>> >
>>> > There's a lot of docs that need to be updated or written, though!
>>> >
>>> >
>>> > Enrico has compiled a list of tasks:
>>> >
>>> >     https://gist.github.com/3183360
>>> >
>>> > Anything not marked "(ok)" needs some attention.
>>> >
>>> > Documentation is now in the zf2-documentation repository:
>>> >
>>> >     https://github.com/zendframework/zf2-documentation
>>> >
>>> > Additionally, documentation is now done using reStructured Text (reST or
>>> > rst). One benefit this has is that you can edit the docs online, in the
>>> > github interface, if you want!
>>> >
>>> > So, what are you waiting for? Help out the project, yourself, and those
>>> > trying to learn, and start writing and updating docs!
>>> >
>>> > --
>>> > Matthew Weier O'Phinney
>>> > Project Lead            | [hidden email]
>>> > Zend Framework          | http://framework.zend.com/
>>> > PGP key: http://framework.zend.com/zf-matthew-pgp-key.asc
>>>
>>
>> --
>> Matthew Weier O'Phinney
>> Project Lead            | [hidden email]
>> Zend Framework          | http://framework.zend.com/
>> PGP key: http://framework.zend.com/zf-matthew-pgp-key.asc

Reply | Threaded
Open this post in threaded view
|  
Report Content as Inappropriate
star

Re: Documentation tasks!

Mickael Perraud
Hi,

Sphinx render all rst files in the 'en' directory. For examples, we will find the old http://zf2.readthedocs.org/en/latest/modules/zend.debug.html or http://zf2.readthedocs.org/en/latest/modules/zend.filter.html even if it's not in the main page.

Sometimes we can find files with '.old' extension. In this case, it's of course not rendered.

Instead of renaming all the files that we don't want in the main manual, we could create a 'non-ready' directory and add it to the conf.py param 'exclude_dirnames'

--
Mickaël Perraud

Website | http://mikaelkael.fr
Twitter | http://twitter.com/mikaelkael
PGP key | http://mikaelkael.fr/mikaelkael.asc



2012/8/9 Mickael Perraud <[hidden email]>
Hi Jonathan,

You need to complete the doctree (top of the file) and the main page (before the line '.. _zend.ldap:') in https://github.com/zendframework/zf2-documentation/blob/master/docs/languages/en/index.rst

--
Mickaël Perraud

Website | http://mikaelkael.fr
Twitter | http://twitter.com/mikaelkael
PGP key | http://mikaelkael.fr/mikaelkael.asc



2012/8/9 Jonathan Maron <[hidden email]>
Hello

I have just been reviewing the documentation for ZendService\LiveDocx
that was merged into the main repository yesterday:

http://zf2.readthedocs.org/en/latest/modules/zend.service.live-docx.html

I was only able to find the page about ZendService\LiveDocx after
searching the manual.

In the table of contents, I do not see any link to the above page:

http://zf2.readthedocs.org/en/latest/

What do I have to do to add a section for ZendService and ultimately
for ZendService\LiveDocx in the table of contents and index?

TIA

Jonathan Maron



On Wed, Aug 1, 2012 at 5:17 PM, Jonathan Maron
<[hidden email]> wrote:
> Hello Matthew
>
> Thank you for clarification.
>
> I have started work on porting the documentation to ZF2:
>
> https://github.com/jonathanmaron/zf2-documentation/blob/livedocx-2.1/docs/languages/en/modules/zend.service.live-docx.rst
>
> This is still a work in progress. I will send you a PR, when I am done.
>
> I have also worked a lot on the actual LiveDocx components in the new
> Services repository:
>
> https://github.com/jonathanmaron/ZendServiceLiveDocx
>
> Again, this is still a work in progress, but I expect to be through
> within a week or so.
>
> I have updated the ZF2 code to use the latest LiveDocx 2.1 service
> (even faster and more reliable) and re-added all the demo applications
> (these are highly valued by LiveDocx users).
>
> Again, I will send you a PR, when I am done.
>
> Thank you for your continuing assistance.
>
> ;-)
>
> With best regards
>
> Jonathan Maron
>
>
>
>
> On Fri, Jul 27, 2012 at 4:16 PM, Matthew Weier O'Phinney
> <[hidden email]> wrote:
>> -- Jonathan Maron <[hidden email]> wrote
>> (on Friday, 27 July 2012, 07:22 AM +0200):
>>> As the maintainer of the Service component LiveDocx, I have a question
>>> concerning the documentation for all Service components, which
>>> recently got moved from the main zf2 repository to their own
>>> repositories.
>>>
>>> I see that the documentation for LiveDocx is in the main repository:
>>>
>>> https://github.com/zendframework/zf2-documentation/blob/master/docs/languages/en/modules/zend.service.live-docx.rst
>>>
>>> Yet the actual components and tests are at:
>>>
>>> https://github.com/zendframework/ZendServiceLiveDocx
>>>
>>> Is this intentional? i.e. will the documentation for the Service
>>> components be part of the main zf2 documentation, or will the
>>> documentation be moved to the new Service repositories in due course?
>>>
>>> If it remains in the main zf2 documentation, I need to update the
>>> documentation of the LiveDocx component, explaining how to install the
>>> component.
>>
>> For now, we plan to keep the docs in the main zf2-documentation repo. We
>> may move them to the individual service repos at a later date, but we're
>> still trying to figure out (a) if that makes sense, and (b), if it does,
>> how we'd go about building, packaging, and deploying docs for each of
>> them.
>>
>> So, for the meantime, just work with the zf2-documentation repository.
>>
>>
>>> On Thu, Jul 26, 2012 at 9:03 PM, Matthew Weier O'Phinney
>>> <[hidden email]> wrote:
>>> > Hey, all!
>>> >
>>> > RC1 is out.
>>> >
>>> > There's a lot of docs that need to be updated or written, though!
>>> >
>>> >
>>> > Enrico has compiled a list of tasks:
>>> >
>>> >     https://gist.github.com/3183360
>>> >
>>> > Anything not marked "(ok)" needs some attention.
>>> >
>>> > Documentation is now in the zf2-documentation repository:
>>> >
>>> >     https://github.com/zendframework/zf2-documentation
>>> >
>>> > Additionally, documentation is now done using reStructured Text (reST or
>>> > rst). One benefit this has is that you can edit the docs online, in the
>>> > github interface, if you want!
>>> >
>>> > So, what are you waiting for? Help out the project, yourself, and those
>>> > trying to learn, and start writing and updating docs!
>>> >
>>> > --
>>> > Matthew Weier O'Phinney
>>> > Project Lead            | [hidden email]
>>> > Zend Framework          | http://framework.zend.com/
>>> > PGP key: http://framework.zend.com/zf-matthew-pgp-key.asc
>>>
>>
>> --
>> Matthew Weier O'Phinney
>> Project Lead            | [hidden email]
>> Zend Framework          | http://framework.zend.com/
>> PGP key: http://framework.zend.com/zf-matthew-pgp-key.asc


Reply | Threaded
Open this post in threaded view
|  
Report Content as Inappropriate
star

Re: Documentation tasks!

Jonathan Maron
In reply to this post by Mickael Perraud
Hello Mickael

Thanks for your assistance. I have updated the appropriate file and
sent a Pull Request:

https://github.com/zendframework/zf2-documentation/pull/139

:-)

Jonathan



On Thu, Aug 9, 2012 at 10:25 AM, Mickael Perraud
<[hidden email]> wrote:

> Hi Jonathan,
>
> You need to complete the doctree (top of the file) and the main page (before
> the line '.. _zend.ldap:') in
> https://github.com/zendframework/zf2-documentation/blob/master/docs/languages/en/index.rst
>
> --
> Mickaël Perraud
> Website | http://mikaelkael.fr
> Twitter | http://twitter.com/mikaelkael
> PGP key | http://mikaelkael.fr/mikaelkael.asc
>
>
>
> 2012/8/9 Jonathan Maron <[hidden email]>
>>
>> Hello
>>
>> I have just been reviewing the documentation for ZendService\LiveDocx
>> that was merged into the main repository yesterday:
>>
>> http://zf2.readthedocs.org/en/latest/modules/zend.service.live-docx.html
>>
>> I was only able to find the page about ZendService\LiveDocx after
>> searching the manual.
>>
>> In the table of contents, I do not see any link to the above page:
>>
>> http://zf2.readthedocs.org/en/latest/
>>
>> What do I have to do to add a section for ZendService and ultimately
>> for ZendService\LiveDocx in the table of contents and index?
>>
>> TIA
>>
>> Jonathan Maron
>>
>>
>>
>> On Wed, Aug 1, 2012 at 5:17 PM, Jonathan Maron
>> <[hidden email]> wrote:
>> > Hello Matthew
>> >
>> > Thank you for clarification.
>> >
>> > I have started work on porting the documentation to ZF2:
>> >
>> >
>> > https://github.com/jonathanmaron/zf2-documentation/blob/livedocx-2.1/docs/languages/en/modules/zend.service.live-docx.rst
>> >
>> > This is still a work in progress. I will send you a PR, when I am done.
>> >
>> > I have also worked a lot on the actual LiveDocx components in the new
>> > Services repository:
>> >
>> > https://github.com/jonathanmaron/ZendServiceLiveDocx
>> >
>> > Again, this is still a work in progress, but I expect to be through
>> > within a week or so.
>> >
>> > I have updated the ZF2 code to use the latest LiveDocx 2.1 service
>> > (even faster and more reliable) and re-added all the demo applications
>> > (these are highly valued by LiveDocx users).
>> >
>> > Again, I will send you a PR, when I am done.
>> >
>> > Thank you for your continuing assistance.
>> >
>> > ;-)
>> >
>> > With best regards
>> >
>> > Jonathan Maron
>> >
>> >
>> >
>> >
>> > On Fri, Jul 27, 2012 at 4:16 PM, Matthew Weier O'Phinney
>> > <[hidden email]> wrote:
>> >> -- Jonathan Maron <[hidden email]> wrote
>> >> (on Friday, 27 July 2012, 07:22 AM +0200):
>> >>> As the maintainer of the Service component LiveDocx, I have a question
>> >>> concerning the documentation for all Service components, which
>> >>> recently got moved from the main zf2 repository to their own
>> >>> repositories.
>> >>>
>> >>> I see that the documentation for LiveDocx is in the main repository:
>> >>>
>> >>>
>> >>> https://github.com/zendframework/zf2-documentation/blob/master/docs/languages/en/modules/zend.service.live-docx.rst
>> >>>
>> >>> Yet the actual components and tests are at:
>> >>>
>> >>> https://github.com/zendframework/ZendServiceLiveDocx
>> >>>
>> >>> Is this intentional? i.e. will the documentation for the Service
>> >>> components be part of the main zf2 documentation, or will the
>> >>> documentation be moved to the new Service repositories in due course?
>> >>>
>> >>> If it remains in the main zf2 documentation, I need to update the
>> >>> documentation of the LiveDocx component, explaining how to install the
>> >>> component.
>> >>
>> >> For now, we plan to keep the docs in the main zf2-documentation repo.
>> >> We
>> >> may move them to the individual service repos at a later date, but
>> >> we're
>> >> still trying to figure out (a) if that makes sense, and (b), if it
>> >> does,
>> >> how we'd go about building, packaging, and deploying docs for each of
>> >> them.
>> >>
>> >> So, for the meantime, just work with the zf2-documentation repository.
>> >>
>> >>
>> >>> On Thu, Jul 26, 2012 at 9:03 PM, Matthew Weier O'Phinney
>> >>> <[hidden email]> wrote:
>> >>> > Hey, all!
>> >>> >
>> >>> > RC1 is out.
>> >>> >
>> >>> > There's a lot of docs that need to be updated or written, though!
>> >>> >
>> >>> >
>> >>> > Enrico has compiled a list of tasks:
>> >>> >
>> >>> >     https://gist.github.com/3183360
>> >>> >
>> >>> > Anything not marked "(ok)" needs some attention.
>> >>> >
>> >>> > Documentation is now in the zf2-documentation repository:
>> >>> >
>> >>> >     https://github.com/zendframework/zf2-documentation
>> >>> >
>> >>> > Additionally, documentation is now done using reStructured Text
>> >>> > (reST or
>> >>> > rst). One benefit this has is that you can edit the docs online, in
>> >>> > the
>> >>> > github interface, if you want!
>> >>> >
>> >>> > So, what are you waiting for? Help out the project, yourself, and
>> >>> > those
>> >>> > trying to learn, and start writing and updating docs!
>> >>> >
>> >>> > --
>> >>> > Matthew Weier O'Phinney
>> >>> > Project Lead            | [hidden email]
>> >>> > Zend Framework          | http://framework.zend.com/
>> >>> > PGP key: http://framework.zend.com/zf-matthew-pgp-key.asc
>> >>>
>> >>
>> >> --
>> >> Matthew Weier O'Phinney
>> >> Project Lead            | [hidden email]
>> >> Zend Framework          | http://framework.zend.com/
>> >> PGP key: http://framework.zend.com/zf-matthew-pgp-key.asc
>
>
Reply | Threaded
Open this post in threaded view
|  
Report Content as Inappropriate
star

Re: Documentation tasks!

Jonathan Maron
Hello all

The documentation for ZendService\LiveDocx contains several images --
more coming soon:

http://zf2.readthedocs.org/en/latest/modules/zend.service.live-docx.html

(or http://zf2.readthedocs.org/en/latest/modules/zendservice.livedocx.html
after last Pull Request)

At the moment, all the images are too large.

Is there a feature of RST to display a small version of the image
(approx. 60% width/height), which when clicked, displays the full
zoomed version.

Something like at http://demo.cldcdn.com/text/ when you click on any
of the thumbnail images? That is the kind of functionality I am
looking for.

TIA

Jonathan Maron



On Thu, Aug 9, 2012 at 11:14 AM, Jonathan Maron
<[hidden email]> wrote:

> Hello Mickael
>
> Thanks for your assistance. I have updated the appropriate file and
> sent a Pull Request:
>
> https://github.com/zendframework/zf2-documentation/pull/139
>
> :-)
>
> Jonathan
>
>
>
> On Thu, Aug 9, 2012 at 10:25 AM, Mickael Perraud
> <[hidden email]> wrote:
>> Hi Jonathan,
>>
>> You need to complete the doctree (top of the file) and the main page (before
>> the line '.. _zend.ldap:') in
>> https://github.com/zendframework/zf2-documentation/blob/master/docs/languages/en/index.rst
>>
>> --
>> Mickaël Perraud
>> Website | http://mikaelkael.fr
>> Twitter | http://twitter.com/mikaelkael
>> PGP key | http://mikaelkael.fr/mikaelkael.asc
>>
>>
>>
>> 2012/8/9 Jonathan Maron <[hidden email]>
>>>
>>> Hello
>>>
>>> I have just been reviewing the documentation for ZendService\LiveDocx
>>> that was merged into the main repository yesterday:
>>>
>>> http://zf2.readthedocs.org/en/latest/modules/zend.service.live-docx.html
>>>
>>> I was only able to find the page about ZendService\LiveDocx after
>>> searching the manual.
>>>
>>> In the table of contents, I do not see any link to the above page:
>>>
>>> http://zf2.readthedocs.org/en/latest/
>>>
>>> What do I have to do to add a section for ZendService and ultimately
>>> for ZendService\LiveDocx in the table of contents and index?
>>>
>>> TIA
>>>
>>> Jonathan Maron
>>>
>>>
>>>
>>> On Wed, Aug 1, 2012 at 5:17 PM, Jonathan Maron
>>> <[hidden email]> wrote:
>>> > Hello Matthew
>>> >
>>> > Thank you for clarification.
>>> >
>>> > I have started work on porting the documentation to ZF2:
>>> >
>>> >
>>> > https://github.com/jonathanmaron/zf2-documentation/blob/livedocx-2.1/docs/languages/en/modules/zend.service.live-docx.rst
>>> >
>>> > This is still a work in progress. I will send you a PR, when I am done.
>>> >
>>> > I have also worked a lot on the actual LiveDocx components in the new
>>> > Services repository:
>>> >
>>> > https://github.com/jonathanmaron/ZendServiceLiveDocx
>>> >
>>> > Again, this is still a work in progress, but I expect to be through
>>> > within a week or so.
>>> >
>>> > I have updated the ZF2 code to use the latest LiveDocx 2.1 service
>>> > (even faster and more reliable) and re-added all the demo applications
>>> > (these are highly valued by LiveDocx users).
>>> >
>>> > Again, I will send you a PR, when I am done.
>>> >
>>> > Thank you for your continuing assistance.
>>> >
>>> > ;-)
>>> >
>>> > With best regards
>>> >
>>> > Jonathan Maron
>>> >
>>> >
>>> >
>>> >
>>> > On Fri, Jul 27, 2012 at 4:16 PM, Matthew Weier O'Phinney
>>> > <[hidden email]> wrote:
>>> >> -- Jonathan Maron <[hidden email]> wrote
>>> >> (on Friday, 27 July 2012, 07:22 AM +0200):
>>> >>> As the maintainer of the Service component LiveDocx, I have a question
>>> >>> concerning the documentation for all Service components, which
>>> >>> recently got moved from the main zf2 repository to their own
>>> >>> repositories.
>>> >>>
>>> >>> I see that the documentation for LiveDocx is in the main repository:
>>> >>>
>>> >>>
>>> >>> https://github.com/zendframework/zf2-documentation/blob/master/docs/languages/en/modules/zend.service.live-docx.rst
>>> >>>
>>> >>> Yet the actual components and tests are at:
>>> >>>
>>> >>> https://github.com/zendframework/ZendServiceLiveDocx
>>> >>>
>>> >>> Is this intentional? i.e. will the documentation for the Service
>>> >>> components be part of the main zf2 documentation, or will the
>>> >>> documentation be moved to the new Service repositories in due course?
>>> >>>
>>> >>> If it remains in the main zf2 documentation, I need to update the
>>> >>> documentation of the LiveDocx component, explaining how to install the
>>> >>> component.
>>> >>
>>> >> For now, we plan to keep the docs in the main zf2-documentation repo.
>>> >> We
>>> >> may move them to the individual service repos at a later date, but
>>> >> we're
>>> >> still trying to figure out (a) if that makes sense, and (b), if it
>>> >> does,
>>> >> how we'd go about building, packaging, and deploying docs for each of
>>> >> them.
>>> >>
>>> >> So, for the meantime, just work with the zf2-documentation repository.
>>> >>
>>> >>
>>> >>> On Thu, Jul 26, 2012 at 9:03 PM, Matthew Weier O'Phinney
>>> >>> <[hidden email]> wrote:
>>> >>> > Hey, all!
>>> >>> >
>>> >>> > RC1 is out.
>>> >>> >
>>> >>> > There's a lot of docs that need to be updated or written, though!
>>> >>> >
>>> >>> >
>>> >>> > Enrico has compiled a list of tasks:
>>> >>> >
>>> >>> >     https://gist.github.com/3183360
>>> >>> >
>>> >>> > Anything not marked "(ok)" needs some attention.
>>> >>> >
>>> >>> > Documentation is now in the zf2-documentation repository:
>>> >>> >
>>> >>> >     https://github.com/zendframework/zf2-documentation
>>> >>> >
>>> >>> > Additionally, documentation is now done using reStructured Text
>>> >>> > (reST or
>>> >>> > rst). One benefit this has is that you can edit the docs online, in
>>> >>> > the
>>> >>> > github interface, if you want!
>>> >>> >
>>> >>> > So, what are you waiting for? Help out the project, yourself, and
>>> >>> > those
>>> >>> > trying to learn, and start writing and updating docs!
>>> >>> >
>>> >>> > --
>>> >>> > Matthew Weier O'Phinney
>>> >>> > Project Lead            | [hidden email]
>>> >>> > Zend Framework          | http://framework.zend.com/
>>> >>> > PGP key: http://framework.zend.com/zf-matthew-pgp-key.asc
>>> >>>
>>> >>
>>> >> --
>>> >> Matthew Weier O'Phinney
>>> >> Project Lead            | [hidden email]
>>> >> Zend Framework          | http://framework.zend.com/
>>> >> PGP key: http://framework.zend.com/zf-matthew-pgp-key.asc
>>
>>
Loading...