[Fuego] Fwd: RST_Docs conversion
Bird, Tim
Tim.Bird at sony.com
Fri Sep 18 16:32:07 UTC 2020
Pooja,
First, please submit exactly one patch per email. If you could submit
them using 'git send-email', that would be great. Sometimes this is difficult
due to IT settings in your organization but if it's possible to get this working,
it would be really helpful for the review process. That will allow me to
review the patches inline in my browser, rather than save the attachment,
review offline using an editor, and put my comments back in my mail client.
If you can't use 'git send-email', I have found that I can submit single patches
by copy-and-pasting the patch into the body of the email (and editing
the Subject line for the email appropriately.)
If sending the patch inline in the email is a problem, then let me know.
I can take the patches as attachments, but it requires a bit more work on
my side.
Second, please use a Signed-off-by signature in your patch commit message.
You can do this easily by configuring your name and email in your git configuration,
and then when you do commits use the '-s' option. (i.e. 'git commit -s')
See http://fuegotest.org/wiki/License_And_Contribution_Policy#Submitting_contributions
for details.
Here is some feedback on patch: 0001-docs-pages-categorized-as-Explanation.patch
I had already added (and edited) your previous submission of Architecture.rst. Please
remove that file from the patch.
In the patch subject line, you need a space after the colon. Instead of "docs:pages ...",
please use "docs: pages ..."
Every patch should have something in the body of the commit message, even if
it's short. Please add a paragraph describing the patch contents to the commit
message. Something like: "Convert the following pages from the fuegotest wiki
into rst format and add to the Fuegl rst documentation directory:
FAQ, OSS_Test_Vision"
In order to update the patch, you may have to rebase it, or use "git commit --amend".
Let me know if you needs some help or instructions to do this.
Thanks for this work. Please make the above fixes and submit this patch again.
I noticed that FAQ.rst does not have an anchor at the top (ie there's no ".. _faq:" line)
Is this intentional?
The content of the files looks OK.
-- Tim
> -----Original Message-----
> From: Pooja Sanjay More
> ---------- Forwarded message ---------
> From: Pooja Sanjay More <pooja.sm at pathpartnertech.com <mailto:pooja.sm at pathpartnertech.com> >
> Date: Wed, Sep 16, 2020 at 12:40 PM
> Subject: Re: RST_Docs conversion
> To: Bird, Tim <Tim.Bird at sony.com <mailto:Tim.Bird at sony.com> >
> Cc: Amit Agarwal <amit.a at pathpartnertech.com <mailto:amit.a at pathpartnertech.com> >, Srivatsan S <srivatsan.s at pathpartnertech.com
> <mailto:srivatsan.s at pathpartnertech.com> >
>
>
>
> Hi,
>
> Below are a few patches attached. I have created the patches for files according to the categorized area mentioned on
> rst_page_conversion_list.
>
> 0001-docs-pages-categorized-as-Explanation.patch -- Contains changes to Architecture.rst, FAQ.rst, OSS_Test_Vision.rst
>
> 0001-docs-rst-files-for-pages-categorized-as-for-users.patch --Contains changes to Installing_feugo.rst, Adding_a_board,
> Adding_a_toolchain, Adding_test_jobs_to_Jenkins, Adding_views_to_Jenkins.
>
> 0001-docs-rst-files-for-pages-categorized-as-Tutorials-- Contains changes to Fuego_Quickstart_Guide, Raspberry_Pi_Fuego_Setup,
> Quick_Setup_Guide, Using_the_qemuarm_target.
>
> It is observed that avocado documentation uses a different sphinx theme. Hence, to have the look and feel of avocado, the below theme
> can be used in sphinx: <https://github.com/readthedocs/sphinx_rtd_theme>
>
>
> Thanks and regards,
> Pooja More
>
> On Mon, Sep 14, 2020 at 10:43 PM Bird, Tim <Tim.Bird at sony.com <mailto:Tim.Bird at sony.com> > wrote:
>
>
> > -----Original Message-----
> > From: Pooja Sanjay More
> >
> > Hi,
> >
> > As mentioned in the comments to make changes in the fuego repository itself and commit the same. I'm not able to push the
> changes to
> > fuego repository as it needs permission. Please provide the same for my credentials:
>
> I'm not planning on giving you push capability to the main repository (on bitbucket).
>
> I'd like the development to be in your own fork of the fuego repository, with proposed
> changes submitted to me as patches on a mailing list.
>
> What I'm trying to accomplish here is to give you some training on how patches are
> submitted to an upstream project that is primarily e-mail oriented. I am hoping
> that once you get familiar with the infrastructure required and the methods used
> to submit patches this way, you will be able to submit patches to other projects
> (specifically the Linux kernel) in the future. In this regard, Fuego is a stepping
> stone (or training ground, if you will). I am indeed grateful for your work on
> the Fuego documentation, and part of my "payment" back to you will be
> to give you experience and mentorship that will help you become more involved
> in other upstream projects.
>
> >
> >
> > Mail ID: pooja.sm at pathpartnertech.com <mailto:pooja.sm at pathpartnertech.com> <mailto:pooja.sm at pathpartnertech.com
> <mailto:pooja.sm at pathpartnertech.com> >
> > user_Name: Pooja_More
> >
> > Henceforth, I plan to push all changes to the repo and the review can happen from there on.
>
> Just commit them to your local repository, and use 'git format-patch' to create patches to submit
> to me via e-mail. If you have questions about this, let me know and we can go over it
> by email or in a conference call.
>
> >
> > Also about index.rst content, as adding files to toctree makes a long list of headings in a table of content , so purposely kept
> hidden. Rest
> > of the comments will be followed.
>
> Yes. It does create a really long list. I potentially needs to be trimmed down to be manageable.
> I had hoped that the toctree would show up on the left side of the page as a navigation with collapsible
> headings.
>
> I'd eventually like the docs to look something like this:
> https://avocado-framework.readthedocs.io/en/82.0/ (in terms of layout navigation - obviously
> our content would be different).
>
> That's how the Avocado docs look on readthedocs.io <http://readthedocs.io> . It looks different when built locally.
> It appears that for a local build, the left sidebar menus don't expand and collapse the same
> way. Anyway, we don't have anything like that, but I'd like to compare our doc build with
> theirs and see if we can imitate what they are doing. Eventually I'd like to put Fuego
> documentation on readthedocs.io <http://readthedocs.io> , similar to other projects.
>
> >
> >
> > Thanks and Regards,
> > Pooja More
> >
> > On Sat, Sep 12, 2020 at 5:21 AM Bird, Tim <Tim.Bird at sony.com <mailto:Tim.Bird at sony.com> <mailto:Tim.Bird at sony.com
> <mailto:Tim.Bird at sony.com> > > wrote:
> >
> >
> > > -----Original Message-----
> > > From: Pooja Sanjay More
> > > Hi Tim,
> > >
> > > Below is the list of pages that have been converted wherein your earlier feedback about filenames has been taken care of.
> > Accordingly,
> > > the wiki-naming has been retained. Also there was no mapping provided for 'Title' and hence added the mapping for 'Title'
> on
> > the 'Markup
> > > Mapping' page and the rest of the conventions are followed in the same manner.
> > >
> > > Html pages have been built using the "conf.py" file from fuego repo.
> > >
> > > The Documentation page contains only hyperlinks so it has been converted partially.
> > >
> > > Please find the zip for .rst files and corresponding html pages and also the image folder.
> >
> > Receiving zip files to my work email is quite cumbersome to deal with. Can we please
> > do the following going forward?
> > - perform the work in the fuego repository, by adding or editing files in the
> > docs/rst_src directory
> > - create a commit for the changes
> > - e-mail the commit to tim.bird at sony.com <mailto:tim.bird at sony.com> <mailto:tim.bird at sony.com
> <mailto:tim.bird at sony.com> > , but also copy the fuego mailing list:
> > cc: fuego at lists.linuxfoundation.org <mailto:fuego at lists.linuxfoundation.org> <mailto:fuego at lists.linuxfoundation.org
> <mailto:fuego at lists.linuxfoundation.org> >
> > - I have a separate e-mail account receiving e-mail from fuego at lists.linuxfoundation.org
> <mailto:fuego at lists.linuxfoundation.org>
> > <mailto:fuego at lists.linuxfoundation.org <mailto:fuego at lists.linuxfoundation.org> >
> > which I use to process patches to Fuego
> > - preferably, the commit would be in 'git send-email' format (or 'git format-patch' format)
> > - I prefer to receive commits inline, but if you send them as attachments I can deal with it
> > - it would be nice to get the commits as a series, with one commit per added file, but
> > you could send a commit with multiple files
> > - please send them as you work on them, instead of in big batches. Big batches are
> > hard to process, because I need to allocate a large block of time, instead of just fitting
> > in a quick review where I can in my work schedule
> > - you shouldn't need to send html, as it can be made from the sources in the fuego
> > docs directory with "make htmldocs"
> > - I've already populated the directory fuego/docs/images with images from the wiki,
> > so you don't need to send images (unless you create new ones, which is currently
> > out of scope for the project)
> >
> > This will help the review flow considerably.
> >
> > > Converted pages:
> > > Artwork
> > > Documentation
> > > FrontPage
> > > Architecture
> > > FAQ
> > > OSS_Test_Vision
> > > Fuego_Quickstart_Guide
> > > Raspberry_Pi_Fuego_Setup
> > > Quick_Setup_Guide
> > > Using_the_qemuarm_target
> > > Installing_Fuego
> > > Adding_a_board
> > > Adding_a_toolchain
> > > Adding_test_jobs_to_Jenkins
> > > Adding_views_to_Jenkins
> > > Adding_or_Customizing_a_Distribution
> > > Integration_with_ttc
> > > Test_variables
> > > Working_with_remote_boards
> > > Adding_a_new_test
> > > Fuego_naming_rules
> > > Using_Batch_Tests
> > > Parser_module_API
> > > Building_Documentation
> > > License_And_Contribution_Policy
> > >
> > >
> > >
> > > Thanks and regards,
> > > Pooja More
> > >
> > >
> > > This message contains confidential information and is intended only for the individual(s) named. If you are not the intended
> > recipient, you
> > > are notified that disclosing, copying, distributing or taking any action in reliance on the contents of this mail and attached
> file/s
> > is strictly
> > > prohibited. Please notify the sender immediately and delete this e-mail from your system. E-mail transmission cannot be
> > guaranteed to be
> > > secured or error-free as information could be intercepted, corrupted, lost, destroyed, arrive late or incomplete, or contain
> > viruses. The
> > > sender therefore does not accept liability for any errors or omissions in the contents of this message, which arise as a result
> of e-
> > mail
> > > transmission.
> >
> >
> >
> >
> > This message contains confidential information and is intended only for the individual(s) named. If you are not the intended
> recipient, you
> > are notified that disclosing, copying, distributing or taking any action in reliance on the contents of this mail and attached file/s
> is strictly
> > prohibited. Please notify the sender immediately and delete this e-mail from your system. E-mail transmission cannot be
> guaranteed to be
> > secured or error-free as information could be intercepted, corrupted, lost, destroyed, arrive late or incomplete, or contain
> viruses. The
> > sender therefore does not accept liability for any errors or omissions in the contents of this message, which arise as a result of e-
> mail
> > transmission.
>
>
>
>
> This message contains confidential information and is intended only for the individual(s) named. If you are not the intended recipient, you
> are notified that disclosing, copying, distributing or taking any action in reliance on the contents of this mail and attached file/s is strictly
> prohibited. Please notify the sender immediately and delete this e-mail from your system. E-mail transmission cannot be guaranteed to be
> secured or error-free as information could be intercepted, corrupted, lost, destroyed, arrive late or incomplete, or contain viruses. The
> sender therefore does not accept liability for any errors or omissions in the contents of this message, which arise as a result of e-mail
> transmission.
More information about the Fuego
mailing list