VOOZH about

URL: https://phabricator.services.mozilla.com/D304248

⇱ ⚙ D304248 Bug 2042688 - Convert perfdocs RST to Markdown and update generator r?#perftest-reviewers,firefox-source-docs-reviewers

Paths

Bug 2042688 - Convert perfdocs RST to Markdown and update generator r?#perftest-reviewers,firefox-source-docs-reviewers
Needs ReviewPublic

Authored by sylvestre on Tue, Jun 2, 9:10 PM.
Tags
None
Referenced Files
Unknown Object (File)
Tue, Jun 16, 2:36 AM
Unknown Object (File)
Mon, Jun 15, 11:54 PM
Unknown Object (File)
Mon, Jun 15, 5:35 PM
Unknown Object (File)
Mon, Jun 15, 8:23 AM
Unknown Object (File)
Mon, Jun 15, 3:26 AM
Unknown Object (File)
Sun, Jun 14, 6:52 PM
Unknown Object (File)
Sun, Jun 14, 5:44 PM
Unknown Object (File)
Sun, Jun 14, 5:44 PM
Subscribers

Details

Reviewers
None
Group Reviewers
perftest-reviewers
Restricted Project
dom-storage-reviewers
Bugzilla Bug ID
2042688
Summary

Updates the perfdocs generator (gatherer, generator, framework_gatherers,
doc_helpers, utils) to read source perfdocs in Markdown and emit Markdown
into testing/perfdocs/generated/. Converts all source index.md/metrics.md
files, the index template, and regenerates the testing/perfdocs/generated/
tree. RST-style link syntax in raptor/talos config.yml is converted to
Markdown.

Diff Detail

Repository
rFIREFOXAUTOLAND firefox-autoland
Branch
HEAD

Unit TestsFailed

TimeTest
28,520 mscode-review::mercurial
WARNING: The code review bot failed to apply your patch.
abort: No such file or directory: 'diff --git a/tools/moztreedocs/docs/adding-documentation.md b/tools/moztreedocs/docs/adding-documentation.md
'

Event Timeline

sylvestre created this revision.
phab-bot changed the visibility from "Custom Policy" to "Public (No Login Required)".Tue, Jun 2, 9:12 PM
phab-bot changed the edit policy from "Custom Policy" to "Restricted Project (Project)".
phab-bot removed a project: secure-revision.
Comment Actions

You've pushed a patch that is making changes in areas of Performance Testing.

Please ensure that all the documentation related to this change is updated. Additionally, please ensure that documentation is added for any new features, workarounds, or enhancements.

You can find the existing documentation for Performance Testing here: https://firefox-source-docs.mozilla.org/testing/perfdocs/

sylvestre updated this revision to Diff 1293623.
sylvestre updated this revision to Diff 1294920.
sylvestre retitled this revision from WIP: Bug 2042688 - Convert perfdocs RST to Markdown and update generator r?#perftest-reviewers,firefox-source-docs-reviewers to Bug 2042688 - Convert perfdocs RST to Markdown and update generator r?#perftest-reviewers,firefox-source-docs-reviewers.
Comment Actions

@sylvestre do you have a try run showing our unit tests passing as well as a successful doc upload task so we can check the docs? Reviewbot failed to run on this patch.

Large Diff

This large diff affects 114 files. Files without inline comments have been collapsed. Expand All Files

Revision Contents

PathSize
dom/
indexedDB/
test/
perfdocs/
75 lines
python/
mozperftest/
mozperftest/
perfdocs/
12 lines
95 lines
10 lines
16 lines
templates/
90 lines
2 lines
tests/
2 lines
4 lines
11 lines
30 lines
12 lines
perfdocs/
17 lines
running.rst
30 lines
301 lines
python/
mozperftest/
perfdocs/
testing/
perfdocs/
generated/
developing.rst
118 lines
tools.rst
12 lines
vision.rst
15 lines
testing/
awsy/
perfdocs/
136 lines
perfdocs/
generated/
5 lines
75 lines
596 lines
274 lines
383 lines
38 lines
136 lines
114 lines
446 lines
mozperftest.rst
69 lines
perf-sheriffing.rst
571 lines
220 lines
performance-infrastructure.rst
40 lines
296 lines
230 lines
44615 lines
running.rst
30 lines
95 lines
10243 lines
164 lines
64 lines
490 lines
301 lines
performance/
adding-tests/
perfdocs/
596 lines
mach-try-perf/
perfdocs/
446 lines
95 lines
perf-sheriffing/
perfdocs/
index.rst
571 lines
perfcompare/
perfdocs/
220 lines
performance-infrastructure/
perfdocs/
index.rst
40 lines
perftest-in-a-nutshell/
perfdocs/
296 lines
telemetry-alerting/
perfdocs/
164 lines
raptor/
raptor/
perfdocs/
383 lines
2 lines
38 lines
136 lines
index.rst
38 lines
79 lines
64 lines
490 lines
talos/
perfdocs/
466 lines
672 lines
testing/
perfdocs/
generated/
python/
mozperftest/
perfdocs/
developing.rst
118 lines
tools.rst
12 lines
vision.rst
15 lines
CommitTreeParentsAuthorSummaryDate
96262644997696f6eda3c60f8de4ff2ffda6Sylvestre Ledru
Bug 2042688 - Convert perfdocs RST to Markdown and update generator r?#perftest… (Show More…)
Sun, May 24, 8:44 PM

Diff 1294920

dom/indexedDB/test/perfdocs/index.md

dom/indexedDB/test/perfdocs/index.rst

python/mozperftest/mozperftest/perfdocs/doc_helpers.py

python/mozperftest/mozperftest/perfdocs/framework_gatherers.py

python/mozperftest/mozperftest/perfdocs/gatherer.py

python/mozperftest/mozperftest/perfdocs/generator.py

python/mozperftest/mozperftest/perfdocs/templates/index.md

python/mozperftest/mozperftest/perfdocs/templates/index.rst

python/mozperftest/mozperftest/perfdocs/utils.py

python/mozperftest/mozperftest/tests/conftest.py

python/mozperftest/mozperftest/tests/test_perfdocs.py

python/mozperftest/mozperftest/tests/test_perfdocs_framework_gatherers.py

python/mozperftest/mozperftest/tests/test_perfdocs_generation.py

python/mozperftest/mozperftest/tests/test_perfdocs_helpers.py

python/mozperftest/perfdocs/developing.md

python/mozperftest/perfdocs/developing.rst

python/mozperftest/perfdocs/index.md

python/mozperftest/perfdocs/index.rst

python/mozperftest/perfdocs/running.md

python/mozperftest/perfdocs/running.rst

python/mozperftest/perfdocs/tools.md

python/mozperftest/perfdocs/tools.rst

python/mozperftest/perfdocs/vision.md

python/mozperftest/perfdocs/vision.rst

python/mozperftest/perfdocs/writing.md

python/mozperftest/perfdocs/writing.rst

testing/awsy/perfdocs/index.md

testing/awsy/perfdocs/index.rst

testing/perfdocs/generated/DAMP.md

testing/perfdocs/generated/DAMP.rst

testing/perfdocs/generated/IndexedDB.md

testing/perfdocs/generated/IndexedDB.rst

testing/perfdocs/generated/adding-tests.md

testing/perfdocs/generated/adding-tests.rst

testing/perfdocs/generated/awsy.md

testing/perfdocs/generated/awsy.rst

testing/perfdocs/generated/browsertime.md

testing/perfdocs/generated/browsertime.rst

testing/perfdocs/generated/contributing.md

testing/perfdocs/generated/contributing.rst

testing/perfdocs/generated/debugging.md

testing/perfdocs/generated/debugging.rst

testing/perfdocs/generated/developing.md

testing/perfdocs/generated/developing.rst

testing/perfdocs/generated/index.md

testing/perfdocs/generated/index.rst

testing/perfdocs/generated/mach-try-perf.md

testing/perfdocs/generated/mach-try-perf.rst

testing/perfdocs/generated/mozperftest.md

testing/perfdocs/generated/mozperftest.rst

testing/perfdocs/generated/perf-sheriffing.md

testing/perfdocs/generated/perf-sheriffing.rst

testing/perfdocs/generated/perfcompare.md

testing/perfdocs/generated/perfcompare.rst

testing/perfdocs/generated/performance-infrastructure.md

testing/perfdocs/generated/performance-infrastructure.rst

testing/perfdocs/generated/perftest-in-a-nutshell.md

testing/perfdocs/generated/perftest-in-a-nutshell.rst

testing/perfdocs/generated/raptor-metrics.md

testing/perfdocs/generated/raptor-metrics.rst

testing/perfdocs/generated/raptor.md

testing/perfdocs/generated/raptor.rst

testing/perfdocs/generated/running.md

testing/perfdocs/generated/running.rst

testing/perfdocs/generated/standard-workflow.md

testing/perfdocs/generated/standard-workflow.rst

testing/perfdocs/generated/talos.md

testing/perfdocs/generated/talos.rst

testing/perfdocs/generated/telemetry-alerting.md

testing/perfdocs/generated/telemetry-alerting.rst

testing/perfdocs/generated/test-list.md

testing/perfdocs/generated/test-list.rst

testing/perfdocs/generated/tools.md

testing/perfdocs/generated/tools.rst

testing/perfdocs/generated/vision.md

testing/perfdocs/generated/vision.rst

testing/perfdocs/generated/webextension.md

testing/perfdocs/generated/webextension.rst

testing/perfdocs/generated/writing.md

testing/perfdocs/generated/writing.rst

testing/performance/adding-tests/perfdocs/index.md

testing/performance/adding-tests/perfdocs/index.rst

testing/performance/mach-try-perf/perfdocs/index.md

testing/performance/mach-try-perf/perfdocs/index.rst

testing/performance/mach-try-perf/perfdocs/standard-workflow.md

testing/performance/mach-try-perf/perfdocs/standard-workflow.rst

testing/performance/perf-sheriffing/perfdocs/index.md

testing/performance/perf-sheriffing/perfdocs/index.rst

testing/performance/perfcompare/perfdocs/index.md

testing/performance/perfcompare/perfdocs/index.rst

testing/performance/performance-infrastructure/perfdocs/index.md

testing/performance/performance-infrastructure/perfdocs/index.rst

testing/performance/perftest-in-a-nutshell/perfdocs/index.md

testing/performance/perftest-in-a-nutshell/perfdocs/index.rst

testing/performance/telemetry-alerting/perfdocs/index.md

testing/performance/telemetry-alerting/perfdocs/index.rst

testing/raptor/raptor/perfdocs/browsertime.md

testing/raptor/raptor/perfdocs/browsertime.rst

testing/raptor/raptor/perfdocs/config.yml

testing/raptor/raptor/perfdocs/contributing.md

testing/raptor/raptor/perfdocs/contributing.rst

testing/raptor/raptor/perfdocs/debugging.md

testing/raptor/raptor/perfdocs/debugging.rst

testing/raptor/raptor/perfdocs/index.md

testing/raptor/raptor/perfdocs/index.rst

testing/raptor/raptor/perfdocs/metrics.md

testing/raptor/raptor/perfdocs/metrics.rst

testing/raptor/raptor/perfdocs/test-list.md

testing/raptor/raptor/perfdocs/test-list.rst

testing/raptor/raptor/perfdocs/webextension.md

testing/raptor/raptor/perfdocs/webextension.rst

testing/talos/perfdocs/config.yml

testing/talos/perfdocs/index.md

testing/talos/perfdocs/index.rst