Kolibri: migrate testing info to docs

Created on 6 Oct 2017  路  4Comments  路  Source: learningequality/kolibri

note from @radinamatic https://github.com/learningequality/kolibri/pull/2353#discussion_r142910435

Migrate info in google doc to the 'manual testing and qa' page

developer docs

Most helpful comment

Hi @Lewiscowles1986 this is not yet complete. If you'd like to tackle it, I'd recommend also doing https://github.com/learningequality/kolibri/issues/5945 at the same time.

Here are some helpful high-level links:

Here's what I would recommend:

  1. Make a new directory, _docs/manual_testing/_ and an index file _docs/manual_testing/index.rst_, similar to how _docs/contributing/_ is currently set up
  2. Move _docs/manual_testing.rst_ to _docs/manual_testing/overview.rst_ and link to it from _docs/manual_testing/index.rst_
  3. Create a new file _docs/manual_testing/a11y_resources.rst_ and migrate the Accessibility resources to it. Link to it from _docs/manual_testing/index.rst_
  4. Create a new file _docs/manual_testing/virtual_machines.rst_ and migrate the Testing with VMs to it. Link to it from _docs/manual_testing/index.rst_

thanks!

All 4 comments

is this complete, or not? It looks like the PR merged, then #2427 happened doesn't seem to track next steps.

Hi @Lewiscowles1986 this is not yet complete. If you'd like to tackle it, I'd recommend also doing https://github.com/learningequality/kolibri/issues/5945 at the same time.

Here are some helpful high-level links:

Here's what I would recommend:

  1. Make a new directory, _docs/manual_testing/_ and an index file _docs/manual_testing/index.rst_, similar to how _docs/contributing/_ is currently set up
  2. Move _docs/manual_testing.rst_ to _docs/manual_testing/overview.rst_ and link to it from _docs/manual_testing/index.rst_
  3. Create a new file _docs/manual_testing/a11y_resources.rst_ and migrate the Accessibility resources to it. Link to it from _docs/manual_testing/index.rst_
  4. Create a new file _docs/manual_testing/virtual_machines.rst_ and migrate the Testing with VMs to it. Link to it from _docs/manual_testing/index.rst_

thanks!

Questions:

  1. RE: #5945 is it just the accessibility? The rest looks like scrap paper that isn't part of docs as much as "something else".
  2. I sort of went a slight different way regarding structure to try to make docs as small (parts) as possible). Happy to revise on PR if needed

RE: #5945 is it just the accessibility?

Yes, for the purpose of this PR it will just be the a11y page. Once that has a new home I can take care of the rest of the wiki cleanup

I sort of went a slight different way regarding structure to try to make docs as small (parts) as possible). Happy to revise on PR if needed

Will review next week - thanks

Was this page helpful?
0 / 5 - 0 ratings