Skip to content

Commit

Permalink
Fix most of the documentation build warnings
Browse files Browse the repository at this point in the history
  • Loading branch information
davehunt committed Mar 17, 2017
1 parent 271eb6f commit 6d69e5c
Show file tree
Hide file tree
Showing 4 changed files with 16 additions and 17 deletions.
2 changes: 0 additions & 2 deletions guide/accounts.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,6 @@ for guides on the basics of using Git and GitHub.

.. seealso::

:doc:`/reference/Automation/`

`Mozilla Services on GitHub <https://github.com/mozilla-services/>`_
Mozilla Services' organization account on GitHub.
`Mozilla on GitHub <https://github.com/mozilla/>`_
Expand Down
4 changes: 2 additions & 2 deletions guide/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Let's get started!
test_automation_process
accounts
software

New Employee Guide
==================

Expand All @@ -33,5 +33,5 @@ Welcome to the New Employee Guide - hopefully you've already gone through, or ar
.. toctree::
:maxdepth: 2

/reference/Testing/continuous_integration
/reference/ci
fx-test-secrets
25 changes: 13 additions & 12 deletions guide/test_automation_process.rst
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
Test Automation Process
===================
=======================

While the details vary, there is a general framework for working on Firefox
Test Engineering test automation projects. This document attempts to describe that process.

Finding a Bug or GitHub Issue
---------------------------
-----------------------------

The first step is finding a good bug or GitHub Issue to work on.
The first step is finding a good bug or GitHub Issue to work on.

- GitHub Issues are written when new tests need to be written, or changes need to be made to fix existing flaky or failing tests. They include a description of the steps and expected results. You can find a comprehensive list of open GitHub Issues for our team on the `Firefox Test Engineering Dashboard`_.

- Unclaimed Issues are open and available for anyone to work on. You will know if it is unclaimed by reading the comments and checking if it is already assigned to someone. Make sure to comment on the Issue when you find one that you plan to complete.
- Unclaimed Issues are open and available for anyone to work on. You will know if it is unclaimed by reading the comments and checking if it is already assigned to someone. Make sure to comment on the Issue when you find one that you plan to complete.

- Bugs are written when specific features, tests or fixes are to be implemented. Bugs that are marked as 'mentored' are a good place to start as you will have support while learning the project.

Expand All @@ -24,8 +24,8 @@ The first step is finding a good bug or GitHub Issue to work on.
.. _Bugs Ahoy: https://www.joshmatthews.net/bugsahoy/

Working on the Bug/Issue
-----------------------
After claiming a Bug/Issue, you will submit your pull request with your work in a GitHub feature branch.
------------------------
After claiming a Bug/Issue, you will submit your pull request with your work in a GitHub feature branch.

Any mentors or project owners assigned to it will review your work and give constructive feedback and instructions for any changes that need to be made. After the pull request is completed to satisfaction it will be merged into the project code.

Expand Down Expand Up @@ -53,10 +53,10 @@ For projects using Git and GitHub, the process can be explained in more detail:

.. seealso::

:doc:`/reference/Automation/Python Styleguide`
:doc:`/reference/python-style`
A useful styleguide for Python best practices.

:doc:`/reference/Automation/Git and GitHub`
:doc:`/reference/git_github`
A short list of tips and tricks for using GitHub.

`GitHub Flow <https://guides.github.com/introduction/flow/>`_
Expand All @@ -76,7 +76,7 @@ Mobile
Mobile platforms such as iOS and Android are also an important part of our testing process. Testing is done on mobile platforms, and there are also mobile-specific tests.

iOS
^^^^^^^^^^^^^^
^^^
Currently we use Apple's XCUITest framework in Swift. The test can be written and executed on
Apple's XCode App, and you can see some of our `examples in the Firefox for iOS`_ repository. Some of the older
Tests are in `KIFTest framework`_, but since they use undocumented Apple APIs, and XCUITest framework has been
Expand All @@ -95,10 +95,11 @@ You can learn more about basics of Swift and XCUITest from below websites:
.. _Apple Developer Site: https://developer.apple.com/library/content/documentation/DeveloperTools/Conceptual/testing_with_xcode/chapters/09-ui_testing.html#//apple_ref/doc/uid/TP40014132-CH13-SW1
.. _Swift Language Reference: https://developer.apple.com/library/content/documentation/Swift/Conceptual/Swift_Programming_Language/AboutTheLanguageReference.html
.. _UI Testing Cheat Sheet and Examples: http://masilotti.com/ui-testing-cheat-sheet/

Android
^^^^^^^^^^^^^^
A few of our Android mobile test-automation projects (particularly those written with Selenium WebDriver) use
`Appium <http://appium.io/>`_. For Firefox for Android testing automation that does not involve the testing
^^^^^^^
A few of our Android mobile test-automation projects (particularly those written with Selenium WebDriver) use
`Appium <http://appium.io/>`_. For Firefox for Android testing automation that does not involve the testing
of GeckoView, there is a `proof-of-concept test environment`_ using Appium.

.. _proof-of-concept test environment: https://github.com/npark-mozilla/CG_Mobile_Test
Expand Down
2 changes: 1 addition & 1 deletion reference/git_github.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Issues
------
You can find an issue to work on by going to the
`Firefox Test Engineering Dashboard`_. Any unclaimed Issue is available to you
to work on. You can find out more about our process in the :doc:`guide/index`.
to work on. You can find out more about our process in the :doc:`../guide/index`.

.. _Firefox Test Engineering Dashboard: https://mozilla.github.io/fxtest-dashboard/#/issues

Expand Down

0 comments on commit 6d69e5c

Please sign in to comment.