Open Bug 1773234 (necko-docs) Opened 3 years ago Updated 1 year ago

[meta] Necko documentation improvements in firefox-source-docs

Categories

(Core :: Networking, task, P3)

task

Tracking

()

ASSIGNED

People

(Reporter: manuel, Assigned: kershaw)

References

(Depends on 1 open bug)

Details

(Keywords: leave-open, meta, Whiteboard: [necko-triaged])

Attachments

(5 files)

A meta bug to use as reference for documentation changes, making the workflow easier by allowing to reference this bug instead of creating a bug per small change.

This is part of our ongoing effort to improve and structure Networking/Necko documentation.

It can be closed when we don't need it anymore (like 6-12 months without a patch/bug referencing this bug) or we find a different model allowing faster documentation improvements.

Severity: -- → N/A
Priority: -- → P3
Whiteboard: [necko-triaged]
Assignee: nobody → mbucher
Status: NEW → ASSIGNED
Pushed by mbucher@mozilla.com: https://hg.mozilla.org/integration/autoland/rev/2bafae4e6942 Network testing docs: fix code box formatting r=necko-reviewers,dragana DONTBUILD
Pushed by mbucher@mozilla.com: https://hg.mozilla.org/integration/autoland/rev/5b9dd1c1866f Link idl interfaces in new-to-necko doc r=eguloien,necko-reviewers,valentin DONTBUILD

Replaced link to Glean IPC, added Debugging section + minor changes

Pushed by acreskey@mozilla.com: https://hg.mozilla.org/integration/autoland/rev/0f5bbaa9c4a9 Add debugging section, minor improvements in new-to-necko doc r=edgul DONTBUILD
Alias: necko-docs
Assignee: manuel → nobody
Status: ASSIGNED → NEW
Depends on: 1791749

Some minor updates:

  • Remove cookie:5, since not all bugs need cookie information.
  • Add instruction about logging QUIC
Assignee: nobody → kershaw
Status: NEW → ASSIGNED
Pushed by kjang@mozilla.com: https://hg.mozilla.org/integration/autoland/rev/accd5f34fc1e Update the HTTP logging document, r=necko-reviewers,valentin DONTBUILD

Backed out for failures on logging.rst

[task 2022-10-13T12:53:17.027Z] 12:53:17.27 rst (52) | Command: /builds/worker/checkouts/gecko/obj-x86_64-pc-linux-gnu/_virtualenvs/lint/bin/python /builds/worker/checkouts/gecko/obj-x86_64-pc-linux-gnu/_virtualenvs/lint/bin/rstcheck --ignore-language=cpp,json --ignore-roles=searchfox /builds/worker/checkouts/gecko/python/mach/docs/usage.rst /builds/worker/checkouts/gecko/python/mach/docs/windows-usage-outside-mozillabuild.rst /builds/worker/checkouts/gecko/python/mozboot/README.rst /builds/worker/checkouts/gecko/python/mozperftest/README.rst /builds/worker/checkouts/gecko/python/mozperftest/perfdocs/developing.rst /builds/worker/checkouts/gecko/python/mozperftest/perfdocs/index.rst /builds/worker/checkouts/gecko/python/mozperftest/perfdocs/running.rst /builds/worker/checkouts/gecko/python/mozperftest/perfdocs/tools.rst /builds/worker/checkouts/gecko/python/mozperftest/perfdocs/vision.rst /builds/worker/checkouts/gecko/python/mozperftest/perfdocs/writing.rst
[task 2022-10-13T12:53:17.221Z] 12:53:17.220 rst (52) | Finished in 13.38 seconds
[task 2022-10-13T12:53:17.231Z] TEST-UNEXPECTED-ERROR | /builds/worker/checkouts/gecko/netwerk/docs/http/logging.rst:290 | Undefined substitution referenced: "mach try". (rst)
[taskcluster 2022-10-13 12:53:17.606Z] === Task Finished ===
[taskcluster 2022-10-13 12:53:18.093Z] Unsuccessful task run with exit code: 1 completed in 24.59 seconds

Flags: needinfo?(kershaw)
Flags: needinfo?(kershaw)
Pushed by kjang@mozilla.com: https://hg.mozilla.org/integration/autoland/rev/36d3dfe6f3d4 Update the HTTP logging document, r=necko-reviewers,valentin DONTBUILD
Pushed by eguloien@mozilla.com: https://hg.mozilla.org/integration/autoland/rev/ca6dd193b2a2 Added security and networking component drawing to FSD. Also updated the necko page. r=necko-reviewers,djackson,kershaw,manuel
See Also: → 1845275

Information from here could also be integrated into ffsd: Found another document that could get integrated into ffsd or similar: https://github.com/mozilla-necko/meeting-notes/blob/9cfbc727ce66c3bdea4fc4ae060ca6c0a75a9744/archive/necko-intro-2022-02-28.md (might open a bug later)

You need to log in before you can comment on or make changes to this bug.

Attachment

General

Created:
Updated:
Size: