Re: Can you help me out with integrating editing to the docs It will take you 8,77 minutes to follow.

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]


Please distinguish editing from writing.  This is what I do for the editing.Insure asciidoctor is installed, as well as libreoffice and gitgit clone a repository.enable git and create a branch of said repository  I will use as an example, the release notesFor each directory within the release notes repository, create a   libreoffice document directoryfor each *.adoc in each directory, run the followingcat  ~/bin/adoc
if [ $# = 0 ];
   echo "command is  $0 asciidoc.adoc "
   echo "output to /tmp/asciidoc.html "
   echo "Also creates a /tmp/ pointing vim to the asciidoc.adoc"
   exit 0
bn=$(basename $1 .adoc)
asciidoctor --out-file /tmp/${inadoc}.html.odt ${bn}.adoc  2>/tmp/${inadoc}.errs
echo "vim ${dn}/$inadoc " >/tmp/
chmod 755 /tmp/
libreoffice --writer /tmp/${inadoc}.html.odt
#firefox /tmp/${bn}.html  
ls -l  

for each *.adoc 
the script will create a libreoffice file.Use landscape setting. Format->Page set radio button landscape.
  Enable markup management via EDIT-->Track Changes and click Record,Show,Manage
Edit that file to identify changes or corrections.Once satisfied, save.If there is no one to review your edits, (I am proposing to do the review), pass the *.odt documentto a coordinator,  He will reject each inappropriate individual change using the LOwriter options.The changes that remain (and the coordinator can add or modify them) get back to the author.The author now edits the correspondint adoc file, matches the changes in the Writer document tothe adoc file, and updates the adoc file.He then submits the *.adoc file as a PR.
The following is an example of what a coordinator (repository owner) would look at for approval. If there are update refusals, the document goes back to the writer.  The author can also concurrently provide the *.adoc to the editor. The two are returned to the author for him/her to issue the Pull request. The editor would also update the accompanying adoc file.Here is an example of an edit of "Desktop.adoc".    

And this is the corrected string after update to the *.adoc file.  

Prior to this update, the [package]*fontconfig* cache files were placed in the `/var/cache/fontconfig` directory. This location is not compatible with the `OStree` model used by Fedora Atomic, which prevented using the same package for Atomic and other Fedora variants. To fix this incompatibility, the cache files have been moved to `/usr/lib/fontconfig/cache`.

If you want help with editing, and it is OK with Adam, Richard or others  I will be glad to devote time to reviewing your postings prior to your issuing a PR.  My location is in the CC above

 Leslie Satenstein
Montréal Québec, Canada

    On Wednesday, August 22, 2018, 12:58:00 p.m. EDT, Richard England <pdx.limey@xxxxxxxxx> wrote:  
  Would it be possible to create a video of or for this lesson so it can be shared later?
 I, too, am finding the editing process difficult to get into.
 On 08/22/2018 04:48 AM, Adam Samalik wrote:
Hi Leslie, 
  I really value your work and I'd really like to help you to integrate it. But rather than doing the integration work myself (for which, to be fair, I don't have many spare cycles), I'd like to teach you how to do it yourself. The benefits would be: 
  * The integration of your work wouldn't generate additional work for other people, other than the actual review + feedback * You would be able to get feedback in the PR itself — there is a space for discussion, as well as posting inline comments * Many different people could help with commenting, reviewing, and even merging the changes * You would get credit as those changes would be clearly marked as yours 
  I'd rather spent an hour teaching you how to do future changes yourself, rather than doing it myself for 8.77 minutes. Especially with the amount of work you do, I wouldn't be able to keep up long-term. Also, there are many other people out there that could help to review the changes. 
  I know, git might be a new tool for many writers, and learning it might require some effort, but using it has many benefits for large communities such as Fedora, where we need to scale our work between many people living in different parts of the world and different timezones. If we want to work in a large community, or want to build a large community, we need to have workflows that scale. And git is one of the least horrible options there. 
  So, I'm happy to have a video call with you, even for an hour, going through the integration of your changes, so you feel comfortable doing them yourself next time. Would that work for you? 
  Please let me know. 
  regards, Adam  
  On Mon, Aug 20, 2018 at 5:43 PM Leslie S Satenstein <lsatenstein@xxxxxxxxx> wrote:
     Hi Adam, 
  Your response will go a long way to understanding what I mean and do by "editing"
  Can you help me out with integrating editing to the *.adocs?
  What I have attached is one fairly short libreoffice writer document  (1.5 pages)  and the corresponding updated Desktop.adoc. 
  Before I can generate a pull request, I made a correction and asked some questions inside the libreoffice writer file.  Those questions, if properly responded to, are to be the modifications to be made to the corresponding *.adoc file. A third file  just invokes vim against the location to where the  target adoc file resides.
  I am and attaching a zip file with the updated Desktop.adoc and the corresponding libreoffice  "Desktop.adoc.odt".  The way I see things working, the libreoffice document is the working document. When it is clean, the contents therein are what is  transfered to the corresponding *.adoc file and a PR sent. 
  2) Can you please note. Not all document writers are git users.  They are writers, and can follow instructions. Please add a definition of a Pull Request. 
  Pull Request:  A formal request document, transmitted to the owner of the git repository. The PR contains revisions or insertions that you are  requesting for that git repository.
  Leslie Satenstein
  Montréal Québec, Canada
 Adam Šamalík
  Software Engineer
 Red Hat
docs mailing list -- docs@xxxxxxxxxxxxxxxxxxxxxxx
To unsubscribe send an email to docs-leave@xxxxxxxxxxxxxxxxxxxxxxx
Fedora Code of Conduct:
List Guidelines:
List Archives: 


PNG image

docs mailing list -- docs@xxxxxxxxxxxxxxxxxxxxxxx
To unsubscribe send an email to docs-leave@xxxxxxxxxxxxxxxxxxxxxxx
Fedora Code of Conduct:
List Guidelines:
List Archives:

[Index of Archives]     [Fedora Users]     [Fedora Desktop]     [Red Hat 9]     [Yosemite News]     [KDE Users]

  Powered by Linux