Bug 39998 - EXTENSIONSWEBSITE Help required "How to Upload"

Hi Gustavo,

I have worked on the new Extensions website since a few weeks, to help
Andreas to test the website's features. Then, I wrote two documents about
it. I uploaded the documents to Wiki for revision at:

http://wiki.documentfoundation.org/Extensions_Repository

   * Installing extensions ODT - PDF
   * Publishing extensions ODT - PDF

I've added myself to the CC list for
https://bugs.freedesktop.org/show_bug.cgi?id=39998 and will track the
subject to make sure your work gets into the available English
documentation somewhere appropriate.

@Jean: where do you think we should put this?

English Content > Documentation > Developers Guide seems like the best
place for it. It also could fit under HowTos/Tutorials, but as it's
aimed more at (extension) developers than end users, the DevGuide area
seemed more relevant.

Tom has put it on the wiki, but as it needs work, I thought adding it to
Alfresco would be good. I am writing a note to the list seeking someone
to tidy up the English and make any other needed changes.

--Jean

Hi,

English Content > Documentation > Developers Guide seems like the best
place for it. It also could fit under HowTos/Tutorials, but as it's
aimed more at (extension) developers than end users, the DevGuide area
seemed more relevant.

Tom has put it on the wiki, but as it needs work, I thought adding it to
Alfresco would be good. I am writing a note to the list seeking someone
to tidy up the English and make any other needed changes.

I just downloaded and had a brief look at the two files.

Installing_extensions_08-11-2011.odt would seem like content to
replace the extensions coverage in 0109GS3-SettingUpAndCustomizing.odt
of the GS guide

Publishing_extensions_08112011.odt would indeed seem to fit in the
DevGuide area, but I suspect it's still a work in progress, because
I'm not sure that http://extensions-test.libreoffice.org/ is yet at a
mature state, and I don't know if Andreas and Gustavo will maintain
the material we keep on Alfresco.

I can put Publishing_extensions_08112011.odt on my list of
longer-range to-do's, after the Power User guide, for proofreading and
correction, once the work on Alfresco is much more advanced.

@Gustavo, @Andreas: any comments?

I had missed "Installing extensions" and only saw "Publishing
extensions". I have now looked at "Installing extensions" and see that
it is indeed a how-to based on the Getting Started guide chapter on
Customizing. It needs only a bit of tidying up, including the info on
the copyright page.

Your comment on "Publishing extensions" suggests that removing the
pointer to the file from the Docs wiki (where Tom had put it) might be
best at this point.

BTW, if I were editing "Publishing extensions" I would crop the
screenshots to take off the browser's title bar, menu bar, and address
bar. They aren't relevant to what's going on, and removing them
(especially the address bar) will make the images relevant for longer --
at least until the web page itself is redesigned.

However, at this point cropping the existing images may not be worth the
effort, because the web page probably will change. So my comment applies
more to someone capturing replacement images when the time comes.

This looks like a document that anyone with good English skills could
usefully edit. I think it's a good project for someone wanting to get
involved here without a big commitment, yet it's more interesting and
more work than the minor tidying up that most of our existing user guide
material needs. It could be a good "before and after" example for
someone to add to their portfolio. Anyone interested?

--Jean

Jean Hollis Weber schrieb:

but I suspect it's still a work in progress,

Hi,

yes, I also think so, and also your suspect that the Web page still might be modiufied is plausible. The current document is a very good base information that will have to be filled with more knowledge we are gathering testing the Website.

I suggested to add notices on
<http://wiki.documentfoundation.org/Talk:Extensions_Repository#Improving_Documentation>

CU

Rainer

Rainer, at what point do you think it is worth someone's time to improve
the English? Will someone tell us when it is ready?

I put some comments on that Talk page, but the typos and English
corrections are easier done in the ODT file itself.

--Jean

Hi :slight_smile:
I only placed it on the main page hastily. I see it as a work-in-progress and
that links and even whole sections are likely to get moved to more appropriate
areas. The whole of the docs wiki needs re-organising but it's very very low
priority. We seem to manage to muddle through just about well enough for now.
So, if someone moves the link i would be quite happy.

Regards from
Tom :slight_smile:

Hi :slight_smile:
Grr i wis i could delete my comment from the bug-report thread lol. I was
really confused when i posted that! Ahh well. "Into every life a little rain
must fall" lol. It might teach me to have a cuppa tea before starting to wade
into my emails!
Regards from
Tom :slight_smile:

Jean Hollis Weber schrieb:

Rainer, at what point do you think it is worth someone's time [...]

Hi,

currently nowhere, my comment was concerning "work in progress", currently we have nearby no experience with the upload process (I never did an upload).

CU

Rainer

Hi people!

  Many thanks for your comments!

  The Installing_extensions.odt document, in fact, is a merge of my new
content with the previous document of Andreas (based on the extensions
section of 0109GS3-SettingUpAndCustomizing.odt).

  The document is here:
   http://wiki.documentfoundation.org/File:Installing_extensions.odt (I
removed the date on the name).

  For this document, first of all, I suggest a review for correct English
spelling and grammar, and improve any part of content, if it is necessary .
The extension installation process is very simple to do, then, I think
someone with good English can review it easily.

  After review, Andreas can put a link to a PDF version of this document
from the every extension page on the site.

  Additionally, we can include the content of Installing_extensions.odt in
the extensions section of 0109GS3-SettingUpAndCustomizing.odt or keep it as
a different document. Sincerely, I don't know what is the better way. You
can feel free for do it. :slight_smile:

  For the Publishing_extensions.odt document, there is a more complex review
process. I agree with many comments of you: perhaps
http://extensions-test.libreoffice.org can be modified or not. I have tested
it many times and I think it needs only a few adjusts to be ready (Andreas
has done a great job!). Because this, Publishing_extensions.odt is indeed a
work in progress.

  The document is here:
  http://wiki.documentfoundation.org/File:Publishing_extensions.odt
  (I removed the date on the name and I cropped the browse images in this
version by suggestion of Jean,).

  I think there are two ways for Publishing_extensions.odt.

  A first way is to ask another extension(s) developer(s) to test the
step-by-step of publishing a project on the website. After his vacation,
Andreas can help us to find someone and can contribute with some comments
himself. Then, I can update the document with the people comments. After, I
will inform here about the moment to do an English spelling and grammar
review.

  A second possible way is more simple: someone do a English review now,
Andreas put the document in the extensions website and we wait for comments
by the developers.

  In both ways, I wish to wait Andreas opinion.

Regards,
Gustavo Pacheco.

David Nelson schrieb:

I've added myself to the CC list for
https://bugs.freedesktop.org/show_bug.cgi?id=39998 and will track the
subject to make sure your work gets into the available English
documentation somewhere appropriate.

Hi David:

Nothing for the nearby future, butt ...
What do you think about integrating a brief version into normal LibO Help? That might ease translations, would be additionally available in the Help Wiki, ...

Kind regards

Rainer

Hi Rainer,

Nothing for the nearby future, butt ...
What do you think about integrating a brief version into normal LibO Help?
That might ease translations, would be additionally available in the Help
Wiki, ...

My inclination would be to wait until the extensions repo reaches a
more-finished state, as regards presentation and functionality, so as
to reduce the necessary updating work.

I notice that a lot of the English strings on the alpha-state
extensions site needs quite a bit of proofreading and correcting if
it's to be a really high-quality resource that inspires confidence
from the English-speaking communities. This is something I could maybe
help you guys out with sometime, if you like, especially when Alfresco
is nearer a fully-operational state.

Hi Gustavo, all,

sorry for crossposting.

First a big thanks to Gustavo all the other contributors for their work on the
documentation.

(...)

  The document is here:
   http://wiki.documentfoundation.org/File:Installing_extensions.odt (I
removed the date on the name).

Can someone put the document on the libreoffice-website into the documentation
section? I have not the necessary rights to do so.

(...)

  After review, Andreas can put a link to a PDF version of this document
from the every extension page on the site.

I can link to the document very easy, if it is located on our website. I hope someone
with the necessary rights will jump in and place the document on our website :wink:

Regards,
Andreas

Other documentation (such as the user guides) is stored on the wiki and
links to the wiki are put on the website. Why not do that with this
document?

--Jean

Hi Jean, *,

(...)

Other documentation (such as the user guides) is stored on the wiki and
links to the wiki are put on the website. Why not do that with this
document?

Isn't this a user guide? It's about installing an extension.

Regards,
Andreas

Yes, so why not treat it the same as the other user guides? That was my
point.

--Jean

Hi Jean, *,

> Hi Jean, *,
>
> (...)
>
> > Other documentation (such as the user guides) is stored on the wiki and
> > links to the wiki are put on the website. Why not do that with this
> > document?
>
> Isn't this a user guide? It's about installing an extension.
>
> Regards,
> Andreas

Yes, so why not treat it the same as the other user guides? That was my
point.

uups, now I catched your point. I thought that all the user guides were stored on the
website.

Regards,
Andreas

Hi David, *,

Hi Rainer,

> Nothing for the nearby future, butt ...
> What do you think about integrating a brief version into normal LibO
> Help? That might ease translations, would be additionally available in
> the Help Wiki, ...

My inclination would be to wait until the extensions repo reaches a
more-finished state, as regards presentation and functionality, so as
to reduce the necessary updating work.

the site will serve as extension-repo for LibreOffice in the next days. Thus I think
you can proofread and edit the text. If you want an account, please give me a ping.
Otherwise you can sent me your changes (plain text, odt ...) and I publish it.

Regards,
Andreas

Hi Andreas!

  You're welcome. I'm glad to help the project!

About Publishing_extensions.odt, at the moment I'm working in some Jean's
suggestions (please, see
http://wiki.documentfoundation.org/Talk:Extensions_Repository#Suggestions_for_additions_.2F_improvements_2,
topics 3 and 4).

If you have some note about this content, please, send us.

I want to finish topics 3 and 4 next week. I will notice here about it.
After, someone can do the topic 5.

Best regards,
Gustavo Pacheco

Hi Andreas,

the site will serve as extension-repo for LibreOffice in the next days. Thus I think
you can proofread and edit the text. If you want an account, please give me a ping.
Otherwise you can sent me your changes (plain text, odt ...) and I publish it.

Regards,
Andreas

OK, this is on my to-do list for attention just as soon as I can give
it time. Once the actual user interface of the extensions site is up
to scratch from the language quality viewpoint, we can update the
documentation.

So I'll get back to you about this subject as soon as I'm able to.

The extensions site can certainly be documented in its own little
guide, but will also be covered in the Getting Started guide.

As Jean explained, at present, our current convention is to post
download-ready documents on the wiki, and to link to the wiki-based
copies on the libreoffice.org website. And we keep a working copy of
the document on Alfresco for updating and maintenance.