Re: Documentation volunteer - introduction

[F Campos Costero]

Hi Nadeem,
I am not sure what Keith has in mind for the review process versus
publication. Let's wait to hear from him. We are still trying to work out
how to do everything and I don't think any changes have been made to the
documents on the web site.
Since Git cannot generate a diff for these binary files, I am not sure what
the best method is to avoid conflicts between  multiple reviewers. I think
a viable workflow for the moment is to get documents from my fork. You
should be able to clone that. You would then have my last version of both
the Getting Started guide and the Writer guide. The safest path, if you
want to do some editing, might be for you to edit the Writer guide and for
Keith to edit the Getting Started guide. If you can push commits to my
fork, you could directly push your versions back up. If you cannot directly
change my fork, you could send me the revised versions and I will push
them. (Would you be willing to make a trivial change to one document from
the Writer guide, adding a space at the end, and try to push that to my
fork?) When all the editing is done, I can make a pull request for Keith to
move the docs to the Apache repo and do whatever publication process he has
in mind.

With respect to this question:
* "Also, what sort of changes/review should I be making? I*

*understand there are formatting and probably typo-related things to
workon, but is there some sort of guide to look at as reference?"*
No, there is not a guide. I have invented a process as I went along. I will
try to explain that here.

   - I apply the template AOOdoc.ott that is available in the Templates
   branch of the Apache repo. I use the template changer extension to do this.
   - I change all product references from OpenOffice.org to either
   OpenOffice or Apache OpenOffice.
   - The abbreviation OOo is changed to AOO
   - I update all text and figures to reflect current features and
   appearance. For example, images of dialogs that include the old
   OpenOffice.org name are replaced with an image of the latest dialog. I also
   added a lot of references to the Sidebar and provided images where that was
   appropriate.
   - Check that formatting is applied via styles instead of hard
   formatting, using the styles from the template whenever possible and
   minimize the number of styles used. (The template implements  a set of
   styles whose names start with OOo.) The idea is to simplify the formatting
   in the hopes of making the translation to the Wiki easier. The main changes
   were using the character style OOoMenuPath for all cases of bold text,
   eliminating the style OOoStrongEmphasis and hard formatting, and using
   OOoEmphasis instead of hardcoded italic.
   - Checking all numbered lists for proper numbering. Applying the new
   template seems to mess up numbered lists.
   - Check for multiple spaces in inappropriate places using Find & Replace
   - Search for stray areas of Liberation Sans font from the old template
   that somehow survive the template change.
   - Remove text that references archaic technology, e.g. faxes, or
   literature. I didn't do this in every case.
   - Update web page links.
   - Spell check. (Some documents were written in non-US English and I
   don't think I always changed those spellings.)

The hardest part is updating features. You just have to know the software.
I am not an OpenOffice guru but I relied on 10+ years of helping on the
forum. There are also instances of factual errors and catching those is
also tough. I really hope someone else can update the Impress and Draw
guides!

Francis




On Thu, Jun 17, 2021 at 12:57 AM Nadeem Patel  wrote:

> Hi Francis,
>
> I see there are review and published, so I now I understand which have been
> reviewed and published already and which need to be reviewed. While this is
> something I might need to actually be concerned about, I am curious to know
> how the files receive a published or review on GitHub
> (ex. Published/AOO41GS1.odt → Getting-Started-Guide/AOO41GS1.odt
> or Review/AOO41GS12.odt → Getting-Started-Guide/AOO41GS12.odt). I'm asking
> because I would like to get a better idea of the repo and how things change
> there and how it appears on the actual website. My other questions are a
> bit more straightforward. Should I download the file that is listed as
> "Review..." and make changes or is there a different place I should be
> getting the files? Also, what sort of changes/review should I be making? I
> understand there are formatting and probably typo-related things to work
> on, but is there some sort of guide to look at as reference? I know you
> said we can just pick up something and get started, but I also don't want
> to go about things incorrectly, so I thought I should ask. Thanks for your
> help!
>
> Best,
>
> Nadeem
>
> On Wed, Jun 16, 2021 at 11:07 PM F Campos Costero 
> wrote:
>
> > Hi Nadeem,
> > It looks like Keith has been restructuring the repo. If you click on the
> > link to the commit 

Re: Documentation volunteer - introduction

[Nadeem Patel]

Hi Francis,

I see there are review and published, so I now I understand which have been
reviewed and published already and which need to be reviewed. While this is
something I might need to actually be concerned about, I am curious to know
how the files receive a published or review on GitHub
(ex. Published/AOO41GS1.odt → Getting-Started-Guide/AOO41GS1.odt
or Review/AOO41GS12.odt → Getting-Started-Guide/AOO41GS12.odt). I'm asking
because I would like to get a better idea of the repo and how things change
there and how it appears on the actual website. My other questions are a
bit more straightforward. Should I download the file that is listed as
"Review..." and make changes or is there a different place I should be
getting the files? Also, what sort of changes/review should I be making? I
understand there are formatting and probably typo-related things to work
on, but is there some sort of guide to look at as reference? I know you
said we can just pick up something and get started, but I also don't want
to go about things incorrectly, so I thought I should ask. Thanks for your
help!

Best,

Nadeem

On Wed, Jun 16, 2021 at 11:07 PM F Campos Costero 
wrote:

> Hi Nadeem,
> It looks like Keith has been restructuring the repo. If you click on the
> link to the commit that starts with 8928b59 (there is a link on the right
> just above the file names) you can see that the files were all moved into a
> single folder.
>
> In case you cannot see the link. the URL is Move all files to
> Getting-Started-Guide · apache/openoffice-docs@8928b59 · GitHub
> <
> https://github.com/apache/openoffice-docs/commit/8928b59a4295ca79d5ee49ae40f9656be54c1f05
> >
>
> Please let me know if there is anything I can do to help you get started on
> something. I know it is hard to know where to start. There is no one to
> assign tasks, so a new person has to find something for themself or help
> with one of the few ongoing efforts.. I simply got copies of the user
> guides and started editing. Only a few people have edited any documentation
> lately, so you are unlikely to step on any toes.
> Francis
>
> On Wed, Jun 16, 2021 at 6:29 PM Nadeem Patel 
> wrote:
>
> > Hello,
> >
> > I just wanted to follow up and get some clarification. When I go to
> >
> >
> https://github.com/apache/openoffice-docs/tree/Getting-Sarted-Guide/Getting-Started-Guide
> > ,
> > I don't see a published and review folder. Am I missing something?
> >
> > Best,
> >
> > Nadeem
> >
> >
> >
> >
> > On Thu, Jun 3, 2021 at 4:19 PM Keith N. McKenna <
> keith.mcke...@comcast.net
> > >
> > wrote:
> >
> > > On 2021-06-02 14:05, F Campos Costero wrote:
> > > Greetings Francis and Comments in line.
> > >
> > > > Hi Nadeem,
> > > > What I have been working on for a while now is updating the user
> > guides.
> > > > The old guides are available at [1]. Keith has set up a Git
> repository
> > > [2]
> > > > where a branch is dedicated to each guide. I forked that repository
> [3]
> > > and
> > > > I have done initial revisions of the Getting Started guide and the
> > Writer
> > > > guide. I am slowly working my way through the Calc guide and I am
> about
> > > > half done with that. As far as I know, only the first three chapters
> of
> > > the
> > > > Getting Started guide (A0041GS1.odt - A0041GS3.odt) have been
> reviewed
> > by
> > > > anyone else.  If you are willing to jump into reviewing the other
> > > chapters,
> > > > there is plenty to do. Each guide is a few hundred pages and each
> > chapter
> > > > is typically 20 - 40 pages.
> > >
> > > I apologize for that Francis. Some things in my personal life came up
> in
> > > mid-May that took a lot of my time.  I am at this point back working on
> > > reviewing Chapter 4 of the getting started guide.
> > > Some new information on who the Copyright holder should be listed as on
> > > the copyright page. It should be The Apache Software Foundation.Also
> > > traditionally we follow the American English use headline style
> > > capitalization. Follow American English capitalization guidelines for
> > > headings. Capitalize the first letter of every word except
> conjunctions,
> > > articles, prepositions of fewer than four letters, and the "to" in
> > > infinitives.  I am doing this as I review the the chapters of the
> > > Getting Started Guide.
> > >
> > > > The documentation process was dormant for quite a while and Keith has
> > > been
> > > > trying hard to revive it. We have just recently started to use Git
> and
> > we
> > > > may well have to change the process as we learn how to work with it.
> > Are
> > > > you familiar with Git? We only use the most basic features.
> > >
> > > I am making some changes know that I believe will help with the process
> > > of review and merging. Instead of using review and release folders for
> > > each branch I am adding Guide Folders in Main that will always hold the
> > > currently published complete guide as well as the chapters.This should
> > > make the review and merge process 

Re: Documentation volunteer - introduction

[F Campos Costero]

Hi Nadeem,
It looks like Keith has been restructuring the repo. If you click on the
link to the commit that starts with 8928b59 (there is a link on the right
just above the file names) you can see that the files were all moved into a
single folder.

In case you cannot see the link. the URL is Move all files to
Getting-Started-Guide · apache/openoffice-docs@8928b59 · GitHub


Please let me know if there is anything I can do to help you get started on
something. I know it is hard to know where to start. There is no one to
assign tasks, so a new person has to find something for themself or help
with one of the few ongoing efforts.. I simply got copies of the user
guides and started editing. Only a few people have edited any documentation
lately, so you are unlikely to step on any toes.
Francis

On Wed, Jun 16, 2021 at 6:29 PM Nadeem Patel  wrote:

> Hello,
>
> I just wanted to follow up and get some clarification. When I go to
>
> https://github.com/apache/openoffice-docs/tree/Getting-Sarted-Guide/Getting-Started-Guide
> ,
> I don't see a published and review folder. Am I missing something?
>
> Best,
>
> Nadeem
>
>
>
>
> On Thu, Jun 3, 2021 at 4:19 PM Keith N. McKenna  >
> wrote:
>
> > On 2021-06-02 14:05, F Campos Costero wrote:
> > Greetings Francis and Comments in line.
> >
> > > Hi Nadeem,
> > > What I have been working on for a while now is updating the user
> guides.
> > > The old guides are available at [1]. Keith has set up a Git repository
> > [2]
> > > where a branch is dedicated to each guide. I forked that repository [3]
> > and
> > > I have done initial revisions of the Getting Started guide and the
> Writer
> > > guide. I am slowly working my way through the Calc guide and I am about
> > > half done with that. As far as I know, only the first three chapters of
> > the
> > > Getting Started guide (A0041GS1.odt - A0041GS3.odt) have been reviewed
> by
> > > anyone else.  If you are willing to jump into reviewing the other
> > chapters,
> > > there is plenty to do. Each guide is a few hundred pages and each
> chapter
> > > is typically 20 - 40 pages.
> >
> > I apologize for that Francis. Some things in my personal life came up in
> > mid-May that took a lot of my time.  I am at this point back working on
> > reviewing Chapter 4 of the getting started guide.
> > Some new information on who the Copyright holder should be listed as on
> > the copyright page. It should be The Apache Software Foundation.Also
> > traditionally we follow the American English use headline style
> > capitalization. Follow American English capitalization guidelines for
> > headings. Capitalize the first letter of every word except conjunctions,
> > articles, prepositions of fewer than four letters, and the "to" in
> > infinitives.  I am doing this as I review the the chapters of the
> > Getting Started Guide.
> >
> > > The documentation process was dormant for quite a while and Keith has
> > been
> > > trying hard to revive it. We have just recently started to use Git and
> we
> > > may well have to change the process as we learn how to work with it.
> Are
> > > you familiar with Git? We only use the most basic features.
> >
> > I am making some changes know that I believe will help with the process
> > of review and merging. Instead of using review and release folders for
> > each branch I am adding Guide Folders in Main that will always hold the
> > currently published complete guide as well as the chapters.This should
> > make the review and merge process much easier.I will make the changes in
> > GitHub today.
> >
> > I am also going to create a how to contribute guide as well as some
> > style guides, that will give some guidance on Heading styles and other
> > things so that we create a consistent look and feel across the
> > documentation we create.
> >
> > Regards
> > Keith
> >
> >
> > > If you are interested in helping with the guides, I can tell you more
> > about
> > > the workflow we have been using. If that isn't the kind of thing you
> were
> > > looking for, I am sure we can find something else.
> > > I would like to give Keith a chance to participate in this
> conversation.
> > > He has more experience with the broader documentation process than I
> do.
> > >
> > > Francis
> > >
> > > [1]
> > >
> >
> https://wiki.openoffice.org/wiki/Documentation/OOo3_User_Guides/OOo3.3_Chapters_ODT
> > > [2] GitHub - apache/openoffice-docs: Apache OpenOffice Documentation
> > > 
> > > [3] GitHub - FJCC/openoffice-docs: Apache OpenOffice Documentation
> > > 
> > >
> > > On Tue, Jun 1, 2021 at 10:50 PM Nadeem Patel 
> > wrote:
> > >
> > >> I would like to add that I am interested in developing new content,
> > >> editing, proofreading, research or possibly even helping to create UML
> > >> diagrams. Thanks!
> > >>
> > >> On Tue, Jun 1, 2021 at 11:37 PM 

Re: Documentation volunteer - introduction

[Nadeem Patel]

Hello,

I just wanted to follow up and get some clarification. When I go to
https://github.com/apache/openoffice-docs/tree/Getting-Sarted-Guide/Getting-Started-Guide,
I don't see a published and review folder. Am I missing something?

Best,

Nadeem




On Thu, Jun 3, 2021 at 4:19 PM Keith N. McKenna 
wrote:

> On 2021-06-02 14:05, F Campos Costero wrote:
> Greetings Francis and Comments in line.
>
> > Hi Nadeem,
> > What I have been working on for a while now is updating the user guides.
> > The old guides are available at [1]. Keith has set up a Git repository
> [2]
> > where a branch is dedicated to each guide. I forked that repository [3]
> and
> > I have done initial revisions of the Getting Started guide and the Writer
> > guide. I am slowly working my way through the Calc guide and I am about
> > half done with that. As far as I know, only the first three chapters of
> the
> > Getting Started guide (A0041GS1.odt - A0041GS3.odt) have been reviewed by
> > anyone else.  If you are willing to jump into reviewing the other
> chapters,
> > there is plenty to do. Each guide is a few hundred pages and each chapter
> > is typically 20 - 40 pages.
>
> I apologize for that Francis. Some things in my personal life came up in
> mid-May that took a lot of my time.  I am at this point back working on
> reviewing Chapter 4 of the getting started guide.
> Some new information on who the Copyright holder should be listed as on
> the copyright page. It should be The Apache Software Foundation.Also
> traditionally we follow the American English use headline style
> capitalization. Follow American English capitalization guidelines for
> headings. Capitalize the first letter of every word except conjunctions,
> articles, prepositions of fewer than four letters, and the "to" in
> infinitives.  I am doing this as I review the the chapters of the
> Getting Started Guide.
>
> > The documentation process was dormant for quite a while and Keith has
> been
> > trying hard to revive it. We have just recently started to use Git and we
> > may well have to change the process as we learn how to work with it. Are
> > you familiar with Git? We only use the most basic features.
>
> I am making some changes know that I believe will help with the process
> of review and merging. Instead of using review and release folders for
> each branch I am adding Guide Folders in Main that will always hold the
> currently published complete guide as well as the chapters.This should
> make the review and merge process much easier.I will make the changes in
> GitHub today.
>
> I am also going to create a how to contribute guide as well as some
> style guides, that will give some guidance on Heading styles and other
> things so that we create a consistent look and feel across the
> documentation we create.
>
> Regards
> Keith
>
>
> > If you are interested in helping with the guides, I can tell you more
> about
> > the workflow we have been using. If that isn't the kind of thing you were
> > looking for, I am sure we can find something else.
> > I would like to give Keith a chance to participate in this conversation.
> > He has more experience with the broader documentation process than I do.
> >
> > Francis
> >
> > [1]
> >
> https://wiki.openoffice.org/wiki/Documentation/OOo3_User_Guides/OOo3.3_Chapters_ODT
> > [2] GitHub - apache/openoffice-docs: Apache OpenOffice Documentation
> > 
> > [3] GitHub - FJCC/openoffice-docs: Apache OpenOffice Documentation
> > 
> >
> > On Tue, Jun 1, 2021 at 10:50 PM Nadeem Patel 
> wrote:
> >
> >> I would like to add that I am interested in developing new content,
> >> editing, proofreading, research or possibly even helping to create UML
> >> diagrams. Thanks!
> >>
> >> On Tue, Jun 1, 2021 at 11:37 PM Nadeem Patel 
> >> wrote:
> >>
> >>> Hello,
> >>>
> >>> My name is Nadeem Patel. I came across the Apache OpenOffice Community
> >> and
> >>> would love to contribute. I have been looking to build my
> >>> documentation/technical writing portfolio while also improving the
> >>> necessary skills for such writing.
> >>>
> >>> I graduated from Northwestern University, where I studied journalism
> and
> >>> computer science. Currently, I am working as a digital producer at a
> >> major
> >>> news network while working on data science projects during my free
> time.
> >>> The majority of my experiences include writing, development or both.
> >>> Through this volunteering opportunity, I hope to continue utilizing my
> >>> skills and continue to build on my experiences. Thank you for your time
> >> and
> >>> look forward to being involved!
> >>>
> >>> Best,
> >>>
> >>> Nadeem Patel
> >>>
> >>
>
>
>

Re: Documentation volunteer - introduction

[Matthias Seidel]

Hi Keith,

Am 04.06.21 um 06:01 schrieb Keith N. McKenna:
> On 2021-06-02 17:37, Nadeem Patel wrote:
>> Hello Francis,
>>
>> I can certainly help out with this. I would also like to help develop new
>> content if that is something you guys need. Feel free to bring Keith into
>> this conversation if you think that's best. I have used Git for past
>> projects. I would appreciate a breakdown of how to navigate around the
>> GitHub repo and how to go about the workflow. I only see four files and not
>> sure where and how to make edits/changes. Thanks!
>>
>> Best,
>>
>> Nadeem
>>
> Hi Nadeem;
>
> I see that Francis has given you a pretty good breakdown on navigating
> the repo. As I stated in a reply today, I will be making some changes in
> the repo and the workflow today that should make it easier on all of us.
>
> I noticed in your entry in the Documentation Volunteers list that you
> are also a graphic artist. Would you be interested in doing a logo for
> the documentation?

Longer ago I made this graphic for our YouTube channel.

Just a simple compilation, but maybe useful?

https://home.apache.org/~mseidel/AOO%20Youtube.png

Regards,

   Matthias

>
> Regards
> Keith
>
> 
>



smime.p7s
Description: S/MIME Cryptographic Signature

Re: Documentation volunteer - introduction

[Nadeem Patel]

Hi Keith,

I do have some basic photo editing/graphic artist skills. Did you have
something in mind? Currently, I would like to focus on documentation, but
this is something I can help with whenever I get a chance. I also assumed
graphic artist was the term used on the list for building diagrams/photos
to match documentation.

Best,

Nadeem

On Thu, Jun 3, 2021 at 11:02 PM Keith N. McKenna 
wrote:

> On 2021-06-02 17:37, Nadeem Patel wrote:
> > Hello Francis,
> >
> > I can certainly help out with this. I would also like to help develop new
> > content if that is something you guys need. Feel free to bring Keith into
> > this conversation if you think that's best. I have used Git for past
> > projects. I would appreciate a breakdown of how to navigate around the
> > GitHub repo and how to go about the workflow. I only see four files and
> not
> > sure where and how to make edits/changes. Thanks!
> >
> > Best,
> >
> > Nadeem
> >
>
> Hi Nadeem;
>
> I see that Francis has given you a pretty good breakdown on navigating
> the repo. As I stated in a reply today, I will be making some changes in
> the repo and the workflow today that should make it easier on all of us.
>
> I noticed in your entry in the Documentation Volunteers list that you
> are also a graphic artist. Would you be interested in doing a logo for
> the documentation?
>
> Regards
> Keith
>
> 
>
>

Re: Documentation volunteer - introduction

[Keith N. McKenna]

On 2021-06-02 17:37, Nadeem Patel wrote:
> Hello Francis,
> 
> I can certainly help out with this. I would also like to help develop new
> content if that is something you guys need. Feel free to bring Keith into
> this conversation if you think that's best. I have used Git for past
> projects. I would appreciate a breakdown of how to navigate around the
> GitHub repo and how to go about the workflow. I only see four files and not
> sure where and how to make edits/changes. Thanks!
> 
> Best,
> 
> Nadeem
> 

Hi Nadeem;

I see that Francis has given you a pretty good breakdown on navigating
the repo. As I stated in a reply today, I will be making some changes in
the repo and the workflow today that should make it easier on all of us.

I noticed in your entry in the Documentation Volunteers list that you
are also a graphic artist. Would you be interested in doing a logo for
the documentation?

Regards
Keith





signature.asc
Description: OpenPGP digital signature

Re: Documentation volunteer - introduction

[Keith N. McKenna]

On 2021-06-02 14:05, F Campos Costero wrote:
Greetings Francis and Comments in line.

> Hi Nadeem,
> What I have been working on for a while now is updating the user guides.
> The old guides are available at [1]. Keith has set up a Git repository [2]
> where a branch is dedicated to each guide. I forked that repository [3] and
> I have done initial revisions of the Getting Started guide and the Writer
> guide. I am slowly working my way through the Calc guide and I am about
> half done with that. As far as I know, only the first three chapters of the
> Getting Started guide (A0041GS1.odt - A0041GS3.odt) have been reviewed by
> anyone else.  If you are willing to jump into reviewing the other chapters,
> there is plenty to do. Each guide is a few hundred pages and each chapter
> is typically 20 - 40 pages.

I apologize for that Francis. Some things in my personal life came up in
mid-May that took a lot of my time.  I am at this point back working on
reviewing Chapter 4 of the getting started guide.
Some new information on who the Copyright holder should be listed as on
the copyright page. It should be The Apache Software Foundation.Also
traditionally we follow the American English use headline style
capitalization. Follow American English capitalization guidelines for
headings. Capitalize the first letter of every word except conjunctions,
articles, prepositions of fewer than four letters, and the "to" in
infinitives.  I am doing this as I review the the chapters of the
Getting Started Guide.

> The documentation process was dormant for quite a while and Keith has been
> trying hard to revive it. We have just recently started to use Git and we
> may well have to change the process as we learn how to work with it. Are
> you familiar with Git? We only use the most basic features.

I am making some changes know that I believe will help with the process
of review and merging. Instead of using review and release folders for
each branch I am adding Guide Folders in Main that will always hold the
currently published complete guide as well as the chapters.This should
make the review and merge process much easier.I will make the changes in
GitHub today.

I am also going to create a how to contribute guide as well as some
style guides, that will give some guidance on Heading styles and other
things so that we create a consistent look and feel across the
documentation we create.

Regards
Keith


> If you are interested in helping with the guides, I can tell you more about
> the workflow we have been using. If that isn't the kind of thing you were
> looking for, I am sure we can find something else.
> I would like to give Keith a chance to participate in this conversation.
> He has more experience with the broader documentation process than I do.
> 
> Francis
> 
> [1]
> https://wiki.openoffice.org/wiki/Documentation/OOo3_User_Guides/OOo3.3_Chapters_ODT
> [2] GitHub - apache/openoffice-docs: Apache OpenOffice Documentation
> 
> [3] GitHub - FJCC/openoffice-docs: Apache OpenOffice Documentation
> 
> 
> On Tue, Jun 1, 2021 at 10:50 PM Nadeem Patel  wrote:
> 
>> I would like to add that I am interested in developing new content,
>> editing, proofreading, research or possibly even helping to create UML
>> diagrams. Thanks!
>>
>> On Tue, Jun 1, 2021 at 11:37 PM Nadeem Patel 
>> wrote:
>>
>>> Hello,
>>>
>>> My name is Nadeem Patel. I came across the Apache OpenOffice Community
>> and
>>> would love to contribute. I have been looking to build my
>>> documentation/technical writing portfolio while also improving the
>>> necessary skills for such writing.
>>>
>>> I graduated from Northwestern University, where I studied journalism and
>>> computer science. Currently, I am working as a digital producer at a
>> major
>>> news network while working on data science projects during my free time.
>>> The majority of my experiences include writing, development or both.
>>> Through this volunteering opportunity, I hope to continue utilizing my
>>> skills and continue to build on my experiences. Thank you for your time
>> and
>>> look forward to being involved!
>>>
>>> Best,
>>>
>>> Nadeem Patel
>>>
>>




signature.asc
Description: OpenPGP digital signature

Re: Documentation volunteer - introduction

[F Campos Costero]

Hi Nadeem,
Let's start with the Apache repo, (GitHub - apache/openoffice-docs: Apache
OpenOffice Documentation
). To see the Getting
Started files, you have to switch to the Getting-Sarted-Guide (sic)
branch.  There is a button fairly near the top of the screen with a drop
down list that you can use to switch branches. It probably will say Main
when you first access the site. When you change it to Getting-Sarted-Guide,
you should see two folders: Published and Review. The documents in
Published have been moved there by Keith. The documents in Review are as
they were after I modified the originals and need to be reviewed. In the
Review folder, you can click on, say, AOO41GS4.odt. That will take you to a
new page with a Download button on the right side. Click that and you
should get the document.

My repository has the same Review folder, though not all of the branches of
the Apache repo, and you can also download from there. You just have to
switch to the desired branch, as in the Apache repo. You could also just
clone the whole repo onto your system.

The procedure for editing has been rather clumsy so far. Dick Groskamp
(user DiGro) downloaded the documents, made suggested changes while
recording them (menu Edit -> Changes -> Record in Writer) and then emailed
the document to me on my personal email, I then accepted the changes, made
any other changes, and pushed the document to my repository. There has to
be a better way to do that but Dick ran into problems pushing commits to my
repository. Let's not worry about that at the moment. If you can just
download a document, that will be a good start.

I cannot make any changes on the Apache repo because I am not a commiter on
the project. Keith has to handle everything on that repo.

As for developing new content, you can certainly do that. What gets done on
an Apache project is up to the volunteers and the only limits are the need
to keep the project compatible with the Apache license other such legal
requirements, e.g. don't violate trademarks or copyrights. Since the email
is too long already, I will just mention two possible kinds of new content
that span the range of possible documents. A few months ago, someone
suggested writing some Quick Start materials. The Getting Started guide is
about 300 pages and rather intimidating. That could probably be done
relatively quickly. If you want to go big, there is no Base guide at all.
That would probably be 300 pages and require knowing the Base application
quite well.

Francis

On Wed, Jun 2, 2021 at 3:38 PM Nadeem Patel  wrote:

> Hello Francis,
>
> I can certainly help out with this. I would also like to help develop new
> content if that is something you guys need. Feel free to bring Keith into
> this conversation if you think that's best. I have used Git for past
> projects. I would appreciate a breakdown of how to navigate around the
> GitHub repo and how to go about the workflow. I only see four files and not
> sure where and how to make edits/changes. Thanks!
>
> Best,
>
> Nadeem
>
> On Wed, Jun 2, 2021 at 1:05 PM F Campos Costero 
> wrote:
>
> > Hi Nadeem,
> > What I have been working on for a while now is updating the user guides.
> > The old guides are available at [1]. Keith has set up a Git repository
> [2]
> > where a branch is dedicated to each guide. I forked that repository [3]
> and
> > I have done initial revisions of the Getting Started guide and the Writer
> > guide. I am slowly working my way through the Calc guide and I am about
> > half done with that. As far as I know, only the first three chapters of
> the
> > Getting Started guide (A0041GS1.odt - A0041GS3.odt) have been reviewed by
> > anyone else.  If you are willing to jump into reviewing the other
> chapters,
> > there is plenty to do. Each guide is a few hundred pages and each chapter
> > is typically 20 - 40 pages.
> > The documentation process was dormant for quite a while and Keith has
> been
> > trying hard to revive it. We have just recently started to use Git and we
> > may well have to change the process as we learn how to work with it. Are
> > you familiar with Git? We only use the most basic features.
> > If you are interested in helping with the guides, I can tell you more
> about
> > the workflow we have been using. If that isn't the kind of thing you were
> > looking for, I am sure we can find something else.
> > I would like to give Keith a chance to participate in this conversation.
> > He has more experience with the broader documentation process than I do.
> >
> > Francis
> >
> > [1]
> >
> >
> https://wiki.openoffice.org/wiki/Documentation/OOo3_User_Guides/OOo3.3_Chapters_ODT
> > [2] GitHub - apache/openoffice-docs: Apache OpenOffice Documentation
> > 
> > [3] GitHub - FJCC/openoffice-docs: Apache OpenOffice Documentation
> > 
> >
> > On Tue, Jun 1, 2021 at 10:50 PM Nadeem Patel 

Re: Documentation volunteer - introduction

[Nadeem Patel]

Hello Francis,

I can certainly help out with this. I would also like to help develop new
content if that is something you guys need. Feel free to bring Keith into
this conversation if you think that's best. I have used Git for past
projects. I would appreciate a breakdown of how to navigate around the
GitHub repo and how to go about the workflow. I only see four files and not
sure where and how to make edits/changes. Thanks!

Best,

Nadeem

On Wed, Jun 2, 2021 at 1:05 PM F Campos Costero 
wrote:

> Hi Nadeem,
> What I have been working on for a while now is updating the user guides.
> The old guides are available at [1]. Keith has set up a Git repository [2]
> where a branch is dedicated to each guide. I forked that repository [3] and
> I have done initial revisions of the Getting Started guide and the Writer
> guide. I am slowly working my way through the Calc guide and I am about
> half done with that. As far as I know, only the first three chapters of the
> Getting Started guide (A0041GS1.odt - A0041GS3.odt) have been reviewed by
> anyone else.  If you are willing to jump into reviewing the other chapters,
> there is plenty to do. Each guide is a few hundred pages and each chapter
> is typically 20 - 40 pages.
> The documentation process was dormant for quite a while and Keith has been
> trying hard to revive it. We have just recently started to use Git and we
> may well have to change the process as we learn how to work with it. Are
> you familiar with Git? We only use the most basic features.
> If you are interested in helping with the guides, I can tell you more about
> the workflow we have been using. If that isn't the kind of thing you were
> looking for, I am sure we can find something else.
> I would like to give Keith a chance to participate in this conversation.
> He has more experience with the broader documentation process than I do.
>
> Francis
>
> [1]
>
> https://wiki.openoffice.org/wiki/Documentation/OOo3_User_Guides/OOo3.3_Chapters_ODT
> [2] GitHub - apache/openoffice-docs: Apache OpenOffice Documentation
> 
> [3] GitHub - FJCC/openoffice-docs: Apache OpenOffice Documentation
> 
>
> On Tue, Jun 1, 2021 at 10:50 PM Nadeem Patel 
> wrote:
>
> > I would like to add that I am interested in developing new content,
> > editing, proofreading, research or possibly even helping to create UML
> > diagrams. Thanks!
> >
> > On Tue, Jun 1, 2021 at 11:37 PM Nadeem Patel 
> > wrote:
> >
> > > Hello,
> > >
> > > My name is Nadeem Patel. I came across the Apache OpenOffice Community
> > and
> > > would love to contribute. I have been looking to build my
> > > documentation/technical writing portfolio while also improving the
> > > necessary skills for such writing.
> > >
> > > I graduated from Northwestern University, where I studied journalism
> and
> > > computer science. Currently, I am working as a digital producer at a
> > major
> > > news network while working on data science projects during my free
> time.
> > > The majority of my experiences include writing, development or both.
> > > Through this volunteering opportunity, I hope to continue utilizing my
> > > skills and continue to build on my experiences. Thank you for your time
> > and
> > > look forward to being involved!
> > >
> > > Best,
> > >
> > > Nadeem Patel
> > >
> >
>

Re: Documentation volunteer - introduction

[F Campos Costero]

Hi Nadeem,
What I have been working on for a while now is updating the user guides.
The old guides are available at [1]. Keith has set up a Git repository [2]
where a branch is dedicated to each guide. I forked that repository [3] and
I have done initial revisions of the Getting Started guide and the Writer
guide. I am slowly working my way through the Calc guide and I am about
half done with that. As far as I know, only the first three chapters of the
Getting Started guide (A0041GS1.odt - A0041GS3.odt) have been reviewed by
anyone else.  If you are willing to jump into reviewing the other chapters,
there is plenty to do. Each guide is a few hundred pages and each chapter
is typically 20 - 40 pages.
The documentation process was dormant for quite a while and Keith has been
trying hard to revive it. We have just recently started to use Git and we
may well have to change the process as we learn how to work with it. Are
you familiar with Git? We only use the most basic features.
If you are interested in helping with the guides, I can tell you more about
the workflow we have been using. If that isn't the kind of thing you were
looking for, I am sure we can find something else.
I would like to give Keith a chance to participate in this conversation.
He has more experience with the broader documentation process than I do.

Francis

[1]
https://wiki.openoffice.org/wiki/Documentation/OOo3_User_Guides/OOo3.3_Chapters_ODT
[2] GitHub - apache/openoffice-docs: Apache OpenOffice Documentation

[3] GitHub - FJCC/openoffice-docs: Apache OpenOffice Documentation


On Tue, Jun 1, 2021 at 10:50 PM Nadeem Patel  wrote:

> I would like to add that I am interested in developing new content,
> editing, proofreading, research or possibly even helping to create UML
> diagrams. Thanks!
>
> On Tue, Jun 1, 2021 at 11:37 PM Nadeem Patel 
> wrote:
>
> > Hello,
> >
> > My name is Nadeem Patel. I came across the Apache OpenOffice Community
> and
> > would love to contribute. I have been looking to build my
> > documentation/technical writing portfolio while also improving the
> > necessary skills for such writing.
> >
> > I graduated from Northwestern University, where I studied journalism and
> > computer science. Currently, I am working as a digital producer at a
> major
> > news network while working on data science projects during my free time.
> > The majority of my experiences include writing, development or both.
> > Through this volunteering opportunity, I hope to continue utilizing my
> > skills and continue to build on my experiences. Thank you for your time
> and
> > look forward to being involved!
> >
> > Best,
> >
> > Nadeem Patel
> >
>

Re: Documentation volunteer - introduction

[Nadeem Patel]

I would like to add that I am interested in developing new content,
editing, proofreading, research or possibly even helping to create UML
diagrams. Thanks!

On Tue, Jun 1, 2021 at 11:37 PM Nadeem Patel  wrote:

> Hello,
>
> My name is Nadeem Patel. I came across the Apache OpenOffice Community and
> would love to contribute. I have been looking to build my
> documentation/technical writing portfolio while also improving the
> necessary skills for such writing.
>
> I graduated from Northwestern University, where I studied journalism and
> computer science. Currently, I am working as a digital producer at a major
> news network while working on data science projects during my free time.
> The majority of my experiences include writing, development or both.
> Through this volunteering opportunity, I hope to continue utilizing my
> skills and continue to build on my experiences. Thank you for your time and
> look forward to being involved!
>
> Best,
>
> Nadeem Patel
>