#41 Editing the Install guide.
Closed 4 years ago by pbokoc. Opened 4 years ago by lsatenstein.

I carefully downloaded the install guide as a LibreOffice writer document. The total size of the downloaded document is 196 pages. Its time it reflects the installation of Fedora 32.

I started editing the install-guide document using comments and track changes. I am well past page 155 of the 195 pages.
I made textual changes that a peer (if you volunteer) can accept, reject, or provide alternative wording.

Why did I take this on?

There were quite a few spelling and grammar errors, as well as cut-and-paste stuff that was put into the document, some of it in the wrong order.
The installation program is called "installer", when it's name is Anaconda, I say the "installer" is the person doing the installation and the installation program is "Anaconda"

Benefits

You get some good knowledge of the many features available for installing Fedora32 or later versions and in the role of writer/editor. You can know that part of your knowledge and brain and contribution are in that document. For some technical advantages, you can produce PDF outputs, from the Writer file. Fedora chose adoc's as a way to support the documentation. Adocs do not in any easy way, allow markups and are most awkward for collaboration.
Hopefully, some Adoc guru will be able to transfer a completed "ODT" document into appropriate ADOC's.
The document is in North American English with American spelling for words. (for example, neighborhood for neighbourhood). Dates I kept as yyyy mm dd, (American is mmm dd yyyy, World is dd mmm yyyy)
Click on my name to send me a contact information. I will email/post the document I have been editing. I am very open to sharing.


Leslie, we've been over this many times before. We can't accept your edits in ODTs, the amount of effort required to port them back into asciidoc is way too much; going through the entire Install Guide and applying your LibreOffice edit history to it would take forever.

If you want to make edits to the Install Guide, or any other document, then please familiarize yourself with the contributor guidelines, and open pull requests with your changes. If you can't or won't do that, then please stop suggesting the LibreOffice approach, we are not going to adopt your way and you are wasting time and effort making edits nobody will ever use.

Metadata Update from @pbokoc:
- Issue status updated to: Closed (was: Open)

4 years ago

Hi Peter
In building the document=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D
I am not trying to change the Fedora way of doing things.=C2=A0 If you show=
me how *.adocs allows me, to collaborate with another person and without s=
truggle, when it is easy with LO, I will do it. =C2=A0 I do use git with th=
e git diff,=C2=A0 but it is not the tool to use. There is no easy collabora=
tion between two users -- a difficult way to produce a "easy to follow" doc=
ument.

To do collaboration with GIT, I upload a branch, someone has to download th=
e branch, he makes changes and uploads his copy to the same branch, and I d=
ownload to review his stuff.=C2=A0 There will be quite a few (many) iterati=
ons until a clean section is produced. then you merge the branch to the mas=
ter.=C2=A0 Will there be revision bars for the changes showing on the left =
margin?=20

Alternative way to make a backport=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
Using a copy of the Install guide as displayed on the web, I copy/pasted it=
into LibreOffice, , I have spell checked and corrected grammar, and asked =
questions within the doc about sentence construction and duplicity.=C2=A0=
=20

My idea was to have a clean LibreOffice doc that I would=C2=A0 backport int=
o the asciidoc Install guide git reprository that the project is using.
I have my clean version, I share it with friends. They have used it and are=
happy to have done so. =C2=A0=20

I will say this, and I am not being nasty or angry.=C2=A0 A RedHat editor/w=
riter would be rejecting your install guide document as not meeting RH stan=
dards.
Here is one example of confusion found by some people in my "men's club" (C=
ote Saint-Luc Senior Mens club -- 850 members)

The installation program is Anaconda.=C2=A0=C2=A0=C2=A0 The installer is th=
e person,=C2=A0 Everywhere in the document the author has confused installe=
r for anaconda and vv.=C2=A0=C2=A0 I can give you much more of what I found=
as I edited the document, but you should at least ask if someone in the do=
cumentation group would be interested in reviewing a joint LO doc that woul=
d serve as a way to make a clean ADOC.=C2=A0 Repeat, a document that would =
be backported to update the one from Fedora.=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0 =
And you you may not appreciate LO as a tool, but LO from the one document L=
O can creates PDFs, E-pub, html. =C2=A0 LO can create output in many other=
formats,=20

What I did to create a LO copy after I did not find an "Installguide pdf" f=
rom the website was to scroll/copy paste into LibreOffice.=C2=A0=C2=A0=20

Its fine.=C2=A0 Just to let you know, my editing took about 20 hours (not a=
ll at one sitting). Its 200 pages of which I did the first 150.=20

Below my signature is a section from the preface to the existing installati=
on guide.=C2=A0 I was following the guide.=C2=A0=C2=A0=20

I can upload my document as a series of issues or I would be creating one i=
ssue for each proposed correction.=20

It can be a win-win. I do not own the Fedora Install guide. Ask if someone=
would be interested in sharing the editing role to complete the guide.

Regards=20
=C2=A0Leslie
Leslie Satenstein
Montr=C3=A9al Qu=C3=A9bec, Canada

=20

=20
Preface

We want feedback

If you find errors or have suggestions for improvement, we wantyour advice.=
Open an issue at https://pagure.io/.

In the issue:
=20
- =20
Provide a short summary of the error or your suggestion in the Issue Title =
field.
=20
- =20
Copy the following template into the Comment field and give us the details =
of the error or suggestion as specifically as you can. If possible, include=
some surrounding text so we know where the error occurs or the suggestion =
fits.
Document URL:

Section name:

Error or suggestion:

Additional information:=20
- =20
Click the Create Issue button.

=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D
This writing guide below is what each author should follow

Technical Writing Guide=20
Michigan State University=20
Department of Biosystems and Agricultural Engineering=20
Farrall Hall, East Lansing, Michigan=20
www.egr.msu.edu/age=20
Version 2.0=20
Copyright =C2=A9 September 2007
It is free.=20

On Wednesday, April 8, 2020, 3:15:17 a.m. GMT-4, Petr Bokoc <pagure@pag=

ure.io> wrote: =20
=20
=20
pbokoc added a new comment to an issue you are following:
``
Leslie, we've been over this many times before. We can't accept your edits =
in ODTs, the amount of effort required to port them back into asciidoc is w=
ay too much; going through the entire Install Guide and applying your Libre=
Office edit history to it would take forever.=20

If you want to make edits to the Install Guide, or any other document, then=
please familiarize yourself with the contributor guidelines, and open pull requests with your changes. If you can't or won't do =
that, then please stop suggesting the LibreOffice approach, we are not goin=
g to adopt your way and you are wasting time and effort making edits nobody=
will ever use.
``

To reply, visit the link below or just reply to this email
https://pagure.io/fedora-docs/install-guide/issue/41
=20

Login to comment on this ticket.

Metadata