Marc Bonnici
c4535320fa
docs: Update plugin How To Guides
...
Fix the example instrument code and add additional note to indicate where
new plugins should be stored to be detected by WA's default configuration
to improve clarity.
2023-01-13 10:14:15 +00:00
setrofim
c023b9859c
doc: update coding guide with APK rebuild info
...
Update the Contributing/Code section with instruction to rebuild the UI
automation APK if the corresponding source has been update.
2021-09-28 09:07:49 +01:00
Marc Bonnici
31d306c23a
docs: Fix typo in variable name
2021-04-19 16:19:49 +01:00
Marc Bonnici
751bbb19fe
docs: Update Signal Dispatch diagram
...
Update the signal dispatch diagram to include the new optional reboot stage.
2020-12-09 07:48:20 +00:00
Marc Bonnici
b8301640f7
docs/dev_ref: Fix incorrect attribute name
2020-06-25 13:01:28 +01:00
Marc Bonnici
ecbfe32b9d
docs: Update python2 style print statements
2020-05-21 12:39:25 +01:00
Marc Bonnici
711bff6a60
docs/plugins: Fix formatting and typos
2020-04-27 13:53:29 +01:00
Marc Bonnici
2a8454db6a
docs/how_tos: Update example workload creation
...
Clarify the workload creation example.
2020-04-27 13:53:29 +01:00
Sergei Trofimov
b93a8cbbd6
doc: fix Instrument documentation
...
Remove reference to `extract_results`, which does not exist for
Instruments (this only exists for Workloads.)
2020-02-04 12:49:14 +00:00
Marc Bonnici
ee8bab365b
docs/revent: Clarify the naming conventions for revent recordings
...
As per https://github.com/ARM-software/workload-automation/issues/968
the current documentation for detailing the naming scheme for an revent
recording is unclear. Reword the descriptions focusing on the typical
usecase rather then based on a customized target class.
2019-04-26 08:05:51 +01:00
Marc Bonnici
ea5ea90bb6
docs/dev_info/processing_output: Fix formatting
2018-12-21 14:26:55 +00:00
Marc Bonnici
916f7cbb17
docs: Update documentation about database output API and create command
2018-12-07 09:55:17 +00:00
Waleed El-Geresy
6239f6ab2f
Update documentation
...
Update documentation with new API for Output Processors which includes
the context in the intialize and finalize methods.
2018-09-05 14:40:42 +01:00
Waleed El-Geresy
1c48589860
doc: Rename execution_model to framework_overview
...
An update to more aptly suit the new general title of the section.
2018-07-05 11:34:19 +01:00
Waleed El-Geresy
a3b02872ac
Docs: Run Output - Clarification and Additions
...
Clarification of the meanings of and the distinction between the
output-related terms iteration, job, workload and section for those
unfamiliar
- Add entries to the glossary and references to the glossary
- Added section on Configuration parameter hierarchy
- Added section on the number and names of directories generated for
jobs in the run output folder
2018-07-05 11:34:19 +01:00
Marc Bonnici
60989ef66c
doc/contributing: Add a guide to documentation styles
...
Add a documentation style guide to aid in keeping a consistent style
when adding new documentation.
2018-06-29 11:04:09 +01:00
Marc Bonnici
c67994260d
doc: Update heading underlines
...
Ensure consistency for title levels throughout documentation.
2018-06-29 11:04:09 +01:00
Sergei Trofimov
ef16d7a754
doc: add output processing how-to
...
Add a developer how-to illustrating the use of WA output processing API
by creating an ASCII reporter.
2018-06-28 12:10:19 +01:00
Marc Bonnici
116c260bae
doc: Reorganise Developer Guide/Reference
2018-06-26 16:25:05 +01:00
Marc Bonnici
e66ae050a9
doc/dev_how_tos: Remove 'Example' from headings and update tags
2018-06-26 16:25:05 +01:00
Marc Bonnici
ca17542d56
doc: Fix old references to results processors
2018-06-26 16:25:05 +01:00
Marc Bonnici
3c467dce95
doc: Fix missing import in Getter example
2018-06-26 16:25:05 +01:00
Marc Bonnici
3ed14e9864
doc: Fix instrument update_output method description
2018-06-26 16:25:05 +01:00
Marc Bonnici
af8bc42cc2
doc: Update resolver example to use context directly
2018-06-26 16:25:05 +01:00
Marc Bonnici
37d6433214
doc: Improve Adding a Workload how to
2018-06-26 16:25:05 +01:00
Marc Bonnici
23eb428829
doc: Add additional references and formatting
2018-06-26 16:25:05 +01:00
Marc Bonnici
2f94d12b57
doc: Restructure developer information
...
Re-organise and add additional information to developer guide.
2018-06-26 16:25:05 +01:00
Marc Bonnici
750e206b85
doc/dev_reference: Update to use correct API formatting
...
Update the interfaces for Workloads OutputProcessors and Instruments to be
formatted as an API correctly.
2018-06-26 16:25:05 +01:00
Marc Bonnici
9d160b1381
doc/execution_model: Remove unintentional heading
2018-06-26 16:25:05 +01:00
Marc Bonnici
d637557f5a
doc: Update links to have more useful display text
2018-06-26 16:25:05 +01:00
Marc Bonnici
716af1b966
doc: Make config listsing a consistent style
2018-06-26 16:25:05 +01:00
Marc Bonnici
6c93590062
doc: Restructure
...
Restructure the documentation to be split into `User Information` and
`Developer Information`, and split the how to guides into their
corresponding section.
2018-06-26 16:25:05 +01:00
