[DOCS] Administration Guide Formating Cleanup

[Will Stevens <ws...@cloudops.com>]

Hey All,
I plan to work on cleaning up the formatting of the documentation files in
the Administration Guide today.  I am not going to change any content and I
am note (yet) going to split any more files.  I am going to just do a once
over on as many docs as I can get through to clean up all of the ugly
formatting that resulted from the import.  This will make the docs a little
easier to work in.

I will check and see if there is an issue open for this already.  If not, I
don't mind creating an issue for it and applying my pull request to that
issue.

If you have feedback for me, let me know.

I am intentionally not changing any content because they would get lost in
the formatting changes.

Cheers,

Will

Re: [DOCS] Administration Guide Formating Cleanup

[Will Stevens <ws...@cloudops.com>]

I have finished my first pass which cleans up pretty much all of the
formatting.  Here is the PR:
https://github.com/apache/cloudstack-docs-admin/pull/12

I have been using this mechanism for syncing my fork:
https://help.github.com/articles/syncing-a-fork

Should I be using rebase and squashed commits instead?  I am pretty sure my
commits will merge cleanly with the approach I am using, but it is possible
that the 'merged upstream/master' commits will show up in your tree this
way.  I am pretty comfortable with git, so if you want me to do this a
different way I can easily adapt.

Cheers,

Will



On Tue, May 20, 2014 at 11:23 AM, sebgoa <ru...@gmail.com> wrote:

>
> On May 20, 2014, at 5:03 PM, Will Stevens <ws...@cloudops.com> wrote:
>
> > Hey All,
> > I plan to work on cleaning up the formatting of the documentation files
> in the Administration Guide today.  I am not going to change any content
> and I am note (yet) going to split any more files.  I am going to just do a
> once over on as many docs as I can get through to clean up all of the ugly
> formatting that resulted from the import.  This will make the docs a little
> easier to work in.
> >
>
> +1
>
> For background info, the import to RST was done using 'pandoc', I did an
> ugly thing: I created a single html page out of the docbook, then converted
> that to RST, the split each paragraph.
>
> The bottom line is that the conversion to RST was slightly buggy in places
> (tables, headings, code listing)…
>
>
>
> > I will check and see if there is an issue open for this already.  If
> not, I don't mind creating an issue for it and applying my pull request to
> that issue.
> >
> > If you have feedback for me, let me know.
> >
>
> thanks for stepping up and doing this, happy to merge your pr.
>
> > I am intentionally not changing any content because they would get lost
> in the formatting changes.
> >
> > Cheers,
> >
> > Will
>
>

Re: [DOCS] Administration Guide Formating Cleanup

[sebgoa <ru...@gmail.com>]

On May 20, 2014, at 5:03 PM, Will Stevens <ws...@cloudops.com> wrote:

> Hey All,
> I plan to work on cleaning up the formatting of the documentation files in the Administration Guide today.  I am not going to change any content and I am note (yet) going to split any more files.  I am going to just do a once over on as many docs as I can get through to clean up all of the ugly formatting that resulted from the import.  This will make the docs a little easier to work in.
> 

+1

For background info, the import to RST was done using 'pandoc', I did an ugly thing: I created a single html page out of the docbook, then converted that to RST, the split each paragraph.

The bottom line is that the conversion to RST was slightly buggy in places (tables, headings, code listing)…



> I will check and see if there is an issue open for this already.  If not, I don't mind creating an issue for it and applying my pull request to that issue.
> 
> If you have feedback for me, let me know.
> 

thanks for stepping up and doing this, happy to merge your pr.

> I am intentionally not changing any content because they would get lost in the formatting changes.
> 
> Cheers,
> 
> Will